ListResources でリソースグループをクエリ - 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:ListResources

get

*Resource

acs:eas:{#regionId}:{#accountId}:resource/*

なし

リクエスト構文

GET /api/v2/resources HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：100。	20
ResourceName	string	任意	リソースグループの名前。 CreateResource 操作を呼び出して、リソースグループの名前をクエリできます。	MyResource
ResourceId	string	任意	リソースグループの ID。 CreateResource 操作を呼び出して、リソースグループの ID をクエリできます。	eas-r-h7lcw24dyqztwxxxxxx
ResourceType	string	任意	リソースグループのタイプ。有効な値： Dedicated：専用リソースグループ。 SelfManaged：セルフマネージドリソースグループ。列挙値: SelfManaged : SelfManaged Dedicated : Dedicated	Dedicated
ResourceStatus	string	任意	リソースグループのステータス。	ResourceReady
Order	string	任意	ソート順。有効な値： Desc Asc	Desc
Sort	string	任意	結果のソート条件。デフォルトでは、クエリ結果はタイムスタンプタイプに基づき降順でソートされます。有効な値： PrePaidInstanceCount CpuCount Memory CreateTime PostPaidInstanceCount MemoryUsed GpuCount GpuUsed CpuUsed ServiceCount 列挙値: PrePaidInstanceCount : PrePaidInstanceCount CpuCount : CpuCount Memory : Memory CreateTime : CreateTime PostPaidInstanceCount : PostPaidInstanceCount MemoryUsed : MemoryUsed GpuCount : GpuCount GpuUsed : GpuUsed CpuUsed : CpuUsed ServiceCount : ServiceCount	CreateTime

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	40325405-579C-4D82****
Resources	array	リソースグループ。
	Resource	リソースグループの詳細。
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	20
TotalCount	integer	返されたエントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "40325405-579C-4D82****",
  "Resources": [
    {
      "Status": "ResourceReady",
      "PrePaidInstanceCount": 2,
      "Message": "Resource is ready",
      "ClusterId": "cn-shanghai",
      "ResourceName": "iot",
      "Memory": 8192,
      "CreateTime": "2019-02-26T17:52:49Z",
      "ResourceType": "Dedicated",
      "PostPaidInstanceCount": 2,
      "ExtraData": {},
      "Vendor": "ECS",
      "InstanceCount": 4,
      "CpuCount": 64,
      "InstanceMaxAllocatableCPU": 16,
      "ResourceId": "eas-r-asdasdasd",
      "UpdateTime": "2019-02-26T19:52:49Z",
      "InstanceMaxAllocatableGPU": 2,
      "InstanceMaxAllocatableMemory": 2048,
      "MemoryUsed": 2048,
      "Features": [
        "GpuShare"
      ],
      "GpuCount": 1,
      "GpuUsed": 1,
      "CpuUsed": 8
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1
}

エラーコード

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

変更履歴

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