ListResources - Platform For AI - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eas:ListResources

get

*Resource

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

None

Request syntax

GET /api/v2/resources HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 100.	20
ResourceName	string	No	The name of the resource group. You can call the CreateResource operation to query the name of the resource group.	MyResource
ResourceId	string	No	The ID of the resource group. You can call the CreateResource operation to query the ID of the resource group.	eas-r-h7lcw24dyqztwxxxxxx
ResourceType	string	No	The type of the resource group. Valid values: Dedicated: the dedicated resource group. SelfManaged: the self-managed resource group. Valid values: SelfManaged : SelfManaged Dedicated : Dedicated	Dedicated
ResourceStatus	string	No	The resource group status.	ResourceReady
Order	string	No	The sorting order. Valid values: Desc Asc	Desc
Sort	string	No	The condition by which the results are sorted. By default, the query results are sorted by the timestamp type in descending order. Valid values: PrePaidInstanceCount CpuCount Memory CreateTime PostPaidInstanceCount MemoryUsed GpuCount GpuUsed CpuUsed ServiceCount Valid values: PrePaidInstanceCount : PrePaidInstanceCount CpuCount : CpuCount Memory : Memory CreateTime : CreateTime PostPaidInstanceCount : PostPaidInstanceCount MemoryUsed : MemoryUsed GpuCount : GpuCount GpuUsed : GpuUsed CpuUsed : CpuUsed ServiceCount : ServiceCount	CreateTime

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82****
Resources	array	The resource groups.
	Resource	The details of the resource group.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Resources": [
    {
      "Status": "ResouceReady",
      "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.