Obtain the Domain Configuration List

Function

This API is used by an application to obtain the domain configuration list on the 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:domainconfiguration:queryList	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

GET /v5/iot/{project_id}/domain-configurations

**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
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
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
domain_configurations	Array of DomainConfigurationDTO objects	Parameter description: domain configuration list.
page	Page object	Pagination information of the query results.

**Table 5** DomainConfigurationDTO
Parameter	Type	Description
configuration_id	String	Unique ID of the domain configuration.
domain_name	String	Parameter description: custom domain name.
access_protocol	String	Parameter description: application protocol scenario. Currently, only MQTTS device access is supported.
server_certificate_id	String	Parameter description: custom server certificate ID.
server_certificate_config	ServerCertificateConfig object	Parameter description: server certificate configuration.

**Table 6** ServerCertificateConfig
Parameter	Type	Description
ocsp_stapling_enable	Boolean	Description: whether to enable OCSP stapling on the server. Value: true (enabled) or false (disabled). The default value is false.
ocsp_server_ca_id	String	Description: ID of the CA certificate on the OCSP server. This parameter can be configured only when the OCSP server uses HTTPS. Value: The value can contain up to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
ocsp_ssl_enable	Boolean	Description: whether to enable SSL for accessing the OCSP server. Value: true (enabled) or false (disabled). The default value is true.

**Table 7** 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

Obtains the domain configuration list.

GET https://{endpoint}/v5/iot/{project_id}/domain-configurations

Example Responses

Status code: 200

{
  "domain_configurations" : [ {
    "configuration_id" : "5c90fa7d3c4e4405e8525079",
    "domain_name" : "iotda-device.cn-north-4.myhuaweicloud.com",
    "access_protocol" : "Device-MQTTS",
    "server_certificate_id" : "5c90fa7d3c4e4405e8525079",
    "server_certificate_config" : {
      "ocsp_stapling_enable" : false,
      "ocsp_server_ca_id" : "5c90fa7d3c4e4405e8525079",
      "ocsp_ssl_enable" : true
    }
  } ],
  "page" : {
    "count" : 1,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}