All Products
Search
Document Center

PolarDB:DeleteContextDB

Last Updated:Sep 10, 2026

Deletes a ContextDB-X.

Operation description

Deletes the custom endpoint of a specified database instance and disables access through the domain name.

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 parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region in which the instance resides.

cn-hangzhou

DBInstanceName

string

Yes

The instance ID.

pxc-********

Response elements

Element

Type

Description

Example

object

RequestId

string

Id of the request

D6A4256F-7B83-5BD7-9AC0-72E1FAC05330

Data

object

The parameter details.

TaskId

integer

The task ID.

2209883

DBInstanceName

string

The instance name.

pxc-unrf5ssig0ecg8

ContextDBInstanceName

string

The context service instance name.

pxt-*********

ServiceReplicaSetName

string

The context service service instance name.

pxt-*********-s

DashboardReplicaSetName

string

The context service dashboard instance name.

pxt-*********-d

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The authentication action.

xxx

AuthPrincipalType

string

The type of the authentication principal.

222

AuthPrincipalOwnerId

string

The owner ID of the authentication principal.

111

AuthPrincipalDisplayName

string

The display name of the authentication principal.

xxx

PolicyType

string

The policy type.

PRIORITY

NoPermissionType

string

The type of the permission denial.

ImplicitDeny

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "D6A4256F-7B83-5BD7-9AC0-72E1FAC05330",
  "Data": {
    "TaskId": 2209883,
    "DBInstanceName": "pxc-unrf5ssig0ecg8",
    "ContextDBInstanceName": "pxt-*********",
    "ServiceReplicaSetName": "pxt-*********-s",
    "DashboardReplicaSetName": "pxt-*********-d"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.