DescribeTenantAddressInfo - すべてのテナントアドレス情報を照会する|OceanBase Cloud|ドキュメント|分散データベース

DescribeTenantAddressInfo - すべてのテナントアドレス情報を照会する

最終更新日：2026-07-31 06:58:55 更新

機能説明

このインターフェースは、指定されたOceanBaseクラスタ内のすべてのテナントのプロキシアドレス情報を照会するために使用されます。これには、プライベートネットワークアドレス、ポート、接続情報、プロキシクラスタの状態などの詳細情報が含まれます。

呼び出し説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを持っている必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。

リクエストパス

GET /api/v2/instances/{instanceId}/address/info

リクエストパラメータ

Path

パラメータ名	型	必須	説明	サンプル値
instanceId	String	はい	OceanBaseクラスタID	obcluster-*****

Query

パラメータ名	型	必須	説明	サンプル値
requestId	String	はい	リクエストID。	dc302d76-66b5-48d8-ab53-a035********
pageNumber	Integer	いいえ	ページ番号。デフォルト値は1です。	1
pageSize	Integer	いいえ	ページサイズ。デフォルト値は20です。	20
tenantIds	List	いいえ	テナントIDのリスト。指定したテナントをフィルタリングするために使用されます。	["txxx", "txxx1"]

戻り結果

名称	型	説明	示例値
data	Object	データ	-
dataList	Object	データリスト	-
aiFunctionStatus	String	AI機能の状態	CLOSE
cpu	Integer	CPUコア数	1
createTime	String	作成時間	2025-12-25T08:23:49Z
diskSize	Integer	ディスクサイズ	0
enableProxyPeeringLink	Boolean	ピアリングアドレスの有効化を許可するかどうか	true
enableProxyPublicLink	Boolean	公開アドレスの有効化を許可するかどうか	true
enableProxyService	Boolean	プロキシサービスの有効化を許可するかどうか	true
enableRag	Boolean	RAGサービスの有効化を許可するかどうか	false
enableStandbyReadWriteSplit	String	プライマリ/スタンバイデータベースの読み書き分離を許可するかどうか	INVISIBLE
gmtCreate	String	作成時間	2025-12-25 16:23:49.0
mem	Integer	メモリ	4
ocpTenantId	Integer	OCPテナントID	12000104
primaryZone	String	テナントのプライマリゾーン	ap-beijing-3
status	String	ステータス	ONLINE
tenantCompatibilityMode	String	テナント互換モード	MySQL
tenantConnections	Object	テナントのアドレス情報	-
addressId	String	アドレスID	rs-private-intranet-vpc-xxx
addressMasterZoneId	String	アドレスのプライマリゾーン	ap-beijing-3
addressStatus	String	アドレスのステータス	ONLINE
addressType	String	アドレスタイプ	MASTER
connectionLogicalZones	Object	接続の論理ゾーン	ap-beijing-3-z0
connectionReplicaType	String	接続のレプリカタイプ	FULL
connectionZones	Object	接続のゾーン	ap-beijing-3
enableRPc	Boolean	ダイレクトロード機能を有効にするかどうか	true
enableRagHttp	Boolean	RAG HTTPサービスを有効にするかどうか	false
intranetAddressStatus	String	内部ネットワークアドレスのステータス	ONLINE
intranetPort	Integer	内部ネットワークポート	3306
isMigrated	Integer	移行されたかどうか	0
isVirtualServerGroup	Boolean	仮想サーバーグループかどうか	true
maxConnectionNum	Integer	最大接続数	5000
maxConnectionNumLimit	Integer	接続数の上限値	5000
networkType	String	ネットワークタイプ	INTRANET
privateLinkList	Object	プライベートリンク情報	-
intranetAddress	String	アクセスIPアドレス	xx.xx.xx.xx
privateLinkEndpointId	String	エンドポイントID	vpce-xxx
privateLinkEndpointVpcId	String	エンドポイントVPC ID	vpc-xxx
privateLinkServiceId	String	エンドポイントサービスID	vpcsvc-xxx
privateLinkStatus	String	プライベートリンクのステータス	CONNECTED
privateLinkUserAccount	String	プライベートリンクのユーザーアカウント	10********
proxyClusterId	String	プロキシクラスタID	proxy-xxx
proxyClusterInfo	Object	プロキシクラスタ情報	-
deployMode	String	デプロイモード	1-1
proxyClusterId	String	クラスタID	proxy-xxx
proxyMode	String	プロキシモード	k8s_shared
proxyServiceVersion	String	プロキシアーキテクチャバージョン	2.0
proxyVersion	String	プロキシカーネルバージョン	4.3.1.6-22025072510
status	String	プロキシのステータス	ONLINE
unitNum	Integer	プロキシ構成数	1
unitSpec	String	プロキシユニット構成	2C4G
zone	String	プロキシゾーン	ap-beijing-5,ap-beijing-3
role	String	ロール	READWRITE
serviceType	String	アドレスタイプ	OBPROXY_INTRANET
tenantEndpointId	String	アドレスID	obe-xxx
tenantId	String	テナントID	txxx
useSSL	Boolean	SSLを有効にするかどうか	true
userNameFormat	String	アクセス接続文字列形式	USER
tenantId	String	テナントID	txxx
tenantMaxConnections	Integer	テナントの最大接続数	1600
tenantMode	String	テナントモード	MySQL
tenantName	String	テナント名	test_mysql
tenantResource	Object	テナントリソース	-
cpu	Integer	CPUコア数	1
totalCpu	Integer	CPUコア総数	1
unitCpu	Integer	ユニットCPUコア数	1
disk	Integer	ディスクサイズ	0
totalDiskSize	Integer	ディスクサイズ合計	0
usedDiskSize	Integer	使用済みディスクサイズ	0
usedUnitDiskSize	Integer	使用済みユニットディスクサイズ	0
memory	Integer	メモリ	4
totalMemory	Integer	メモリ合計	4
unitMemory	Integer	ユニットメモリ	4
unitNum	Integer	ユニット数	1
unitCpu	Integer	ユニットCPUコア数	1
unitDiskSize	Integer	ユニットディスクサイズ	0
unitMem	Integer	ユニットメモリ	4
unitNum	Integer	ユニット数	1
hasMore	Boolean	もっとデータがあるかどうか	false
total	Integer	データ総量	2
requestId	String	リクエストID	b7451058-f5dd-4b15-8f5c-c75911aba392
success	Boolean	成功したかどうか	true

例

リクエスト例

curl --digest -u '<Your AK:SK>' \
    -X GET \
    'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/address/info?requestId={requestId}&pageNumber={pageNumber}&pageSize={pageSize}&tenantIds={tenantIds}' \
    -H 'Content-Type: application/json'

レスポンス例

JSON形式

{
    "data":{
        "dataList":[
            {
                "aiFunctionStatus":"CLOSE",
                "cpu":1,
                "createTime":"2025-12-25T08:23:49Z",
                "diskSize":0,
                "enableProxyPeeringLink":true,
                "enableProxyPublicLink":true,
                "enableProxyService":true,
                "enableRag":false,
                "enableStandbyReadWriteSplit":"INVISIBLE",
                "gmtCreate":"2025-12-25 16:23:49.0",
                "mem":4,
                "ocpTenantId":12000104,
                "primaryZone":"ap-beijing-3",
                "status":"ONLINE",
                "tenantCompatibilityMode":"MySQL",
                "tenantConnections":[
                    {
                        "addressId":"rs-private-intranet-vpc-xxx",
                        "addressMasterZoneId":"ap-beijing-3",
                        "addressStatus":"ONLINE",
                        "addressType":"MASTER",
                        "connectionLogicalZones":[
                            "ap-beijing-3-z0"
                        ],
                        "connectionReplicaType":"FULL",
                        "connectionZones":[
                            "ap-beijing-3"
                        ],
                        "enableRPc":true,
                        "enableRagHttp":false,
                        "intranetAddressStatus":"ONLINE",
                        "intranetPort":3306,
                        "isMigrated":0,
                        "isVirtualServerGroup":true,
                        "maxConnectionNum":5000,
                        "maxConnectionNumLimit":5000,
                        "networkType":"INTRANET",
                        "privateLinkList":[
                            {
                                "deletePrivateLink":true,
                                "intranetAddress":"xxx.xxx.x.xxx:xxxx",
                                "privateLinkEndpointId":"vpce-xxx",
                                "privateLinkEndpointVpcId":"vpc-xxx",
                                "privateLinkServiceAccount":"10********",
                                "privateLinkServiceId":"vpcsvc-xxx",
                                "privateLinkStatus":"CONNECTED",
                                "privateLinkUserAccount":"10********"
                            }
                        ],
                        "proxyClusterId":"proxy-xxx",
                        "proxyClusterInfo":{
                            "createTime":"2025-12-25T08:27:20Z",
                            "deployMode":"1-1",
                            "proxyClusterId":"proxy-xxx",
                            "proxyMode":"k8s_shared",
                            "proxyServiceVersion":"2.0",
                            "proxyVersion":"4.3.1.6-22025072510",
                            "status":"ONLINE",
                            "unitNum":1,
                            "unitSpec":"2C4G",
                            "zone":"ap-beijing-5,ap-beijing-3"
                        },
                        "role":"READWRITE",
                        "serviceType":"OBPROXY_INTRANET",
                        "tenantEndpointId":"obe-xxx",
                        "tenantId":"txxx",
                        "useSSL":true,
                        "userNameFormat":"USER"
                    }
                ],
                "tenantId":"txxx",
                "tenantMaxConnections":1600,
                "tenantMode":"MySQL",
                "tenantName":"test_mysql",
                "tenantResource":{
                    "cpu":{
                        "totalCpu":1.0,
                        "unitCpu":1.0
                    },
                    "disk":{
                        "totalDiskSize":0.0,
                        "usedDiskSize":0.02,
                        "usedUnitDiskSize":0.0
                    },
                    "memory":{
                        "totalMemory":4.0,
                        "unitMemory":4.0
                    },
                    "unitNum":1
                },
                "unitCpu":1,
                "unitDiskSize":0,
                "unitMem":4,
                "unitNum":1
            }
        ],
        "hasMore":false,
        "total":2
    },
    "requestId":"b7451058-f5dd-4b15-8f5c-c75911aba392",
    "success":true
}

OceanBase

顧客事例