機能の概要
このAPIは、テナントのアドレスを削除するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/tenants/{tenantId}/address
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| addressId | String | はい | アドレスID | rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-**** |
| requestId | String | はい | リクエストID | 6e87d618-854e-4ca1-ae1f-babc******** |
戻り値
名称 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | 成功かどうか | true/false |
| errorCode | string | エラーコード | "E001" |
| errorMessage | string | エラーメッセージ | "操作成功" |
| data | boolean | 業務データ | {...} |
| data.addressId | string | vip service group name | "12345" |
| cost | integer[int64] | 時間（ミリ秒） | 150 |
| server | string | サーバーアドレス | "xx.xxx.xx.xxx" |
| requestId | string | リクエストID | "req_20250811_001" |
| totalCount | integer[int64] | 合計数 | 100 |
| extra | object | 追加情報 | {"key1": "value1"} |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request DELETE \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?addressId={addressId}&requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": true,
"cost": 150,
"server": "xxx.xxx.x.xxx:xxxx",
"requestId": "6e87d618-854e-4ca1-ae1f-babc********",
"totalCount": null,
"extra": null
}