DescribeAIDBClusterAttribute で AI DB クラスター属性をクエリ - PolarDB - Alibaba Cloud - PolarDB

カスタムインスタンスの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeAIDBClusterAttribute

get

*AICluster。

acs:polardb:{#regionId}:{#accountId}:aicluster/{#DBClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-****************

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	EBEAA83D-1734-42E3-85E3-E25F6E******
DBClusterId	string	クラスターの ID。	pc-**************
DBClusterStatus	string	クラスターのステータス。有効な値: Creating: 作成中 Running: 実行中 Deleting: リリース中 DBNodeCreating: ノード追加中 DBNodeDeleting: ノード削除中 ClassChanging: ノードスペック変更中 Deleted: リリース済み	Running
DBClusterDescription	string	クラスターの説明。あいまい一致がサポートされています。	test
RegionId	string	リージョン ID。	cn-hangzhou
ZoneId	string	PolarDB クラスターノードのゾーン ID。	cn-hangzhou-d
VPCId	string	ゾーンスイッチオーバーに指定された VPC の ID。	vpc-*******************
VSwitchId	string	vSwitch の ID。説明 VPCId が指定されている場合、VSwitchId は必須です。	vsw-*********************
InternalIp	string	内部 IP アドレス。	10...72
StorageType	string	Enterprise Edition のストレージタイプの有効な値: PSL5 PSL4 Standard Edition のストレージタイプの有効な値: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	essdpl1
DBNodes	array<object>	ノードの詳細。
	array<object>	ノードの詳細。
DBNodeClass	string	クラスターのスペック。	polar.pg.g8.8xlarge.gu30
CpuCores	string	ノードの CPU コア数。	2
MemorySize	string	ノードのメモリサイズ。単位: MB。	8192
GPU	string	GPU カードの数。	2
DBNodeId	string	ノードの ID。	pi-****************
DBNodeDescription	string	ノードの説明。	test
VSwitchId	string	vSwitch の ID。	vsw-*********************
VPCId	string	VPC の ID。	vpc-*******************
DBNodeStatus	string	ノードのステータス。有効な値: Creating: 作成中 Running: 実行中 Deleting: 削除中 Rebooting: 再起動中 DBNodeCreating: ノード追加中 DBNodeDeleting: ノード削除中 ClassChanging: ノードスペック変更中 MinorVersionUpgrading: マイナーバージョンアップグレード中 Maintaining: メンテナンス中 Switching: スイッチオーバー中	Running
ZoneId	string	ゾーンの ID。	cn-hangzhou-d
VNodeId	string	Kubernetes 仮想ノードの ID。	vn-***************
LinkIP	string	非公開 IP アドレス。	10..12
ChildVolumes	array<object>	データクラウドディスクのリスト。
	object	データクラウドディスクの情報。
StorageType	string	ストレージクラス。	PL1
StorageCategory	string	ストレージタイプ。	PolarFs
SizeGB	string	ストレージサイズ。	8192
Name	string	クラウドディスク名。	jueming
MountPath	string	実際のマウントパス。	/tmp/CrowdStrike
PublicIp	string	パブリック IP アドレス。	101.101.101.101
CreationTime	string	作成時間。	2020-08-14T05:58:42Z
LockMode	string	インスタンスのロックモード。値 lock は、インスタンスが自動的に期限切れになったか、支払い遅延があることを示します。	Unlock
CreationTime	string	クラスターの作成時間。	2020-08-14T05:58:42Z
PayType	string	課金方法。有効な値: Postpaid: 従量課金。 Prepaid: サブスクリプション。	Postpaid
ExpireTime	string	クラスターの有効期限時間。説明このパラメーターは、課金方法が Prepaid (サブスクリプション) のクラスターに対してのみ値を返します。Postpaid (従量課金) のクラスターの場合は空の値が返されます。	2020-11-14T16:00:00Z
Expired	boolean	クラスターが期限切れかどうかを示します。有効な値: true false	false
ZoneIds	string	ゾーンの ID。	cn-hangzhou-i,cn-hangzhou-g
RunType	string	アーキテクチャタイプ。有効な値: container: AI コンテナ ainode: AI ノード	container
KubeClusterId	string	ACK クラスターの ID。	xxxxxxxxxxxxxxxxxxxxxxx
DBVersion	string	クラスターのバージョン。有効な値: 1.0 2.0 3.0	1.0
AiNodeType	string	ノードタイプ。有効な値: vnode: ACK 管理対象 container: ログイン可能なコンテナ maas: モデルサービス	vnode
Volumes	array<object>	データクラウドディスクのリスト。
	object	データクラウドディスクの情報。
StorageType	string	ストレージクラス。	PolarFs
StorageCategory	string	ストレージタイプ。	PL1
Name	string	クラウドディスクの名前。	jueming
SizeGB	string	ストレージサイズ。	8192
MountPath	string	コンテナ内のマウントパス。	/var/run/secrets/kubernetes.io/serviceaccount
EndpointList	array<object>	インスタンスのネットワーク接続アドレスのリスト。
	array<object>	インスタンスのネットワーク接続アドレス。
NetInfoItems	array<object>	インスタンスのネットワーク情報のリスト。
	object	インスタンスのネットワーク情報。
NetType	string	接続文字列のネットワークタイプ。有効な値: Public: パブリックエンドポイント Private: プライベートエンドポイント Inner: プライベートエンドポイント (クラシックネットワーク)。	Public
ConnectionString	string	データベース接続アドレス。	pc-**********.rwlb.rds.aliyuncs.com
Port	string	ポート番号。	3306
ModelName	string	モデル名。	Qwen3-Embedding-8B
GatewayId	string
MaxQPM	string	1 分あたりの最大リクエスト数。	20
PublicIp	string	パブリック IP アドレス。	8.xxx.xxx.xxx
KVCacheInstanceId	string	KVCache インスタンスの ID。	pkv-xxxxx
EcsSecurityGroupId	string	セキュリティグループの ID。	sg-xxxxxx
ModelType	string	モデルタイプ。	custom
ApiKey	string	API キー。	x********
TimeSlicesType	string
VnodeKubernetesConfig	object
Labels	array<object>
	object
Key	string
Value	string
Taints	array<object>
	object
Key	string
Value	string
Effect	string
TimeSlicesInfo	object
TimeSlices	array<object>
	object
BeginTime	string
EndTime	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBClusterId": "pc-**************",
  "DBClusterStatus": "Running",
  "DBClusterDescription": "test",
  "RegionId": "cn-hangzhou",
  "ZoneId": "cn-hangzhou-d\t\n",
  "VPCId": "vpc-*******************",
  "VSwitchId": "vsw-*********************",
  "InternalIp": "10.*.*.72",
  "StorageType": "essdpl1",
  "DBNodes": [
    {
      "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
      "CpuCores": "2",
      "MemorySize": "8192",
      "GPU": "2",
      "DBNodeId": "pi-****************",
      "DBNodeDescription": "test",
      "VSwitchId": "vsw-*********************",
      "VPCId": "vpc-*******************",
      "DBNodeStatus": "Running",
      "ZoneId": "cn-hangzhou-d\t\n",
      "VNodeId": "vn-***************",
      "LinkIP": "10.*.*12",
      "ChildVolumes": [
        {
          "StorageType": "PL1",
          "StorageCategory": "PolarFs",
          "SizeGB": "8192",
          "Name": "jueming",
          "MountPath": "/tmp/CrowdStrike"
        }
      ],
      "PublicIp": "101.101.101.101",
      "CreationTime": "2020-08-14T05:58:42Z"
    }
  ],
  "LockMode": "Unlock",
  "CreationTime": "2020-08-14T05:58:42Z",
  "PayType": "Postpaid",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "Expired": false,
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "RunType": "container",
  "KubeClusterId": "xxxxxxxxxxxxxxxxxxxxxxx",
  "DBVersion": "1.0",
  "AiNodeType": "vnode",
  "Volumes": [
    {
      "StorageType": "PolarFs",
      "StorageCategory": "PL1",
      "Name": "jueming",
      "SizeGB": "8192",
      "MountPath": "/var/run/secrets/kubernetes.io/serviceaccount"
    }
  ],
  "EndpointList": [
    {
      "NetInfoItems": [
        {
          "NetType": "Public",
          "ConnectionString": "pc-**********.rwlb.rds.aliyuncs.com",
          "Port": "3306"
        }
      ]
    }
  ],
  "ModelName": "\nQwen3-Embedding-8B",
  "GatewayId": "",
  "MaxQPM": "20",
  "PublicIp": "8.xxx.xxx.xxx",
  "KVCacheInstanceId": "pkv-xxxxx",
  "EcsSecurityGroupId": "sg-xxxxxx",
  "ModelType": "custom",
  "ApiKey": "x********",
  "TimeSlicesType": "",
  "VnodeKubernetesConfig": {
    "Labels": [
      {
        "Key": "",
        "Value": ""
      }
    ],
    "Taints": [
      {
        "Key": "",
        "Value": "",
        "Effect": ""
      }
    ]
  },
  "TimeSlicesInfo": {
    "TimeSlices": [
      {
        "BeginTime": "",
        "EndTime": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定された DBClusterId はレコードに存在しません。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	指定された DBClusterId は現在のレコードに存在しません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。