Query the Resource Space List

Function

The resource space corresponds to the original application of the platform. The meaning of the resource space in the platform is the same as that of the application. The only difference lies in the name. This API is used by an application to query the resource space list.

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}/apps

**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. Minimum: 0 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
default_app	No	Boolean	Parameter description: default resource space identifier. If this parameter is not carried, all resource spaces are queried. Options: true: queries the default resource space. false: queries the non-default resource space.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. The token can be obtained by calling the IAM API. Minimum: 0 Maximum: 1024000
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. Minimum: 0 Maximum: 36

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
applications	Array of ApplicationDTO objects	Resource space list. Array Length: 0 - 500

**Table 5** ApplicationDTO
Parameter	Type	Description
app_id	String	Resource space ID, which uniquely identifies a resource space and is allocated by the platform during resource space creation. The resource space corresponds to the original application of the platform. The meaning of the resource space in the platform is the same as that of the application. The only difference lies in the name. Minimum: 1 Maximum: 64
app_name	String	Resource space name. Minimum: 1 Maximum: 64
create_time	String	Time when the resource space was created. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z. Minimum: 1 Maximum: 64
default_app	Boolean	Whether the resource space is the default resource space.

Example Requests

Queries resources in a list.

GET https://{endpoint}/v5/iot/{project_id}/apps

Example Responses

Status code: 200

Successful response

{
  "applications" : [ {
    "app_id" : "0ab87ceecbfc49acbcc8d5acdef3c68c",
    "app_name" : "testApp",
    "create_time" : "20151212T121212Z",
    "default_app" : true
  } ]
}