Querying Instance Specifications

Function

This API is used to query the instance specifications supported by IoTDA. For details about the supported instance specifications, see Specifications.

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, no identity policy-based permission required for calling this API.

URI

GET /v5/iot/{project_id}/iotda-instances/flavors

**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
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: an integer ranging from 0 to 500. The default value is 0.
limit	No	Integer	Parameter description: number of records to display on each page. Value: an integer ranging from 1 to 500. The default value is 500.
marker	No	String	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.
instance_type	No	String	Parameter description: instance type. Range: standard enterprise

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
page	Page object	Structure of the batch query result pagination. It defines page numbers, the number of records on each page, the total number of records, and ID of the last record on the current page.
flavors	Array of InstanceFlavor objects	Parameter description: details about IoTDA instance specifications.

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

**Table 5** InstanceFlavor
Parameter	Type	Description
instance_type	String	Parameter description: type of the instance to be created. For details about instance types, see Specifications. Range: standard enterprise
type	String	Parameter description: name of the IoTDA instance specifications. For details, see Specifications.
status	String	Parameter description: on-sale status of the instance specifications. Range: normal: on sale. sellout: sold out.
charge_modes	Array of strings	Parameter description: payment modes supported by the instance specifications. Range: prePaid: yearly/monthly postPaid: pay-per-use

Example Requests

Queries the instance specifications list.

GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/flavors

Example Responses

Status code: 200

{
  "page" : {
    "count" : 1,
    "marker" : 1805431584415871305
  },
  "flavors" : [ {
    "instance_type" : "standard"
  }, {
    "type" : "iotda.standard.s2"
  }, {
    "status" : "normal"
  }, {
    "charge_modes" : [ "prePaid", "postPaid" ]
  } ]
}