DescribeAgenticDBBranches

Queries the list of AgenticDB branches.

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		cn-hangzhou
DBClusterId	string	Yes		pagc-bp1abcdef1234567
TenantId	string	No		t-4b83e0da66674951
ProjectId	string	No		proj-a1b2c3d4e5f6
BranchName	string	No		feature
Status	string	No		Running
PageSize	integer	No		30
PageNumber	integer	No		1

Response elements

Element	Type	Description	Example
	object
RequestId	string		B2C3D4E5-F6A7-8901-BCDE-2345678901BC
TotalCount	integer		5
PageNumber	integer		1
PageSize	integer		30
Items	array<object>
	object
BranchId	string		br-7g8h9i0j1k2l
BranchName	string		feature-analytics
ParentBranchId	string		br-1a2b3c4d5e6f
ParentBranchName	string		main
TenantId	string		t-4b83e0da66674951
ProjectId	string		proj-a1b2c3d4e5f6
ProjectName	string		analytics-prod
BranchComputeClusterId	string		pc-g0lsayq8c5qe
BranchComputeNodeCount	integer		1
MinCU	string		0.25
MaxCU	string		2
Description	string		Feature branch for analytics
Status	string		Running
LastActivatedAt	string		2026-06-10T12:30:00Z
CreateTime	string		2026-06-10T11:00:00Z
IsDefaultBranch	boolean		false

Examples

Success response

JSON format

{
  "RequestId": "B2C3D4E5-F6A7-8901-BCDE-2345678901BC",
  "TotalCount": 5,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "BranchId": "br-7g8h9i0j1k2l",
      "BranchName": "feature-analytics",
      "ParentBranchId": "br-1a2b3c4d5e6f",
      "ParentBranchName": "main",
      "TenantId": "t-4b83e0da66674951",
      "ProjectId": "proj-a1b2c3d4e5f6",
      "ProjectName": "analytics-prod",
      "BranchComputeClusterId": "pc-g0lsayq8c5qe",
      "BranchComputeNodeCount": 1,
      "MinCU": "0.25",
      "MaxCU": "2",
      "Description": "Feature branch for analytics",
      "Status": "Running",
      "LastActivatedAt": "2026-06-10T12:30:00Z",
      "CreateTime": "2026-06-10T11:00:00Z",
      "IsDefaultBranch": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.