调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeKmsInstances	要执行的操作，取值：DescribeKmsInstances。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
CurrentPage	Integer	是	0	当前页面
PageSize	Integer	是	1	页面大小
Filters	String	是	[{"Key":"State","Values":["Available"]}]	筛选条件

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Instances	Array of Object	Instance类型的数据	实例信息列表
PageInfo	Object	PageaInfo类型的数据	页面信息

请求示例

POST /?Action=DescribeKmsInstances&Version=2021-02-18 HTTP/1.1
Host: kms.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260506T062714Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260506/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "CurrentPage": 1,
  "PageSize": 10,
  "Filters": ""
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202605061427271551920032189F6B98",
    "Action": "DescribeKmsInstances",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Instances": [
      {
        "InstanceID": "CloudKMSxxxxx",
        "InstanceSpec": "",
        "InstanceUsage": "",
        "InstanceType": "prepaid",
        "InstanceState": "Available",
        "CreateTime": "",
        "ExpiredTime": "",
        "CreatedBy": "user"
      }
    ],
    "PageInfo": {
      "TotalCount": 1,
      "PageSize": 10,
      "CurrentPage": 1,
      "Count": 1
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	InvalidParameter	The request parameter %s is invalid.
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.

最近更新时间：2026.08.14 22:42:28

这个页面对您有帮助吗？

有用

无用

密钥管理系统

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码