DeleteAgenticDBBranch

Updated at:

Deletes an AgenticDB branch.

Operation description

Before you begin: Call CreateDBCluster and set AgenticDbType to dedicated to create an AgenticDB cluster and obtain the DBClusterId with the pagc- prefix. Call CreateAgenticDBTenant to create a tenant. Call CreateAgenticDBProject to create a project and obtain the TenantId and ProjectId. Call CreateAgenticDBBranch to create a branch and obtain the BranchId. Finally, call this operation to delete the 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

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:DeleteAgenticDBBranch

delete

*DBCluster

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

None 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. You can obtain this ID by calling CreateDBCluster and setting AgenticDbType to dedicated. The ID starts with pagc-.

pagc-bp1abcdef1234567

TenantId

string

Yes

The tenant ID. You can obtain this ID by calling CreateAgenticDBTenant or CreateAgenticDBProject.

t-4b83e0da66674951

ProjectId

string

Yes

The project ID. You can obtain this ID by calling CreateAgenticDBProject.

proj-a1b2c3d4e5f6

BranchId

string

Yes

The branch ID. You can obtain this ID by calling CreateAgenticDBBranch.

br-7g8h9i0j1k2l

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

D4E5F6A7-B8C9-0123-DEFA-456789012DEF

Examples

Success response

JSON format

{
  "RequestId": "D4E5F6A7-B8C9-0123-DEFA-456789012DEF"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.