Endpoint

获取endpoint列表

相对URI HTTP 方式
/v1/endpoint GET

请求参数

名称 类型 是否必选 默认值 说明
order ENUM['desc', 'asc'] N desc 排序的方式,不区分大小写
orderBy String N createTime 另外一个支持排序的字段是name。
pageNo Int N 1 页码
pageSize Int N 50 每页item个数,最大值200
q String N - 模糊查询的内容。目前支持name字段模糊查询

返回参数

名称 类型 含义
accountUuid String 创建者的Uuid
creadteTime String 创建时间
endpointName String endpoint名称
mqttHostname String mqtt协议的url(非加密)
mqttTlsHostname String mqtt协议的url(加密)
uuid String 系统自动生成的一个endpoint的唯一值
websocketHostname String websocket协议的url

请求示例

GET /v1/endpoint HTTP/1.1
host: iot.gz.baidubce.com
authorization: {authorization}
content-type: text/plain;charset=UTF-8

返回示例

HTTP/1.1 200 OK
x-bce-request-id: a9000b0d-c13c-4241-9ee1-0876f750716f
Content-Type: application/json;charset=UTF-8
{
    "totalCount": 2,
    "result": [
        {
            "mqttHostname": "endpoint-1.xxx.iot.baidubce.com:8061",
            "accountUuid": "myacount",
            "hostname": "endpoint-1.xxx.iot.baidubce.com:61614",
            "endpointName": "endpoint-1",
            "mqttTlsHostname": "endpoint-1.xxx.iot.baidubce.com:61614",
            "createTime": "2016-08-31T03:36:24Z",
            "websocketHostname": "endpoint-1.xxx.iot.baidubce.com:8064",
            "uuid": "2013ffab-c17e-4657-839d-941bbe6c6c84"
        },
        {
            "mqttHostname": "endpoint-2.xxx.iot.baidubce.com:8061",
            "accountUuid": "myacount",
            "hostname": "endpoint-2.xxx.iot.baidubce.com:61614",
            "endpointName": "endpoint-2",
            "mqttTlsHostname": "endpoint-2.xxx.iot.baidubce.com:61614",
            "createTime": "2016-08-25T08:43:42Z",
            "websocketHostname": "endpoint-2.xxx.iot.baidubce.com:8064",
            "uuid": "9e65bb32-731b-4b25-982b-13a12a0ff35e"
        }
    ],
    "order": "desc",
    "orderBy": "createtime",
    "pageSize": 50,
    "pageNo": 1
}

获取指定的endpoint信息

相对URI HTTP 方式
/v1/endpoint/{endpointName} GET

请求参数

名称 类型 是否必选 含义
endpointName String Y endpoint的名称

返回参数

名称 类型 含义
accountUuid String 创建者的Uuid
creadteTime String 创建时间
endpointName String endpoint名称
hostname String mqtt连接时所需的host
mqttHostname String mqtt协议的url(非加密)
mqttTlsHostname String mqtt协议的url(加密)
uuid String 系统自动生成的一个endpoint的唯一值
websocketHostname String websocket协议的url

请求示例

GET /v1/endpoint/endpoint-1 HTTP/1.1
host: iot.gz.baidubce.com
authorization: {authorization}
content-type: text/plain;charset=UTF-8

返回示例

HTTP/1.1 200 OK
x-bce-request-id: f494dff9-7ece-43be-a509-b8c1cf56e13f
Content-Type: application/json;charset=UTF-8
{
    "hostname": "endpoint-1.xxx.iot.baidubce.com:61614",
    "mqttHostname": "endpoint-1.xxx.iot.baidubce.com:8061",
    "createTime": "2016-08-31T03:36:24Z",
    "uuid": "2013ffab-c17e-4657-839d-941bbe6c6c84",
    "accountUuid": "mycount",
    "websocketHostname": "endpoint-1.xxx.iot.baidubce.com:8064",
    "mqttTlsHostname": "endpoint-1.xxx.iot.baidubce.com:61614",
    "endpointName": "endpoint-1"
}

创建endpoint

相对URI HTTP 方式
/v1/endpoint POST

请求参数

名称 类型 是否必选 含义
endpointName String Y endpoint的名称

返回参数

名称 类型 含义
accountUuid String 创建者的Uuid
creadteTime String 创建时间
endpointName String endpoint名称
hostname String mqtt连接时所需的host
mqttHostname String mqtt协议的url(非加密)
mqttTlsHostname String mqtt协议的url(加密)
uuid String 系统自动生成的一个endpoint的唯一值
websocketHostname String websocket协议的url

请求示例

POST /v1/endpoint HTTP/1.1
host: iot.gz.baidubce.com
authorization: {authorization}
content-type: text/plain;charset=UTF-8
{
    "endpointName":"endpoint-1"
}

返回示例

HTTP/1.1 201 Created
x-bce-request-id: a80aba01-f81e-4dfc-a57b-76b05a30ee07
Content-Type: application/json;charset=UTF-8
{
    "mqttHostname": "endpoint-1.xxx.iot.baidubce.com:8061",
    "accountUuid": "myaccount",
    "hostname": "endpoint-1.xxx.iot.baidubce.com:61614",
    "endpointName": "endpoint-1",
    "mqttTlsHostname": "endpoint-1.xxx.iot.baidubce.com:61614",
    "createTime": "2016-08-31T03:36:24Z",
    "websocketHostname": "endpoint-1.xxx.iot.baidubce.com:8064",
    "uuid": "2013ffab-c17e-4657-839d-941bbe6c6c84"
}

删除endpoint

相对URI HTTP 方式
/v1/endpoint/{endpointName} DELETE

请求参数

名称 类型 是否必选 含义
endpointName String Y endpoint的名称

返回参数

无特殊返回参数。

请求示例

DELETE /v1/endpoint/endpoint-1 HTTP/1.1
host: iot.gz.baidubce.com
authorization: {authorization}
content-type: text/plain;charset=UTF-8

返回示例

HTTP/1.1 204 No Content
x-bce-request-id: 50f11d37-54ea-44a5-9863-94441906b9bc
Content-Type: application/json;charset=UTF-8