文档首页/ 设备发放 IoTDP/ API参考/ API/ 接入点管理/ 查询接入点详情
更新时间：2024-08-12 GMT+08:00
查看PDF
分享

查询接入点详情

功能介绍

查询接入点接入信息。

URI

GET /v5/iotps/{project_id}/access-points/{access_point_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

最小长度：1

最大长度：32

access_point_id

是

String

接入点id，用于区分不同的区域。

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

region_id

是

String

区域ID，用于区分不同的区域。

最小长度：1

最大长度：64

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：0

最大长度：65535

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

access_point_id

String

接入点id。

最小长度：1

最大长度：256

access_point_name

String

接入点名称。

最小长度：1

最大长度：256

region_id

String

华为云区域ID。节选自https://developer.huaweicloud.com/endpoint。

最小长度：1

最大长度：128

region_name

String

华为云区域名称。节选自https://developer.huaweicloud.com/endpoint。

最小长度：1

最大长度：128

edition

String

实例版本。Basic：基础版；Enterprise：企业版；Standard：基础版。

最小长度：1

最大长度：256

access_infos

Array of AccessInfo objects

专享实例接入信息

数组长度：0 - 10
表5 AccessInfo

参数

参数类型

描述

protocol

String

接入协议

type

String

接入类型，目前支持应用接入和设备接入

port

Integer

设备/应用接入端口

最小值：0

最大值：65535

public_address

Array of strings

实例的公网接入地址（公网接入地址唯一）

最小长度：0

最大长度：65535

数组长度：0 - 10

domain_name

String

接入域名（接入域名唯一）

请求示例

查询接入点详情

GET https://{endpoint}/v5/iotps/{project_id}/access-points/{access_point_id}?region_id={regionId}

响应示例

状态码： 200

OK

{
  "access_point_id" : "DMP-CNNorth-1-1",
  "access_point_name" : "设备管理-北京一-1",
  "region_id" : "cn-north-1",
  "region_name" : "华北-北京一",
  "edition" : "Standard",
  "access_infos" : [ {
    "protocol" : "HTTPS",
    "type" : "Application",
    "port" : 8743,
    "public_address" : [ "100.0.0.1" ],
    "domain_name" : "iotda-app.cn-north-1.myhuaweicloud.com"
  }, {
    "protocol" : "MQTT",
    "type" : "Device",
    "port" : 1883,
    "public_address" : [ "100.0.0.1" ],
    "domain_name" : "basic-mqtt.cn-north-1.myhuaweicloud.com"
  }, {
    "protocol" : "MQTTS",
    "type" : "Device",
    "port" : 8883,
    "public_address" : [ "100.0.0.1" ],
    "domain_name" : "basic-mqtts.cn-north-1.myhuaweicloud.com"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 接入点管理

相关文档