查询实例规格列表
功能介绍
用户可以调用此接口查询设备接入服务支持的实例规格列表。支持的实例规格请参见产品规格说明。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/iotda-instances/flavors
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。 - 限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。 取值范围：0-500的整数，默认为0。 |
|
limit |
否 |
Integer |
参数说明：分页查询时每页显示的记录数。 取值范围：1-500的整数，默认为500。 |
|
marker |
否 |
String |
上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 |
|
instance_type |
否 |
String |
参数说明：实例类型。 取值范围：
|
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page |
Page object |
查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。 |
|
flavors |
Array of InstanceFlavor objects |
参数说明：设备接入实例规格的详情列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_type |
String |
参数说明：创建的实例类型。实例类型说明参见产品规格说明。 取值范围：
|
|
type |
String |
参数说明：设备接入实例的规格名称。详情请参见产品规格说明中的规格编码。 |
|
status |
String |
参数说明：实例规格的在售状态。 取值范围：
|
|
charge_modes |
Array of strings |
参数说明：实例规格支持的付费方式列表。 取值范围：
|
请求示例
查询实例规格列表。
GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/flavors
响应示例
状态码：200
OK
{
"page" : {
"count" : 1,
"marker" : 1805431584415871305
},
"flavors" : [ {
"instance_type" : "standard"
}, {
"type" : "iotda.standard.s2"
}, {
"status" : "normal"
}, {
"charge_modes" : [ "prePaid", "postPaid" ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
错误码
请参见错误码。
