All Products
Search
Document Center

Platform For AI:ListResources

Last Updated:Nov 22, 2024

Queries a list of dedicated resource groups for the current user.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eas:ListResourcesget
*Resource
acs:eas:{#regionId}:{#accountId}:resource/*
    none
none

Request syntax

GET /api/v2/resources HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 100.

20
ResourceNamestringNo

The name of the resource group. You can call the CreateResource operation to query the name of the resource group.

MyResource
ResourceIdstringNo

The ID of the resource group. You can call the CreateResource operation to query the ID of the resource group.

eas-r-h7lcw24dyqztwxxxxxx
ResourceTypestringNo

The type of the resource group. Valid values:

  • Dedicated: the dedicated resource group.
  • SelfManaged: the self-managed resource group.
Dedicated

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

40325405-579C-4D82****
Resourcesarray

The resource groups.

ResourcesResource

The details of the resource group.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Resources": [
    {
      "ResourceId": "eas-r-asdasdasd",
      "ResourceName": "iot",
      "ResourceType": "Dedicated",
      "ClusterId": "cn-shanghai",
      "CreateTime": "2019-02-26T17:52:49Z",
      "UpdateTime": "2019-02-26T19:52:49Z",
      "InstanceCount": 4,
      "PrePaidInstanceCount": 2,
      "PostPaidInstanceCount": 2,
      "CpuCount": 64,
      "GpuCount": 1,
      "Status": "ResouceReady",
      "Message": "Resource is ready",
      "ExtraData": {},
      "Vendor": "ECS"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-24The request parameters of the API has changedView Change Details
2022-11-29The request parameters of the API has changedView Change Details