DescribeAgenticDBBranchLineage

Queries the branch lineage of an AgenticDB cluster.

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
TenantId	string	Yes	The tenant ID.	t-4b83e0da66674951
ProjectId	string	Yes	The project ID.	proj-a1b2c3d4e5f6
BranchId	string	No	The anchor branch ID. If this parameter is not specified, the primary branch of the project is used by default.	br-7g8h9i0j1k2l
MaxViewDepth	integer	No		3
IncludeDestroying	boolean	No	Specifies whether to include branches in the Destroying state. Default value: false.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	B2C3D4E5-F6A7-8901-BCDE-2345678901BC
TenantId	string	The tenant ID.	t-4b83e0da66674951
ProjectId	string	The project ID.	proj-a1b2c3d4e5f6
ProjectName	string	The project name.	analytics-prod
AnchorBranchId	string	The anchor branch ID.	br-7g8h9i0j1k2l
RootBranchId	string	The primary branch ID.	br-root
NodeCount	integer	The total number of returned nodes.	6
Items	array<object>	The list of lineage nodes.
	object	The lineage node.
BranchId	string	The branch ID.	br-7g8h9i0j1k2l
BranchName	string	The branch name.	feature-analytics
BranchDescription	string	The branch description.	Feature branch for analytics
ParentBranchId	string	The parent branch ID.	br-1a2b3c4d5e6f
ParentBranchName	string	The parent branch name.	main
Status	string	The branch status. Valid values: Active Destroying	Active
IsRoot	boolean	Indicates whether the branch is the primary branch.	false
IsAnchor	boolean	Indicates whether the branch is the anchor branch.	true
Depth	integer	The depth relative to the anchor branch. The anchor branch has a depth of 0. Ancestor branches have negative values. Descendant branches have positive values.	0
DirectChildCount	integer	The total number of direct child branches.	3
HasMoreChildren	boolean	Indicates whether more child nodes exist but are not returned.	false
HasMoreAncestors	boolean	Indicates whether more ancestor nodes exist but are not returned.	false
BranchComputeClusterId	string	The compute cluster ID of the branch.	pc-g0lsayq8c5qe
CreateTime	string	The time when the branch was created.	2026-06-10T11:00:00Z
IsDefaultBranch	boolean		false

Examples

Success response

JSON format

{
  "RequestId": "B2C3D4E5-F6A7-8901-BCDE-2345678901BC",
  "TenantId": "t-4b83e0da66674951",
  "ProjectId": "proj-a1b2c3d4e5f6",
  "ProjectName": "analytics-prod",
  "AnchorBranchId": "br-7g8h9i0j1k2l",
  "RootBranchId": "br-root",
  "NodeCount": 6,
  "Items": [
    {
      "BranchId": "br-7g8h9i0j1k2l",
      "BranchName": "feature-analytics",
      "BranchDescription": "Feature branch for analytics",
      "ParentBranchId": "br-1a2b3c4d5e6f",
      "ParentBranchName": "main",
      "Status": "Active",
      "IsRoot": false,
      "IsAnchor": true,
      "Depth": 0,
      "DirectChildCount": 3,
      "HasMoreChildren": false,
      "HasMoreAncestors": false,
      "BranchComputeClusterId": "pc-g0lsayq8c5qe",
      "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.