查询实例详情
功能介绍
查询设备接入实例详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/iot/{project_id}/iotda-instances/{instance_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
|
instance_id |
是 |
String |
参数说明：实例ID。 取值范围：长度不超过36，由小写字母[a-f]、数字、连接符（-）的组成。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_type |
String |
参数说明：实例类型。 取值范围：
|
|
instance_id |
String |
参数说明：实例ID。 取值范围：长度不超过36，由小写字母[a-f]、数字、连接符（-）的组成。 |
|
charge_mode |
String |
参数说明：实例的付费方式。 取值范围：
|
|
name |
String |
参数说明：实例名称。 取值范围：由中文字符，英文字母、数字及“_”、“-”组成，且长度为[1-64]个字符。 |
|
flavor |
Flavor object |
参数说明：设备接入实例的规格参数。 |
|
status |
String |
参数说明：实例状态。 取值范围：
|
|
region_id |
String |
参数说明：实例所属region。 |
|
description |
String |
参数说明：设备接入实例的描述信息。 取值范围：长度不超过256，只允许中文、字母、数字、以及_，,.。、&-等字符的组合。 |
|
access_infos |
Array of AccessInfo objects |
参数说明：设备接入实例的接入信息。 |
|
create_time |
String |
参数说明：实例的创建时间。时间格式例如：2023-01-28T06:57:52Z。 |
|
update_time |
String |
参数说明：实例的最近一次更新的时间。时间格式例如：2023-01-28T06:57:52Z。 |
|
enterprise_project_id |
String |
参数说明：企业项目Id。 |
|
tags |
Array of Tag objects |
参数说明: 设备接入实例的标签信息。如果实例有标签，则会有该字段，否则该字段为空。 |
|
order_id |
String |
参数说明：订单号，仅包年包月实例返回该参数。 |
|
operate_window |
OperateWindow object |
实例维护时间窗，用户在变更实例规格时，可以指定在该时间窗内进行变更。 |
|
additional_params |
AdditionalParamsResp object |
企业版附加参数信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数说明：待创建设备接入实例的规格名称。详情请参见产品规格说明中的规格编码。 |
|
size |
Integer |
参数说明：待创建设备接入标准版实例的单元数量。详情请参见产品规格说明。当instance_type是standard时，该参数必填。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数说明：接入地址的类型，如应用接入的HTTPS协议的取值为：APP_HTTPS，设备接入的MQTT协议的取值为：DEVICE_MQTT。 取值范围：
|
|
port |
Integer |
参数说明：实例的应用/设备的安全接入端口。 |
|
non_tls_port |
Integer |
参数说明：实例的应用/设备的非安全接入端口。返回null时表示该类型的接入地址不支持非安全端口接入。 |
|
websocket_port |
Integer |
参数说明：基于WebSocket的MQTT接入端口。返回null时表示该类型的接入地址不支持WebSocket端口接入。 |
|
domain_name |
String |
参数说明：实例的接入域名。 |
|
private_addresses |
Array of strings |
参数说明：实例的私网接入地址列表。 |
|
public_address |
Array of strings |
参数说明：实例的公网接入地址。 |
|
ipv6_address |
Array of strings |
参数说明：实例的ipv6接入地址列表。 |
|
ip_whitelist |
IPWhiteList object |
IP白名单 约束：只有企业版实例的APP_HTTPS协议支持配置IP白名单。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
enable |
Boolean |
参数说明：启用Ip白名单访问控制。 |
|
allow_list |
Array of IpAllowList objects |
参数说明：允许访问企业版实例的IP地址列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数说明：标签键，标签的键可用字母(包含中文)、数字、空格和以下字符：下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@，首尾不能有空格字符。 |
|
value |
String |
参数说明：标签值，可为空字符串和null，标签的值可用字母(包含中文)、数字、空格和以下字符：下划线(_)点(.)冒号(:)等号(=)加号(+)中划线(-)以及@。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
start_time |
String |
参数说明：变更时间窗开始时间，UTC时间，格式为："HH:mm" |
|
end_time |
String |
参数说明：变更时间窗结束时间，UTC时间，格式为："HH:mm" |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
vpc_id |
String |
参数说明：企业版实例的VPCID。 |
|
subnet_id |
String |
参数说明：企业版实例的子网ID。 |
|
security_group_id |
String |
参数说明：企业版实例的安全组ID。 |
|
ciphering_algorithm |
String |
参数说明：实例支持的加密算法。 取值范围：
|
|
forwarding_info |
ForwardingInfo object |
企业版实例的SNAT配置信息。 |
请求示例
查询指定实例。
GET https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}响应示例
状态码： 200
OK
{
"instance_type" : "standard",
"instance_id" : "8561675c-d8a3-4956-9884-9cf9cbdd3134",
"charge_mode" : "prePaid",
"name" : "iotda_instance",
"flavor" : {
"type" : "iotda.standard.s1",
"size" : 1
},
"status" : "ACTIVE",
"region_id" : "cn-north-4",
"create_time" : "2023-01-28T06:57:52Z",
"update_time" : "2023-01-28T06:58:52Z",
"description" : "IoTDA instance for production.",
"access_infos" : [ {
"type" : "APP_AMQP",
"port" : 5671,
"non_tls_port" : null,
"websocket_port" : null,
"domain_name" : "example.myhuaweicloud.com",
"public_address" : [ ],
"ipv6_address" : [ ],
"ip_whitelist" : null
}, {
"type" : "APP_HTTPS",
"port" : 443,
"non_tls_port" : null,
"websocket_port" : null,
"domain_name" : "example1.myhuaweicloud.com",
"public_address" : [ ],
"ipv6_address" : [ ],
"ip_whitelist" : null
}, {
"type" : "DEVICE_MQTT",
"port" : 8883,
"non_tls_port" : 1883,
"websocket_port" : 443,
"domain_name" : "example2.myhuaweicloud.com",
"public_address" : [ ],
"ipv6_address" : [ ],
"ip_whitelist" : null
}, {
"type" : "DEVICE_COAP",
"port" : 5684,
"non_tls_port" : 5683,
"websocket_port" : null,
"domain_name" : "example3.myhuaweicloud.com",
"public_address" : [ ],
"ipv6_address" : [ ],
"ip_whitelist" : null
} ],
"enterprise_project_id" : "d22e47e9-cfad-4254-8a29-d2a56a07681d",
"tags" : [ {
"key" : "testTagName",
"value" : "testTagValue"
} ],
"order_id" : "CS22121614500ABCD",
"operate_window" : {
"start_time" : "22:00",
"end_time" : "24:00"
},
"additional_params" : null
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
