Query Device Certificate List

Function

This API is used by an application to query the device certificate list in the IoT platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:devicecertificates:queryList	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

GET /v5/iot/{project_id}/device-certificates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
common_name	No	String	Parameter description: common name of a certificate. Fuzzy search by prefix is supported. Value: The value can contain a maximum of 32 characters, including letters, digits, and special characters (_-?'#().,&%@!*).
fingerprint	No	String	Parameter description: certificate fingerprint. Value: The value must contain 40 or 64 hexadecimal characters.
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value must contain 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. The value is an integer ranging from 0 to 500. The default value is 0. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. Obtain the token by calling the IAM API for obtaining a user token through password authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
device_certificates	Array of DeviceCertificateSimple objects	Device certificate list.
page	Page object	Pagination information of the query results.

**Table 5** DeviceCertificateSimple
Parameter	Type	Description
certificate_id	String	Parameter description: a unique ID that identifies a device certificate.
common_name	String	Parameter description: common name of the device certificate.
expiry_date	String	Parameter description: expiration time of the device certificate.
fingerprint	String	Parameter description: SHA-256 fingerprint of the device certificate.
status	String	Parameter description: device certificate status. ACTIVE (default) INACTIVE

**Table 6** Page
Parameter	Type	Description
count	Long	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

GET https://{endpoint}/v5/iot/{project_id}/device-certificates

Example Responses

Status code: 200

{
  "device_certificates" : [ {
    "certificate_id" : "75a0c144-7c3c-4dac-9fd6-8c63dd9e969d",
    "common_name" : "iot_device",
    "expiry_date" : "20230810T070547Z",
    "fingerprint" : "4838A6CCBC582DC22647005FBDFB2B110632DDDA5FCFB55B3307C122EFC2D1BA",
    "status" : "ACTIVE"
  } ],
  "page" : {
    "count" : 1,
    "marker" : "66178add3b98944277731d0a"
  }
}