機能の概要
このAPIは、指定されたクラスタ内のテナントアドレス情報を照会するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/address/info
リクエストパラメータ
Path
名前 |
タイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OB Cloud クラウドデータベースインスタンスID。 | ob317v4uif**** |
Query
名前 |
タイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| pageNumber | Integer | いいえ | ページネーションクエリのページ番号。
|
1 |
| pageSize | Integer | いいえ | ページネーションクエリで設定する1ページあたりの行数。
|
10 |
| tenantIds | List | いいえ | テナントIDのリスト。複数のテナントIDはカンマで区切る。 | txxx,txxx1 |
戻り値
項目 |
型 |
説明 |
例 |
|---|---|---|---|
| data | object | テナントのアドレス情報。dataListプロパティフィールドを含みます。 | |
| dataList | object[] | テナントのアドレス情報リスト。 | |
| tenantId | String | テナントID。 | txxx |
| tenantName | String | テナント名。 | ハイブリッド |
| managementMode | String | 管理モード。
|
DBaaS |
| gmtCreate | String | テナント作成日時。 | 2025-06-02 22:12:10.0 |
| tenantMode | String | テナントモード。
|
MySQL |
| primaryZone | String | テナントのプライマリゾーン。 | ap-beijing-5 |
| status | String | テナントの状態。
|
ONLINE |
| cpu | Integer | テナントの総CPUコア数、単位：Core。 | 1 |
| mem | Integer | テナントの総メモリサイズ、単位：GiB。 | 4 |
| unitCpu | Integer | テナントの各UnitあたりのCPUコア数、単位：Core。 | 1 |
| unitMem | Integer | テナントの各Unitあたりのメモリサイズ、単位：GiB。 | 4 |
| unitNum | Integer | テナントのunit数。 | 1 |
| unitDiskSize | Integer | テナントの各Unitのディスクサイズ、単位：GiB。 | 0 |
| vpcId | String | 専用ネットワーク(VPC) ID。 | vpc-dgbjsyp2 |
| deployType | String | デプロイタイプ。 | single |
| description | String | テナントの説明情報。 | |
| tenantConnections | Array | テナント接続情報リスト。 | |
| tenantZones | Array | テナントのゾーン情報。 | |
| tenantResource | Object | テナントのリソース情報。 | |
| enableBinlogService | Boolean | binlogサービスを有効にするかどうか。 | false |
| readonlyConnectionAddable | String | 読み取り専用アドレスの作成可否。
|
ADDABLE |
| readwriteConnectionAddable | String | 読み書き分離アドレスの作成可否。
|
ADDABLE |
| timeZone | String | テナント設定のタイムゾーン。 | +08:00 |
| charset | String | テナント設定の文字セット。 | utf8mb4 |
| collation | String | テナント設定の照合順序。 | utf8mb4_general_ci |
| lowerCaseTableNamesParam | Integer | テナント設定のテーブル名の大文字小文字区別。 | 0 |
| parameterTemplate | String | パラメータテンプレート。 | |
| tagList | Array | テナントのタグリスト。 | |
| tenantCompatibilityMode | String | テナント互換モード。
|
MySQL |
| dataMergeTime | String | テナントのメジャーコンパクション時間。 | 18:00Z |
| enableProxyPublicLink | Boolean | 公衆IPを有効にするかどうか。 | true |
| odpDefaultVersion | String | テナント作成時のデフォルトodpVersionの設定。 | |
| globalAddressAddable | String | グローバルアドレスの作成可否。 | ADDABLE |
| enableStandbyReadWriteSplit | String | プライマリ/スタンバイデータベースの読み書き分離スイッチの状態。 | INVISIBLE |
| tenantMaxConnections | Integer | テナントが許可する最大接続数。 | 1600 |
| ragClusterDo | Object | RAG情報。 | |
| enableRag | Boolean | RAGを有効にするかどうか。 | false |
| hasMore | Boolean | 他にデータはありますか。 | false |
| total | Integer | 総レコード数。 | 1 |
| success | boolean | リクエストが成功したかどうか。 | true/false |
| requestId | String | リクエストID。 | c55eb7e5-800b-4c77-8895-f24a4dfe8a5e |
tenantConnectionsオブジェクトの説明
プロパティ |
タイプ |
説明 |
例 |
|---|---|---|---|
| addressId | String | アドレスID。 | rs-private-internet-vpc-xxx |
| addressMasterZoneId | String | アドレスのリーダーアベイラビリティゾーンID。 | ap-beijing-5 |
| addressStatus | String | アドレスの状態。 | ONLINE |
| addressType | String | アドレスタイプ。
|
MASTER |
| connectionZones | Array | 接続可能なアベイラビリティゾーンのリスト。 | ["ap-beijing-5"] |
| enableRPc | Boolean | RPCを有効にするかどうか。 | false |
| enableRagHttp | Boolean | RAG HTTPを有効にするかどうか。 | false |
| internetAddressStatus | String | パブリックアドレスの状態。 | ONLINE |
| internetDomain | String | パブリックドメイン名。 | txxx.qcloud-ap-beijing-internet.oceanbase.cloud |
| internetMaxConnectionNum | Integer | パブリックネットワークの最大接続数。 | 5000 |
| internetMaxConnectionNumLimit | Integer | パブリックネットワークの最大接続数の制限。 | 5000 |
| internetPort | Integer | パブリックポート。 | 3306 |
| intranetAddressStatus | String | プライベートネットワークアドレスの状態。 | ONLINE |
| intranetPort | Integer | プライベートネットワークポート。 | 3306 |
| isMigrated | Integer | 移行済みかどうか。 | 0 |
| isVirtualServerGroup | Boolean | 仮想サーバーグループかどうか。 | true |
| networkType | String | ネットワークタイプ。
|
INTERNET |
| maxConnectionNum | Integer | 最大接続数。 | 5000 |
| maxConnectionNumLimit | Integer | 最大接続数の制限。 | 5000 |
| privateLinkList | Array | PrivateLinkのリスト。 | |
| proxyClusterId | String | プロキシクラスタID。 | proxy-xxx |
| proxyClusterInfo | Object | プロキシクラスタ情報。 | |
| role | String | ロール。
|
READWRITE |
| serviceType | String | サービスタイプ。
|
OBPROXY_INTERNET |
| tenantEndpointId | String | テナントエンドポイントID。 | obe-xxx |
| useSSL | Boolean | SSLを使用するかどうか。 | true |
| userNameFormat | String | ユーザー名の形式。
|
USER_AND_TENANT |
proxyClusterInfoオブジェクトの説明
プロパティ |
タイプ |
説明 |
例 |
|---|---|---|---|
| createTime | String | 作成時間。 | 2025-06-10T10:05:11Z |
| proxyClusterId | String | プロキシクラスタID。 | proxy-xxx |
| proxyMode | String | プロキシモード。 | k8s_shared |
| proxyServiceVersion | String | プロキシサービスのバージョン。 | 2.0 |
| proxyVersion | String | プロキシのバージョン。 | 4.3.1.5-62025052214 |
| status | String | ステータス。 | ONLINE |
| unitNum | Integer | ユニット数。 | 1 |
| unitSpec | String | ユニット仕様。 | 2C4G |
| zone | String | アベイラビリティゾーン。 | ap-beijing-5,ap-beijing-7 |
tenantResourceオブジェクトの説明
プロパティ |
タイプ |
説明 |
例 |
|---|---|---|---|
| cpu | Object | CPUリソース情報。 | |
| totalCpu | Float | 総CPU、単位：コア数。 | 1.0 |
| unitCpu | Float | ユニットCPU、単位：コア数。 | 1.0 |
| disk | Object | ディスクリソース情報。 | |
| totalDiskSize | Float | 総ディスクサイズ、単位：GiB。 | 0.0 |
| usedDiskSize | Float | 使用済みディスクサイズ、単位：GiB。 | 2.35 |
| usedUnitDiskSize | Float | 使用済みユニットディスクサイズ、単位：GiB。 | 0.0 |
| memory | Object | メモリリソース情報。 | |
| totalMemory | Float | 総メモリ、単位：GiB。 | 4.0 |
| unitMemory | Float | ユニットメモリ、単位：GiB。 | 4.0 |
| unitNum | Integer | ユニット数。 | 1 |
privateLinkListオブジェクトの説明
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| deletePrivateLink | Boolean | PrivateLinkを削除するかどうか。 | true |
| intranetAddress | String | 内部ネットワークのアドレス。 | xxx.xx.x.xxx |
| privateLinkEndpointId | String | PrivateLinkエンドポイントID。 | vpce-0doacptl |
| privateLinkEndpointVpcId | String | PrivateLinkエンドポイントVPC ID。 | vpc-xxx |
| privateLinkServiceAccount | String | PrivateLinkサービスアカウント。 | 100031039273 |
| privateLinkServiceId | String | PrivateLinkサービスID。 | vpcsvc-6dnrs1xk |
| privateLinkStatus | String | PrivateLinkの状態。
|
CONNECTED |
| privateLinkUserAccount | String | PrivateLinkユーザーアカウント。 | 1000******** |
例
リクエスト例
curl --digest -u 'ak:sk' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/address/info
-H 'X-Ob-Project-Id: <プロジェクトID>'
-G -d 'pageNumber=1' -d 'pageSize=10' -d 'tenantIds=txxx'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。クラスタのプロジェクトIDについては、プロジェクト管理をご参照ください。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値の例
JSON形式
{
"data":{
"dataList":[
{
"cpu":1,
"createTime":"2025-06-02T14:12:10Z",
"diskSize":0,
"enableProxyPublicLink":true,
"enableRag":false,
"enableStandbyReadWriteSplit":"INVISIBLE",
"gmtCreate":"2025-06-02 22:12:10.0",
"mem":4,
"ocpTenantId":6003824,
"primaryZone":"ap-beijing-5",
"status":"ONLINE",
"tenantCompatibilityMode":"MySQL",
"tenantConnections":[
{
"addressId":"rs-private-internet-vpc-xxx",
"addressMasterZoneId":"ap-beijing-5",
"addressStatus":"ONLINE",
"addressType":"MASTER",
"connectionZones":[
"ap-beijing-5"
],
"enableRPc":false,
"enableRagHttp":false,
"internetAddressStatus":"ONLINE",
"internetDomain":"txxx.qcloud-ap-beijing-internet.oceanbase.cloud",
"internetMaxConnectionNum":5000,
"internetMaxConnectionNumLimit":5000,
"internetPort":3306,
"isMigrated":0,
"isVirtualServerGroup":true,
"networkType":"INTERNET",
"proxyClusterInfo":{
},
"role":"READWRITE",
"serviceType":"OBPROXY_INTERNET",
"tenantEndpointId":"obe-xxx",
"tenantId":"txxx",
"useSSL":true,
"userNameFormat":"USER_AND_TENANT"
},
{
"addressId":"rs-private-intranet-vpc-xxx",
"addressMasterZoneId":"ap-beijing-5",
"addressStatus":"ONLINE",
"addressType":"MASTER",
"connectionZones":[
"ap-beijing-5"
],
"enableRPc":false,
"enableRagHttp":false,
"intranetAddressStatus":"ONLINE",
"intranetPort":3306,
"isMigrated":0,
"isVirtualServerGroup":true,
"maxConnectionNum":5000,
"maxConnectionNumLimit":5000,
"networkType":"INTRANET",
"privateLinkList":[
{
"deletePrivateLink":true,
"intranetAddress":"xxx.xx.x.xxx",
"privateLinkEndpointId":"vpce-0doacptl",
"privateLinkEndpointVpcId":"vpc-xxx",
"privateLinkServiceAccount":"100031039273",
"privateLinkServiceId":"vpcsvc-6dnrs1xk",
"privateLinkStatus":"CONNECTED",
"privateLinkUserAccount":"1000********"
}
],
"proxyClusterInfo":{
},
"role":"READWRITE",
"serviceType":"OBPROXY_INTRANET",
"tenantEndpointId":"obe-xxx",
"tenantId":"txxx",
"useSSL":true,
"userNameFormat":"USER_AND_TENANT"
},
{
"addressId":"rs-private-intranet-vpc-xxx",
"addressMasterZoneId":"ap-beijing-7",
"addressStatus":"ONLINE",
"addressType":"READONLY",
"connectionZones":[
"ap-beijing-7"
],
"intranetAddressStatus":"ONLINE",
"intranetPort":3306,
"isMigrated":0,
"isVirtualServerGroup":true,
"maxConnectionNum":5000,
"maxConnectionNumLimit":5000,
"networkType":"INTRANET",
"privateLinkList":[
{
"intranetAddress":"xxx.xx.x.xxx",
"privateLinkEndpointId":"vpce-8wytu8tt",
"privateLinkEndpointVpcId":"vpc-xxx",
"privateLinkServiceAccount":"100031039273",
"privateLinkServiceId":"vpcsvc-59hhy542",
"privateLinkStatus":"CONNECTED",
"privateLinkUserAccount":"1000********"
}
],
"proxyClusterId":"proxy-xxx",
"proxyClusterInfo":{
"createTime":"2025-06-10T10:05:11Z",
"proxyClusterId":"proxy-xxx",
"proxyMode":"k8s_shared",
"proxyServiceVersion":"2.0",
"proxyVersion":"4.3.1.5-62025052214",
"status":"ONLINE",
"unitNum":1,
"unitSpec":"2C4G",
"zone":"ap-beijing-5,ap-beijing-7"
},
"role":"READONLY",
"serviceType":"OBPROXY_READONLY",
"tenantEndpointId":"obe-6tagdx6vroxs",
"tenantId":"txxx",
"useSSL":true,
"userNameFormat":"USER"
},
{
"addressId":"rs-private-intranet-vpc-xxx",
"addressMasterZoneId":"ap-beijing-5",
"addressStatus":"PENDING_CREATE",
"addressType":"READWRITE",
"connectionZones":[
"ap-beijing-5"
],
"intranetAddressStatus":"PENDING_CREATE",
"intranetPort":3306,
"isMigrated":0,
"networkType":"INTRANET",
"privateLinkList":[
{
"privateLinkStatus":"SERVICE_CREATING",
"privateLinkUserAccount":"1000********"
}
],
"role":"READWRITE",
"serviceType":"OBPROXY_READWRITE",
"tenantEndpointId":"",
"tenantId":"txxx",
"useSSL":true,
"userNameFormat":"USER_AND_TENANT"
}
],
"tenantId":"txxx",
"tenantMaxConnections":1600,
"tenantMode":"MySQL",
"tenantName":"Hybrid",
"tenantResource":{
"cpu":{
"totalCpu":1.0,
"unitCpu":1.0
},
"disk":{
"totalDiskSize":0.0,
"usedDiskSize":2.35,
"usedUnitDiskSize":0.0
},
"memory":{
"totalMemory":4.0,
"unitMemory":4.0
},
"unitNum":1
},
"unitCpu":1,
"unitDiskSize":0,
"unitMem":4,
"unitNum":1
}
],
"hasMore":false,
"total":1
},
"requestId":"c55eb7e5-800b-4c77-8895-f24a4dfe8a5e",
"success":true
}