查询实例状态
功能介绍
查询实例状态
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/instances/{id}/status
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
id |
是 |
String |
参数解释: 实例ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token,如果您使用的Token方式,此参数为必填,请填写Token的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
state |
String |
参数解释: 实例状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
error |
ErrorStatus object |
参数解释: 失败时返回的错误对象 约束限制: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_type |
String |
参数解释: 错误类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:429
参数 |
参数类型 |
描述 |
---|---|---|
- |
String |
- |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
error_msg |
String |
参数解释: 错误描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询实例状态
GET https://{endpoint}/v1/{project_id}/instances/{id}/status
响应示例
状态码:200
实例状态
{ "status" : "stopped" }
状态码
状态码 |
描述 |
---|---|
200 |
实例状态 |
401 |
请求未鉴权 |
429 |
请求过载 |
500 |
服务端内部错误 |
错误码
请参见错误码。