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

例

成功レスポンス

JSONJSON

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

エラーコード

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 が現在のレコードに存在しません。

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

変更履歴

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