All Products
Search
Document Center

DataWorks:ListComputeResources

Last Updated:Jan 12, 2026

Queries the list of computing resources that meet the specified business information.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
dataworks:ListComputeResourcesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the DataWorks workspace.

21229
NamestringNo

The name of the computing resource.

category name
TypesarrayNo

The filter for computing resource types. You can configure multiple types for filtering.

stringNo

The type of the computing resource.

hologres
EnvTypestringNo

The environment type of the computing resource. Valid values:

  • Dev
  • Prod
Dev
PageNumberintegerNo

The page number to query. The default value is 1, which indicates the first page.

1
PageSizeintegerNo

The number of entries per page. The default value is 10, and the maximum value is 100.

10
SortBystringNo

The field to sort the computing resource list by. Supported fields include name, creation time, and computing resource ID.

  • CreateTime: Sorts by creation time
  • Id: Sorts by computing resource ID
  • Name: Sorts by computing resource name.
  • CreateTimeWithDefaultFirst: Sorts based on whether it is the default resource and by creation time, with the default computing resource listed first.

Default value: CreateTime

CreateTimeWithDefaultFirst
OrderstringNo

The sort direction of the computing resource list. Valid values:

  • Desc: descending order.
  • Asc: ascending order.

Default value: Desc

Asc

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID. Used to locate logs and troubleshoot issues.

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX
PagingInfoobject

Pagination information.

TotalCountlong

The total number of records.

100
PageSizelong

The number of records per page.

10
PageNumberlong

The current page number.

1
ComputeResourcesarray<object>

The list of computing resources. Each element is a computing resource group that contains information about the development environment (if any) and the production environment.

array<ComputeResource>object

Information about the computing resource group, which includes computing resources for the development environment (if any) and the production environment. The computing resources for the development and production environments have the same name and type but different IDs.

Namestring

The name of the computing resource.

cal_all_vemg_workflow_parallel
Typestring

The type of the computing resource.

hologres
ComputeResourcearray<object>

Details of a single computing resource.

ComputeResourceobject

Details of a single computing resource.

Idlong

The computing resource ID, which is the unique identifier for the resource.

8649832502405358603
ConnectionPropertiesany

The category of the added compute resource. Different types have different subtypes with corresponding parameter constraints. Examples: InstanceMode: The instance mode. UrlMode: The connection string mode.

{\n \"clusterIdentifier\": \"c-da123456\",\n \"database\": \"testdb\",\n \"loginMode\":\"Anonymous\",\n \"defaultFS\":\"127.0.0.1\",\n \"envType\": \"Prod\"\n}
ConnectionPropertiesModestring

The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:

  • Dev
  • Prod Different types of computing resources have different attribute specifications under different configuration modes (ConnectionPropertiesMode).
UrlMode
Descriptionstring

The unique identifier of the computing resource.

home_feed
CreateTimelong

The creation time (timestamp).

1624387842781448
CreateUserstring

The creator ID.

1648711113000
ModifyTimelong

The last modified time of the computing resource (timestamp).

1624387842781448
ModifyUserstring

The modifier ID.

1648711113000
WhetherDefaultboolean

Specifies whether it is the default compute resource.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "ComputeResources": [
      {
        "Name": "cal_all_vemg_workflow_parallel",
        "Type": "hologres",
        "ComputeResource": [
          {
            "Id": 8649832502405359000,
            "ConnectionProperties": "{\\n    \\\"clusterIdentifier\\\": \\\"c-da123456\\\",\\n    \\\"database\\\": \\\"testdb\\\",\\n    \\\"loginMode\\\":\\\"Anonymous\\\",\\n    \\\"defaultFS\\\":\\\"127.0.0.1\\\",\\n    \\\"envType\\\": \\\"Prod\\\"\\n}",
            "ConnectionPropertiesMode": "UrlMode",
            "Description": "home_feed",
            "CreateTime": 1624387842781448,
            "CreateUser": 1648711113000,
            "ModifyTime": 1624387842781448,
            "ModifyUser": 1648711113000,
            "WhetherDefault": true
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-11-25Add OperationView Change Details