有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: kms.tencentcloudapi.com 。

用于查询该用户是否已开通KMS服务

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetServiceStatus。
Version String 公共参数,本接口取值:2019-01-18。
Region String 公共参数,详见产品支持的 地域列表

3. 输出参数

参数名称 类型 描述
ServiceEnabled Boolean KMS服务是否开通, true 表示已开通
示例值:1
InvalidType Integer 服务不可用类型: 0-未购买,1-正常, 2-欠费停服, 3-资源释放
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UserLevel Integer 0-普通版,1-旗舰版
示例值:0
ProExpireTime Integer 旗舰版到期时间(Epoch Unix Timestamp)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1603701385
ProRenewFlag Integer 旗舰版是否自动续费:0-不自动续费,1-自动续费
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProResourceId String 旗舰版购买记录的唯一性标识。如果为开通旗舰版,则返回值为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:kms_pro_12345
ExclusiveVSMEnabled Boolean 是否开通 KMS 托管版
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ExclusiveHSMEnabled Boolean 是否开通 KMS 独享版
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
SubscriptionInfo String KMS 订阅信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Prepaid_KMS
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询服务状态

查询服务状态

输入示例

POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetServiceStatus
<公共请求参数>

{}

输出示例

{
    "Response": {
        "ServiceEnabled": true,
        "InvalidType": 1,
        "UserLevel": 0,
        "ProResourceId": "kms_pro_12345",
        "ProRenewFlag": 1,
        "ProExpireTime": 1603701385,
        "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00",
        "ExclusiveHSMEnabled": false,
        "ExclusiveVSMEnabled": false,
        "SubscriptionInfo": "Prepaid_KMS"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。