文档

GetCaCertificate - 获取CA证书详情

更新时间:
一键部署

云消息队列 MQTT 版支持X.509证书认证,客户端可通过设备证书完成接入认证。CA证书用于为客户端签发设备证书,并验证设备证书的正确性。 您可以调用本接口查询指定CA证书的证书内容以及激活状态等详细信息。

接口说明

  • 仅铂金版和专业版实例支持使用 GetCaCertificate 接口。
  • 单用户请求频率限制为 500 次/秒。如有特殊需求,请联系云消息队列 MQTT 版技术支持,钉钉群号:35228338。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
MqttInstanceIdstring

CA 证书所绑定的实例 ID,即云消息队列 MQTT 版的实例 ID。

post-cn-7mz2d******
Snstring

待查询 CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。

007269004887******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

020F6A43-19E6-4B6E-B846-44EB31DF****
Dataobject

证书详细信息。

RegistrationCodestring

CA 证书的注册码。

13274673-8f90-4630-bea1-9cccb25756ad2089******
CaNamestring

CA 证书的名称。

mqtt_ca
Snstring

CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。

取值范围:不超过 128 Byte。

00f26900ba87******
CaContentstring

CA 证书内容。

说明 \n 表示换行。
-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE-----
VerificationContentstring

验证证书内容。

说明 \n 表示换行。
-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE-----
ValidBeginstring

CA 证书生效的起始时间。格式为毫秒级别的 Unix 时间戳。

1654137303000
ValidEndstring

CA 证书生效的终止时间。格式为毫秒级别的 Unix 时间戳。

1969497303000
Statusstring

CA 证书的状态。取值如下:

  • 0:表示证书为未激活状态。

  • 1:表示证书为激活状态。

说明 CA 证书注册后,默认为激活状态。
1

示例

正常返回示例

JSON格式

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Data": {
    "RegistrationCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******",
    "CaName": "mqtt_ca",
    "Sn": "00f26900ba87******",
    "CaContent": "-----BEGIN CERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END CERTIFICATE-----",
    "VerificationContent": "-----BEGIN CERTIFICATE-----\\nMIID/DCCAu+Y5sRMpp9tnd+4s******\\n-----END CERTIFICATE-----",
    "ValidBegin": "1654137303000",
    "ValidEnd": "1969497303000",
    "Status": "1"
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterFieldCheckFailedFailed to validate the parameters. The parameters may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
500FindCaBySnErrorFailed to find the CA by the SN. Please check sn is valid.SN不存在
500MqttOwnerCheckErrorFailed to validate the instance permission实例权限校验失败
500MqttInstanceNotFoundSpecified instance is not found实例不存在

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-24OpenAPI 错误码发生变更查看变更详情

控制台操作

除了调用 GetCaCertificate 接口,您还可以通过微消息队列 MQTT 版控制台查看指定的 CA 证书。具体操作,请参见 CA 证书管理