機能の概要
このAPIは、指定されたテナントのネットワーク接続アドレスリストを照会するために使用され、プライベートアドレスとパブリックアドレスの詳細情報が含まれます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /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******** |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | ob2mr3oae0**** |
| tenantEndpointId | String | テナントエンドポイントID | obe-6zfga5hc**** |
| addressId | String | アドレスID | rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-**** |
| addressStatus | String | アドレス状態 | ONLINE |
| connectionZones | List |
接続ゾーン | ["cn-southwest-2a"] |
| serviceType | String | サービスタイプ | OBPROXY_INTRANET、OBPROXY_INTERNET、OBPROXY_READONLY、OBPROXY_READWRITE |
| addressType | String | アドレスタイプ | MASTER、READONLY、READWRITEなど |
| networkType | String | ネットワークタイプ | internet、intranet |
| role | String | 接続タイプ、読み書き、読み取り専用 | READWRITE、READONLY。場合によっては、プライマリアドレスで読み書きタイプを区別する必要があり、スタンバイデータベースのプライマリアドレスは読み取り専用となります。 |
| userNameFormat | String | ユーザー名形式 | USER |
| useSSL | Boolean | SSLを有効にするかどうか | true |
| proxyClusterId | String | プロキシクラスタID | pxy-cluster-12345**** |
| proxyClusterInfo | String | プロキシクラスタ情報 | プロキシクラスタの詳細設定情報 |
| internetAddress | String | パブリックアドレス | **... |
| internetPort | Integer | パブリックポート | 3306 |
| internetDomain | String | パブリックドメイン名 | t6zffysc2****.huawei-cn-southwest-2-internet.oceanbase.cloud |
| internetAddressStatus | String | パブリックアドレスの状態 | ONLINE、OFFLINE、PENDING |
| internetMaxConnectionNum | Integer | パブリックアドレスの最大接続数 | 5000 |
| internetMaxConnectionNumLimit | Integer | パブリックアドレスの最大接続数の上限 | 5000 |
| internetRpcPort | Integer | パブリックRPCポート | 2881 |
| internetProxyClusterId | String | パブリックプロキシクラスタID | pxy-internet-12345**** |
| vpcId | String | VPC ID | vpc-bp12********** |
| userVpcOwnerId | String | VPC Owner ID | 123**********3456 |
| vSwitchId | String | vswitch ID | vsw-bp123******* |
| intranetDomain | String | プライベートドメイン名 | t6zffysc2****.huawei-cn-southwest-2-intranet.oceanbase.cloud |
| intranetAddress | String | プライベートアドレス | ...* |
| intranetAddressStatus | String | プライベートアドレスの状態 | ONLINE、OFFLINE、PENDING |
| intranetPort | Integer | プライベートポート | 3306 |
| maxConnectionNum | Integer | プライベートアドレスの最大接続数 | 10000 |
| maxConnectionNumLimit | Integer | プライベートアドレスの最大接続数の変更上限 | 10000 |
| intranetRpcPort | Integer | プライベートアドレスのRPCポート | 2881 |
| privateLinkList | List | private linkリスト情報 | プライベートリンクサービスの設定リスト |
| enableRPc | Boolean | プライマリアドレスでRPCを有効にするかどうか、ダイレクトロード時にプライマリアドレスタイプで返されます。 | true |
| odpVersion | String | ODPバージョン、読み書き/読み取り専用アドレスで返されます | 4.2.1 |
| readStrategyConfigResponse | Object | トラフィック戦略の設定情報、読み書き/読み取り専用アドレスでトラフィック戦略の設定が返されます。 | 読み書き分離、ロードバランシングなどの戦略設定が含まれます。 |
例
リクエスト例
curl --digest \
-u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?requestId={requestId}&addressId={addressId}' \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
パブリックアドレスのクエリ
{ "data": [ { "addressId": "rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2****-****", "addressStatus": "ONLINE", "addressType": "MASTER", "connectionZones": [ "cn-southwest-2a" ], "enableRPc": true, "internetAddressStatus": "ONLINE", "internetDomain": "t6zffysc2****.huawei-cn-southwest-2-internet.oceanbase.cloud", "internetMaxConnectionNum": 5000, "internetMaxConnectionNumLimit": 5000, "internetPort": 3306, "networkType": "INTERNET", "proxyClusterId": "proxy-6zfgafjc****", "proxyClusterInfo": { "createTime": "2025-08-11T08:31:24Z", "deployMode": "1-1", "proxyClusterId": "proxy-6zfgafjc****", "proxyMode": "k8s_shared", "proxyServiceVersion": "2.0", "proxyVersion": "4.3.1.5-62025052214", "status": "ONLINE", "unitNum": 1, "unitSpec": "2C4G", "zone": "cn-southwest-2a,cn-southwest-2d" }, "role": "READWRITE", "serviceType": "OBPROXY_INTERNET", "tenantEndpointId": "obe-6zfga5hc****", "tenantId": "t6zffysc2****", "useSSL": true, "userNameFormat": "USER" } ], "requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000", "success": true }プライベートネットワークのPrivateLinkアドレスのクエリ
{ "data": [ { "addressId": "rs-private-intranet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTRANET-t6zffysc2****-****", "addressStatus": "PENDING_CREATE", "addressType": "MASTER", "connectionZones": [ "cn-southwest-2a" ], "enableRPc": true, "intranetAddressStatus": "ONLINE", "intranetPort": 3306, "maxConnectionNum": 5000, "maxConnectionNumLimit": 5000, "networkType": "INTRANET", "privateLinkList": [ { "deletePrivateLink": true, "privateLinkServiceId": "cn-southwest-2.pl_t6zffysc2****.30043e04-ff7a-4aad-9a74-8ddd4771****", "privateLinkStatus": "SERVICE_CREATED", "privateLinkUserAccount": "f151faba4a2a4fb3b4ecdf4128b****" } ], "proxyClusterId": "proxy-6zfgafj****", "proxyClusterInfo": { "createTime": "2025-08-11T08:31:24Z", "deployMode": "1-1", "proxyClusterId": "proxy-6zfgafjc****", "proxyMode": "k8s_shared", "proxyServiceVersion": "2.0", "proxyVersion": "4.3.1.5-62025052214", "status": "ONLINE", "unitNum": 2, "unitSpec": "2C4G", "zone": "cn-southwest-2a,cn-southwest-2d" }, "role": "READWRITE", "serviceType": "OBPROXY_INTRANET", "tenantEndpointId": "obe-6zfga5hc****", "tenantId": "t6zffysc2****", "useSSL": true, "userNameFormat": "USER" } ], "requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000", "success": true }