Updated on 2024-12-02 GMT+08:00

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.

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.

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

applications

Array of ApplicationDTO objects

Resource space list.

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.

app_name

String

Resource space name.

create_time

String

Time when the resource space was created. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

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
  } ]
}

Status Codes

Status Code

Description

200

Successful response

400

Bad Request

401

Unauthorized

403

FORBIDDEN

500

Internal Server Error

Error Codes

See Error Codes.