DescribeAgenticDBComputeClusters-阿里云帮助中心

Queries a list of AgenticDB compute instances.

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

polardb:DescribeAgenticDBComputeClusters

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBClusterId	string	Yes	The AgenticDB cluster ID.	pagc-bp1abcdef1234567
Status	string	No	The status filter. Valid values: Running, Stopped, and Waiting.	Running
ComputeClusterId	string	No	The compute instance ID for fuzzy matching (pc-xxxx), such as pc-2ze8k.	pc-2ze8k
PageSize	integer	No	The number of entries per page. Default value: 30. Maximum value: 100.	30
PageNumber	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	F6A7B8C9-D0E1-2345-FABC-678901234FAB
TotalCount	integer	The total number of entries.	3
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	30
Items	array<object>	The list of compute instances.
	object	The compute instance information.
ComputeClusterId	string	The compute instance ID.	pc-g0lsayq8c5qe
Description	string	The description.	Compute cluster for analytics
Status	string	The status.	Running
LastActivatedAt	string	The last activation time. The time is in ISO 8601 format and uses the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ).	2026-06-10T12:30:00Z
CreateTime	string	The creation time. The time is in ISO 8601 format and uses the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ).	2026-06-10T11:00:00Z
IsDefaultBranch	boolean	Indicates whether it is the default branch.	false
ProjectId	string	The associated project ID.	proj-a1b2c3d4e5f6
ProjectName	string	The associated project name.	analytics-prod
TenantId	string	The associated tenant ID.	t-4b83e0da66674951
TenantName	string	The associated tenant name.	my-saas-app
BranchId	string	The associated branch ID.	br-7g8h9i0j1k2l
BranchName	string	The associated branch name.	feature-analytics
ComputeNodeCount	integer	The number of compute nodes (fixed to 1 in the first phase).	1
OperatorType	string	The operator type.	Neon
MinCU	string	The minimum compute unit.	0.25
MaxCU	string	The maximum compute unit.	2
StorageSize	integer	The used data volume (in bytes).	1073741824
ParentBranchId	string	The parent branch ID. An empty string indicates the root branch.	br-1a2b3c4d5e6f
ParentBranchName	string	The parent branch name. An empty string indicates the root branch.	main

Examples

Success response

JSON format

{
  "RequestId": "F6A7B8C9-D0E1-2345-FABC-678901234FAB",
  "TotalCount": 3,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "ComputeClusterId": "pc-g0lsayq8c5qe",
      "Description": "Compute cluster for analytics",
      "Status": "Running",
      "LastActivatedAt": "2026-06-10T12:30:00Z",
      "CreateTime": "2026-06-10T11:00:00Z",
      "IsDefaultBranch": false,
      "ProjectId": "proj-a1b2c3d4e5f6",
      "ProjectName": "analytics-prod",
      "TenantId": "t-4b83e0da66674951",
      "TenantName": "my-saas-app",
      "BranchId": "br-7g8h9i0j1k2l",
      "BranchName": "feature-analytics",
      "ComputeNodeCount": 1,
      "OperatorType": "Neon",
      "MinCU": "0.25",
      "MaxCU": "2",
      "StorageSize": 1073741824,
      "ParentBranchId": "br-1a2b3c4d5e6f",
      "ParentBranchName": "main"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.