查询设备证书 - ShowDeviceCertificate
功能介绍
应用服务器可调用此接口在物联网平台更新一个设备证书状态。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
iotda:devicecertificates:query
Read
instance *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
-
-
URI
GET /v5/iot/{project_id}/device-certificates/{certificate_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
|
certificate_id |
是 |
String |
参数说明：设备证书ID，用于唯一标识一个设备证书。在注册设备证书时由物联网平台分配获得。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
certificate_id |
String |
参数说明：设备证书ID。用来唯一标识一个设备证书 |
|
common_name |
String |
参数说明：设备证书通用名称。 |
|
expiry_date |
String |
参数说明：设备证书过期时间。 |
|
fingerprint |
String |
参数说明：设备证书SHA256指纹。 |
|
status |
String |
参数说明：设备证书状态，默认状态为激活
|
|
certificate_pem |
String |
参数说明：设备证书PEM格式内容。 |
请求示例
GET https://{endpoint}/v5/iot/{project_id}/device-certificates/{certificate_id}
响应示例
状态码：200
OK
{
"certificate_id" : "75a0c144-7c3c-4dac-9fd6-8c63dd9e969d",
"common_name" : "iot_device",
"expiry_date" : "20230810T070547Z",
"fingerprint" : "4838A6CCBC582DC22647005FBDFB2B110632DDDA5FCFB55B3307C122EFC2D1BA",
"status" : "ACTIVE",
"certificate_pem" : "-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
404 |
Not Found |
错误码
请参见错误码。
