DescribeAgenticDBComputeClusters

Queries the 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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		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 returned.	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 of the compute instance.	Compute cluster for analytics
Status	string	The status of the compute instance.	Running
LastActivatedAt	string	The time when the compute instance was last activated.	2026-06-10T12:30:00Z
CreateTime	string	The time when the compute instance was created.	2026-06-10T11:00:00Z
IsDefaultBranch	boolean		false
ProjectId	string	The ID of the associated project.	proj-a1b2c3d4e5f6
ProjectName	string	The name of the associated project.	analytics-prod
TenantId	string	The ID of the associated tenant.	t-4b83e0da66674951
TenantName	string	The name of the associated tenant.	my-saas-app
BranchId	string	The ID of the associated branch.	br-7g8h9i0j1k2l
BranchName	string	The name of the associated branch.	feature-analytics
ComputeNodeCount	integer	The number of compute nodes. The value is 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 amount of used data, in bytes.	1073741824
ParentBranchId	string
ParentBranchName	string

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": "",
      "ParentBranchName": ""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.