ListCaCertificate
调用ListCaCertificate接口分页查询指定实例下所有注册的CA证书。
使用限制
-
仅铂金版和专业版实例支持使用ListCaCertificate接口。
-
单用户请求频率限制为500次/秒。如有特殊需求,请联系微消息队列MQTT版技术支持,钉钉群号:35228338。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListCaCertificate | 系统规定参数。取值:ListCaCertificate。 |
MqttInstanceId | String | 是 | post-cn-7mz2d****** | 云消息队列 MQTT 版的实例ID,表示需要查看哪个实例下的所有CA证书。 |
PageNo | String | 是 | 2 | 查询第几页的返回结果。起始页从第1页开始计算。 |
PageSize | String | 是 | 10 | 每页最多显示几条查询记录。 取值范围:1~100。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 020F6A43-19E6-4B6E-B846-44EB31DF**** | 公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
Data | Object | 查询结果。 |
|
Total | Integer | 1 | 查询结果最大页数。 |
PageNo | Integer | 2 | 当前返回的查询记录是第几页。 |
PageSize | Integer | 10 | 每页显示的最大结果数。 |
CaCertificateVOS | Array of CaCertificateVO | CA证书的详细信息。 |
|
RegistrationCode | String | 13274673-8f90-4630-bea1-9cccb25756ad2089****** | CA证书的注册码。 |
CaName | String | mqtt_ca | CA证书的名称。 |
Sn | String | 007269004887****** | CA证书的SN序列号。 |
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证书的状态。取值如下:
说明
CA证书注册后,默认为激活状态。 |
示例
请求示例
http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=ListCaCertificate
&MqttInstanceId=post-cn-7mz2d******
&PageNo=2
&PageSize=5
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListCaCertificateResponse>
<RequestId>020F6A43-19E6-4B6E-B846-44EB31DF****</RequestId>
<Data>
<Total>1</Total>
<PageNo>2</PageNo>
<PageSize>10</PageSize>
<CaCertificateVOS>
<RegistrationCode>13274673-8f90-4630-bea1-9cccb25756ad2089******</RegistrationCode>
<CaName>mqtt_ca</CaName>
<Sn>007269004887******</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>
</CaCertificateVOS>
</Data>
</ListCaCertificateResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data" : {
"Total" : 1,
"PageNo" : 2,
"PageSize" : 10,
"CaCertificateVOS" : [ {
"RegistrationCode" : "13274673-8f90-4630-bea1-9cccb25756ad2089******",
"CaName" : "mqtt_ca",
"Sn" : "007269004887******",
"CaContent" : "-----BEGIN CERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END CERTIFICATE-----",
"VerificationContent" : "-----BEGIN CERTIFICATE-----\\nMIID/DCCAu+Y5sRMpp9tnd+4s******\\n-----END CERTIFICATE-----",
"ValidBegin" : "1654137303000",
"ValidEnd" : "1969497303000",
"Status" : "1"
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 参数校验失败,可能缺失或者传入值非法。 |
访问错误中心查看更多错误码。
控制台操作
除了调用ListCaCertificate接口,您还可以通过微消息队列MQTT版控制台查看指定实例下所有已注册的CA证书。具体操作,请参见CA证书管理。