CreateAgenticDBBranch

Updated at:
Copy as MD

Creates an AgenticDB branch.

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 ID of the tenant to which the branch belongs.

t-4b83e0da66674951

ProjectId

string

Yes

The ID of the project to which the branch belongs.

proj-a1b2c3d4e5f6

BranchName

string

Yes

The name of the branch.

feature-analytics

ParentBranchId

string

No

The ID of the parent branch. If this parameter is not specified, the branch is derived from the main branch by default.

br-1a2b3c4d5e6f

Description

string

No

The description of the branch.

Feature branch for analytics

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

A1B2C3D4-E5F6-7890-ABCD-1234567890AB

DBClusterId

string

The AgenticDB cluster ID.

pagc-bp1abcdef1234567

BranchId

string

The branch ID.

br-7g8h9i0j1k2l

BranchName

string

The name of the branch.

feature-analytics

ProjectId

string

The ID of the project to which the branch belongs.

proj-a1b2c3d4e5f6

ProjectName

string

The name of the project to which the branch belongs.

analytics-prod

ParentBranchId

string

The ID of the parent branch.

br-1a2b3c4d5e6f

ParentBranchName

string

The name of the parent branch.

main

BranchComputeClusterId

string

The ID of the compute cluster associated with the branch.

pc-g0lsayq8c5qe

Status

string

The status of the branch.

Active

Examples

Success response

JSON format

{
  "RequestId": "A1B2C3D4-E5F6-7890-ABCD-1234567890AB",
  "DBClusterId": "pagc-bp1abcdef1234567",
  "BranchId": "br-7g8h9i0j1k2l",
  "BranchName": "feature-analytics",
  "ProjectId": "proj-a1b2c3d4e5f6",
  "ProjectName": "analytics-prod",
  "ParentBranchId": "br-1a2b3c4d5e6f",
  "ParentBranchName": "main",
  "BranchComputeClusterId": "pc-g0lsayq8c5qe",
  "Status": "Active"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.