查询实例状态
最近更新时间: 2026-09-17 00:02:56
1. 接口描述
接口请求域名: tcr.api3.fincloud.tencent.cn。
查询实例当前状态以及过程信息
默认接口请求频率限制:20次/秒。
接口更新时间:2023-11-28 15:28:45。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeInstanceStatus |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-09-24 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| RegistryIds | 是 | 否 | Array of String | 实例ID的数组 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RegistryStatusSet | Array of RegistryStatus | 实例的状态列表 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InternalError.DbError | 数据库错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
5. 示例
示例1 查询实例状态
输入示例
https://tcr.api3.fincloud.tencent.cn/?Action=DescribeInstanceStatus
&RegistryIds.0=tcr-ak9876
&<公共请求参数>
输出示例
{
"Response": {
"RegistryStatusSet": [{
"Status": "Runing",
"Conditons": [],
"RegistryId": "tcr-ak9876"}],
"RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
}
}