调用GetCaCertificate接口查询指定CA证书的详细信息

使用限制

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	GetCaCertificate	系统规定参数。取值：GetCaCertificate。
MqttInstanceId	String	是	post-cn-7mz2d******	CA证书所绑定的实例ID，即云消息队列 MQTT 版的实例ID。
Sn	String	是	007269004887******	待查询CA证书的SN序列号，用于唯一标识一个CA证书。

返回数据


名称	类型	示例值	描述
RequestId	String	020F6A43-19E6-4B6E-B846-44EB31DF****	公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。
Data	Object		证书详细信息。
RegistrationCode	String	13274673-8f90-4630-bea1-9cccb25756ad2089******	CA证书的注册码。
CaName	String	mqtt_ca	CA证书的名称。
Sn	String	00f26900ba87******	CA证书的SN序列号，用于唯一标识一个CA证书。取值范围：不超过128 Byte。
CaContent	String	-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE-----	CA证书内容。说明 \n表示换行。
VerificationContent	String	-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE-----	验证证书内容。说明 \n表示换行。
ValidBegin	String	1654137303000	CA证书生效的起始时间。格式为毫秒级别的Unix时间戳。
ValidEnd	String	1969497303000	CA证书生效的终止时间。格式为毫秒级别的Unix时间戳。
Status	String	1	CA证书的状态。取值如下： 0：表示证书为未激活状态。 1：表示证书为激活状态。说明 CA证书注册后，默认为激活状态。

示例

请求示例

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=GetCaCertificate
&MqttInstanceId=post-cn-7mz2d******
&Sn=007269004887******
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  }
}

错误码


HttpCode	错误码	错误信息	描述
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
500	FindCaBySnError	Failed to find the CA by the SN. Please check sn is valid.	SN不存在

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

控制台操作

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