All Products
Search
Document Center

ApsaraDB for ClickHouse:DeleteSyndb

Last Updated:Nov 12, 2024

Deletes a database used for data synchronization.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DeleteSyndbdelete
  • DBCluster
    acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DbClusterIdstringYes

The cluster ID.

cc-bp158i5wvj436****
SynDbstringYes

The name of the database in the ApsaraDB RDS for MySQL instance. The database is used for data synchronization.

database

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

2C7393F1-5FD1-5CEE-A2EA-270A2CF99693
Statusboolean

Indicates whether the database used for data synchronization was deleted. Valid values:

  • true
  • false
true
ErrorMsgstring
  • If the value true is returned for the Status parameter, the system does not return the ErrorMsg parameter.
  • If the value false is returned for the Status parameter, the system returns the deletion failure cause for the ErrorMsg parameter.
ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n
ErrorCodelong

The error code.

0

Examples

Sample success responses

JSONformat

{
  "RequestId": "2C7393F1-5FD1-5CEE-A2EA-270A2CF99693",
  "Status": true,
  "ErrorMsg": "ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n",
  "ErrorCode": 0
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The DBClusterId provided does not exist in our records.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history