获取云数据库状态 - DescribeUDBInstanceState

简介

获取UDB实例状态

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `DescribeUDBInstanceState`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
Zone	string	可用区。参见可用区列表	No
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	No
DBId	string	实例的Id,该值可以通过DescribeUDBInstance获取	Yes

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
State	string	DB状态标记 Init：初始化中；Fail：安装失败； Starting：启动中； Running ：运行；Shutdown：关闭中； Shutoff ：已关闭； Delete：已删除； Upgrading：升级中； Promoting：提升为独库进行中； Recovering：恢复中； Recover fail：恢复失败。	No


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


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