ListResources-阿里云帮助中心

Lists 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 ID of the workspace. To get the workspace ID, see ListWorkspaces. This parameter is required if `Option` is set to `ListResourceByWorkspace`. This parameter is not required if `Option` is set to `ListResource`.	123
PageNumber	integer	No	The page number. The value must be greater than or equal to 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20
ProductTypes	string	No	Deprecated. This parameter is deprecated. Use the `ResourceType` parameter instead.	MaxCompute
GroupName	string	No	The name of the resource group. To get the resource group name, see ListResources.	group
ResourceName	string	No	The resource name. The name must meet the following requirements: The name must be 3 to 28 characters in length. The name must be unique within a region.	resource
Option	string	No	The option to query resources. Valid values: `ListResourceByWorkspace` (Default): lists the resources in a workspace. `ListResource`: lists the resources of the current user.	ListResourceByWorkspace
Verbose	boolean	No	Specifies whether to return detailed information. The detailed information includes the `Quotas` field. Valid values: `true` (Default): returns detailed information. `false`: does not return detailed information.	true
ResourceTypes	string	No	The resource types. Valid values: `MaxCompute`: MaxCompute resources. `ECS`: ECS resources. `Lingjun`: Lingjun computing resources. `ACS`: ACS computing resources. `Flink`: Flink resources. `SelfManagedAckPro`: self-managed AckPro cluster resources. `SelfManagedAckLingjun`: self-managed AckLingjun cluster resources. `SelfManagedASI`: self-managed ASI cluster resources from a third-party cloud.	MaxCompute
QuotaIds	string	No	A comma-separated list of quota IDs. This operation returns only the resources that are associated with all the specified quota IDs. Note This parameter is available only for resources whose `ResourceTypes` is set to `ACS`.	quota-k****da,quota-cd****w
Labels	string	No	A comma-separated list of labels. This operation returns only the resources that have all the specified labels. This parameter is available only for resources whose `ResourceTypes` is set to `ACS`.	system.supported.dsw=true,system.supported.dlc=true
VerboseFields	string	No	A comma-separated list of fields that you want to return. Valid values: `Quota` `Label` `IsDefault`	Quota,IsDefault

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
Resources	array<object>	The list of resources.
	array<object>	Details of a resource.
Id	string	The resource ID.	123
Name	string	The resource name.	ResourceName
ProductType	string	Deprecated. This parameter is deprecated and will be removed in a future release. Use the `ResourceType` parameter instead.	MaxCompute
EnvType	string	The environment type. Valid values: `dev`: development environment `prod`: production environment	prod
WorkspaceId	string	The ID of the workspace to which the resource belongs.	123
IsDefault	boolean	Indicates whether the resource is the default resource of its type. Each resource type has only one 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>	Details of a quota.
Name	string	The quota name.	QuotaName
ProductCode	string	The product code. 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 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 specifications.	{\"cu\":\"11500\",\"minCu\":\"2300\",\"parentId\":\"0\"}
	object	The details of a specification.
Name	string	The specification name.	cu
Value	string	The specification value.	11500
CardType	string	The card type. Valid values: `CPU` `GPU`	CPU
Id	string	The quota ID.	123
DisplayName	string	The display name of the quota.	默认后付费Quota
Spec	object	The resource specifications.	对于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 displayed in UTC and is formatted in ISO 8601.	2021-01-21T17:12:35.232Z
Executor	object	Deprecated. This parameter is no longer used.
OwnerId	string	Deprecated. This parameter is no longer used.	110973******7793
Encryption	object	The encryption details. This parameter is valid only for MaxCompute resources.
Enabled	boolean	Indicates whether encryption is enabled.	false
Algorithm	string	The encryption algorithm.	AESCTR
Key	string	The encryption key.	DEFAULT
ResourceType	string	The type of the resource. Valid values: `MaxCompute`: MaxCompute resources `ECS`: ECS resources `Lingjun`: Lingjun intelligent computing resources `ACS`: ACS computing resources `Flink`: Flink resources `SelfManagedAckPro`: self-managed cluster resources for AckPro `SelfManagedAckLingjun`: self-managed cluster resources for AckLingjun `SelfManagedASI`: self-managed cluster resources for ASI (third-party cloud)	MaxCompute
Labels	array<object>	The list of labels.
	object	Details of a label.
Key	string	The key of the label.	system.supported.dsw
Value	string	The value of the label.	true
TotalCount	integer	The total number of entries that match the filter criteria.	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.