Query Device Proxy List

Function

This API is used by an application to query the device proxy list on 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.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
app_id	No	String	Parameter description: resource space ID. This parameter is optional. If you have multiple resource spaces, you can specify this parameter to query the device proxy list in the specified resource space. If this parameter is not carried, device proxies in all resource spaces are queried. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
proxy_name	No	String	Parameter description: device proxy name. Value: The value can contain a maximum of 64 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed. Minimum: 1 Maximum: 64
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. Minimum: 1 Maximum: 50 Default: 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: a string of 24 hexadecimal characters. The default value is ffffffffffffffffffffffff. Default: 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. Minimum: 0 Maximum: 500 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API 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_proxies	Array of QueryDeviceProxySimplify objects	Proxy device list.
page	Page object	Pagination information of the query results.

**Table 5** QueryDeviceProxySimplify
Parameter	Type	Description
proxy_id	String	Parameter description: device proxy ID, which uniquely identifies a proxy rule.
proxy_name	String	Parameter description: device proxy name.
effective_time_range	EffectiveTimeRangeResponseDTO object	Parameter Description: rule validity period.
app_id	String	Parameter description: resource space ID.

**Table 6** EffectiveTimeRangeResponseDTO
Parameter	Type	Description
start_time	String	Time when the device proxy starts to take effect. Format (UTC time): yyyyMMdd'T'HHmmss'Z'.
end_time	String	Time when the device proxy expires. The value must be later than the value of start_time. Format (UTC time): yyyyMMdd'T'HHmmss'Z'.

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

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

Example Responses

Status code: 200

{
  "device_proxies" : [ {
    "proxy_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
    "proxy_name" : "testProxyName",
    "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
    "effective_time_range" : {
      "start_time" : "20200812T121212Z",
      "end_time" : "20210812T121212Z"
    }
  } ],
  "page" : {
    "count" : 1,
    "marker" : "66178add3b98944277731d0a"
  }
}