DescribeVirtualResource API リファレンス - PAI

仮想リソースグループの詳細を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eas:DescribeVirtualResource

get

*VirtualResource

acs:eas:{#regionId}:{#accountId}:virtualresource/{#VirtualResourceId}

なし

リクエスト構文

GET /api/v2/virtualresources/{ClusterId}/{VirtualResourceId} HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	仮想リソースグループが配置されているリージョン。	cn-shanghai
VirtualResourceId	string	必須	仮想リソースグループの ID。	eas-vr-npovr28onap1xxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	仮想リソースグループの詳細。
RequestId	string	リクエスト ID。	40325405-579C-4D82****
Resources	array<object>	仮想リソースグループ内のリソースのリスト。
	object	リソースの詳細。
Region	string	リソースが配置されているリージョン。	cn-hangzhou
Priority	integer	リソースのスケジューリング優先度。値が大きいほど、優先度が高くなります。	3
InstanceType	string	パブリックリソースグループのインスタンスタイプ。	ecs.s6-c1m2.xlarge
QuotaId	string	Lingjun リソースクォータの ID。	quota185lqxxxxxx
SpotPriceLimit	number	パブリックリソースグループ内のスポットインスタンスの最高価格。	10.05
ResourceId	string	専用リソースグループの ID。	eas-r-g55ieatgg3buxxxxxx
CreateTime	string	仮想リソースグループが作成された時間。	2024-10-16T17:52:49Z
UpdateTime	string	仮想リソースグループが最後に更新された時間。	2024-10-16T19:52:49Z
VirtualResourceId	string	仮想リソースグループの ID。	eas-vr-npovr28onap1xxxxxx
VirtualResourceName	string	仮想リソースグループの名前。	MyVirtualResource
ServiceCount	integer	デプロイされたサービスの数。	1
DisableSpotProtectionPeriod	boolean	スポットインスタンスの保護期間が無効になっているかどうかを示します。	true
Features	array	仮想リソースグループの特徴のコレクション。これは、リソースグループがサポートする属性を識別します。
	string	仮想リソースグループがサポートする特定の属性。現在、GpuShare (GPU 共有) のみがサポートされています。	GpuShare

例

成功レスポンス

JSONJSON

{
  "RequestId": "40325405-579C-4D82****",
  "Resources": [
    {
      "Region": "cn-hangzhou",
      "Priority": 3,
      "InstanceType": "ecs.s6-c1m2.xlarge\n",
      "QuotaId": "quota185lqxxxxxx\n",
      "SpotPriceLimit": 10.05,
      "ResourceId": "eas-r-g55ieatgg3buxxxxxx\n"
    }
  ],
  "CreateTime": "2024-10-16T17:52:49Z\n",
  "UpdateTime": "2024-10-16T19:52:49Z\n",
  "VirtualResourceId": "eas-vr-npovr28onap1xxxxxx\n",
  "VirtualResourceName": "MyVirtualResource\n",
  "ServiceCount": 1,
  "DisableSpotProtectionPeriod": true,
  "Features": [
    "GpuShare"
  ]
}

エラーコード

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

変更履歴

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