機能説明
このインターフェースは、テナントレベルのパラメータをクエリするために使用されます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/parameters
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID（追跡用） | dc302d76-66b5-48d8-ab53-a035******** |
戻り結果
名称 |
型 |
説明 |
示例値 |
|---|---|---|---|
| name | string | パラメータ名 | connect_timeout |
| currentValue | string | 現在のパラメータ値 | 10 |
| needReboot | boolean | 再起動が必要かどうか | false |
| defaultValue | string | デフォルトのパラメータ値 | 10 |
| valueType | string | パラメータ値の型 | RANGE |
| acceptableValue | Array |
パラメータの有効な範囲 | ["2", "31536000"] |
| rejectedValue | Array |
パラメータの不正な値の範囲 | [] |
| description | string | パラメータの説明 | 接続タイムアウト時間。単位は秒 |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/parameters?requestId={requestId}'
レスポンス例
JSON形式
{
"data": [
{
"name": "connect_timeout",
"currentValue": "10",
"needReboot": false,
"defaultValue": "10",
"valueType": "RANGE",
"acceptableValue": [
"2",
"31536000"
],
"rejectedValue": [],
"description": "接続タイムアウト時間。単位は秒"
}
],
"server": "xxx.xxx.x.xxx:xxxx"
}