一、1. 接口描述
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：GetServiceStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| ServiceEnabled | Boolean | true表示服务已开通，false 表示服务尚未开通。示例值：true |
| InvalidType | Integer | 服务不可用类型： 0-未购买，1-正常， 2-欠费停服， 3-资源释放。示例值：1 |
| AccessKeyEscrowEnabled | Boolean | true表示用户已经可以使用密钥安全托管功能，false表示用户暂时不能使用密钥安全托管功能。示例值：true |
| ExpireTime | String | 过期时间示例值：2024-09-10 10:19:21 |
| QPSLimit | Integer | 计算性能限制示例值：500 |
| SecretLimit | Integer | 凭据个数限制示例值：1000 |
| PayModel | String | 付费模式示例值：Postpaid_SSM |
| RenewFlag | Integer | 自动续费标识，0:手动续费 1:自动续费 2:到期不续示例值：1 |
| ResourceId | String | 资源id示例值：SSM-Prepaid-co3j6qlg |
| TotalCount | Integer | 已托管凭据个数示例值：10 |
| ResourceRegion | Integer | 预付费购买 SSM 资源的地域 ID示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 获取 SSM 服务开通状态
获取 SSM 服务开通状态
五、输入示例
POST / HTTP/1.1
Host: ssm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetServiceStatus
<公共请求参数>
{}
六、输出示例
{
"Response": {
"AccessKeyEscrowEnabled": true,
"ExpireTime": "2027-02-01 19:30:31",
"InvalidType": 1,
"PayModel": "Prepaid_SSM",
"QPSLimit": 1000,
"RenewFlag": 1,
"RequestId": "9a405d03-5cff-452b-bf0a-8576e2c1e1be",
"ResourceId": "SSM-Prepaid-rt64sffg",
"SecretLimit": 5900,
"ServiceEnabled": true,
"TotalCount": 5541
}
}
七、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
八、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
九、SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
十、命令行工具
·Tencent Cloud CLI 3.0
十一、6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |