Turn off UDB - StopUDBInstance
Overview
Shut down UDB instance
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required | 
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is StopUDBInstance. | Yes | 
| PublicKey | string | The user’s public key can be obtained from Console  | Yes | 
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes | 
Request Parameters
| Parameter Name | Type | Description Information | Required | 
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes | 
| Zone | string | Availability Zone. See Availability Zone List | No | 
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No | 
| DBId | string | Instance’s Id, this value can be obtained through DescribeUDBInstance | Yes | 
| ForceToKill | boolean | Whether to use force to shut down the DB, the default is false | No | 
Response Field
| Field Name | Type | Description Information | Required | 
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes | 
| Action | string | Operation command name. | Yes | 
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No | 
Example
Request Example
https://api.surfercloud.com/?Action=StopUDBInstance   
&Region=cn-bj2
&DBId=udb-xxxResponse Example
{
  "Action": "StopUDBInstanceResponse",
  "RetCode": 0
}