Get UDB status - DescribeUDBInstanceState

Overview

Get UDB Instance Status

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDBInstanceState`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

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

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
State	string	DB Status Tags Init: Initializing; Fail: Installation Failed; Starting: Starting up; Running: Running; Shutdown: Shutting down; Shutoff: Shut off; Delete: Deleted; Upgrading: Upgrading; Promoting: Promoting to standalone database in progress; Recovering: Recovering; Recover fail: Recovery failed.	No

https://api.surfercloud.com/?Action=DescribeUDBInstanceState
&Region=cn-bj2
&DBId=udb-xxxxx

{
  "Action": "DescribeUDBInstanceStateResponse",
  "RetCode": 0,
  "State": "Running"
}