Query resources by using the ListResources API - Platform For AI

Lists the resources associated with a workspace.

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

paiworkspace:ListResources

list

*All Resource

*

None

Request syntax

GET /api/v1/resources HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces. This parameter is required when Option is set to ListResourceByWorkspace. This parameter is not required when Option is set to ListResource.	123
PageNumber	integer	No	The page number of the resource list. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The default value is 20.	20
ProductTypes	string	No	This field is deprecated and will be unpublished. Use the ResourceType field instead.	MaxCompute
GroupName	string	No	The name of the resource group. For more information about how to obtain the name of a resource group, see ListResources.	group
ResourceName	string	No	The resource name. The format is as follows: The name must be 3 to 28 characters in length. The name must be unique within the same region.	resource
Option	string	No	The option. Valid values: ListResourceByWorkspace (default): Lists the resources in the workspace. ListResource: Lists the resources of the user.	ListResourceByWorkspace
Verbose	boolean	No	Specifies whether to display detailed information. The detailed information includes the Quotas field. Valid values: true (default): Displays detailed information. false: Does not display detailed information.	true
ResourceTypes	string	No	The list of resource types. Valid values: MaxCompute: MaxCompute resources ECS: general computing resources Lingjun: Lingjun resources ACS: ACS computing resources FLINK: Flink resources	MaxCompute
QuotaIds	string	No	A collection of QuotaIds, separated by commas. Only resources that have all these QuotaIds are returned. Note Currently, you can filter only resources for which ResourceTypes is set to ACS using this parameter.	quota-k****da,quota-cd****w
Labels	string	No	A collection of tag filter conditions, separated by commas. Only resources that meet all these tag conditions are returned. Currently, you can filter only resources for which ProductType is set to ACS using this parameter.	system.supported.dsw=true,system.supported.dlc=true
VerboseFields	string	No	A comma-separated collection that specifies the fields to return. The following fields are supported: Quota Label IsDefault	Quota,IsDefault

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
Resources	array<object>	The list of resources.
	array<object>	The resource information.
Id	string	The resource ID.	123
Name	string	The resource name.	ResourceName
ProductType	string	This field is deprecated and will be unpublished. Use the ResourceType field instead.	MaxCompute
EnvType	string	The environment type. Valid values: dev: developer environment prod: production environment	prod
WorkspaceId	string	The ID of the workspace to which the resource belongs.	123
IsDefault	boolean	Specifies whether the resource is the default resource. Each resource type has a default resource. Valid values: true: The resource is the default resource. false: The resource is not the default resource.	true
Quotas	array<object>	The list of quotas.
	array<object>	The quota information.
Name	string	The quota name.	QuotaName
ProductCode	string	The product name. Valid values: PAI_isolate: PAI subscription resource group (PAI CPU) PAI_share: PAI pay-as-you-go resource group (PAI GPU) MaxCompute_share: MaxCompute pay-as-you-go resource group MaxCompute_isolate: MaxCompute subscription resource group DataWorks_isolate: DataWorks subscription resource group DataWorks_share: DataWorks pay-as-you-go resource group DLC_share: DLC pay-as-you-go resource group	MaxCompute_isolate
QuotaType	string	The resource quota type. Valid values: PAI MaxCompute DLC	MaxCompute
Mode	string	The billing method. Valid values: isolate: subscription share: pay-as-you-go	isolate
Specs	array<object>	The list of specification descriptions.	{\"cu\":\"11500\",\"minCu\":\"2300\",\"parentId\":\"0\"}
	object	The specification description.
Name	string	The specification name.	cu
Value	string	The specification description.	11500
CardType	string	The card type. Valid values: CPU GPU	CPU
Id	string	The resource quota ID.	123
DisplayName	string	The alias of the resource quota.	默认后付费Quota
Spec	object	The specification description.	对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}
GroupName	string	The name of the resource group. The name must be unique within an Alibaba Cloud account.	groupName
GmtCreateTime	string	The time when the resource was created. The time is in UTC and follows the ISO 8601 standard.	2021-01-21T17:12:35.232Z
Executor	object	This field is invalid and deprecated.
OwnerId	string	This field is invalid and deprecated.	110973******7793
Encryption	object	The encryption information. This parameter is valid only for MaxCompute resources.
Enabled	boolean	Specifies whether encryption is enabled.	false
Algorithm	string	The encryption algorithm.	AESCTR
Key	string	The primary key for encryption.	DEFAULT
ResourceType	string	The resource type. Valid values: MaxCompute: MaxCompute resources DLC: cloud-native resources FLINK: Flink resources	MaxCompute
Labels	array<object>	The collection of tags.
	object	The tag.
Key	string	The key of the tag.	system.supported.dsw
Value	string	The value of the tag.	true
TotalCount	integer	The number of resources that meet the filter conditions.	2

Examples

Success response

JSON format

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "Resources": [
    {
      "Id": "123",
      "Name": "ResourceName",
      "ProductType": "MaxCompute",
      "EnvType": "prod",
      "WorkspaceId": "123",
      "IsDefault": true,
      "Quotas": [
        {
          "Name": "QuotaName",
          "ProductCode": "MaxCompute_isolate",
          "QuotaType": "MaxCompute",
          "Mode": "isolate",
          "Specs": [
            {
              "Name": "cu",
              "Value": "11500"
            }
          ],
          "CardType": "CPU",
          "Id": "123",
          "DisplayName": "默认后付费Quota"
        }
      ],
      "Spec": {
        "test": "test",
        "test2": 1
      },
      "GroupName": "groupName",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Executor": {
        "OwnerId": "110973******7793"
      },
      "Encryption": {
        "Enabled": false,
        "Algorithm": "AESCTR",
        "Key": "DEFAULT"
      },
      "ResourceType": "MaxCompute",
      "Labels": [
        {
          "Key": "system.supported.dsw",
          "Value": "true"
        }
      ]
    }
  ],
  "TotalCount": 2
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.