Principal
所有文档

          物接入 IoT Hub

          Principal

          获取principal列表

          相对URI HTTP 方式
          /v1/endpoint/{endpointName}/principal?thingName={thingName} GET

          请求参数

          名称 类型 是否必选 默认值 说明
          endpointName String Y - endpoint的名称
          thingName String N - principal所属的thing名称,可选参数,可查询与指定thing绑定的principal
          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字段模糊查询

          返回参数

          名称 类型 含义
          principalName String principal名称
          endpointName String 所属的Endpoint名称
          createTime String 创建时间

          请求示例

          GET /v1/endpoint/endpoint-1/principal 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: e20e06f3-d0da-4668-ac67-ce62047e3beb
          Content-Type: application/json;charset=UTF-8
          {
              "totalCount": 1,
              "result": [
                  {
                      "principalName": "principal-1",
                      "endpointName": "endpoint-1",
                      "createTime": "2016-08-31T06:09:29Z"
                  }
              ],
              "order": "desc",
              "orderBy": "createtime",
              "pageSize": 50,
              "pageNo": 1
          }

          获取指定的principal信息

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

          请求参数

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

          返回参数

          名称 类型 含义
          principalName String principal名称
          endpointName String 所属的Endpoint名称
          createTime String 创建时间

          请求示例

          GET /v1/endpoint/endpoint-1/principal/principal-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: e294804d-d946-4a89-a671-317d4eaeae6c
          Content-Type: application/json;charset=UTF-8
          {
              "principalName": "principal-1",
              "endpointName": "endpoint-1",
              "createTime": "2016-08-31T06:09:29Z"
          }

          创建principal

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

          请求参数

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

          返回参数

          名称 类型 含义
          principalName String principal名称
          endpointName String 所属的Endpoint
          password String principal密钥
          privateKey String PEM格式的私钥
          cert String PEM格式的证书
          createTime String 创建时间

          请求示例

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

          返回示例

          HTTP/1.1 201 Created
          x-bce-request-id: 9f913092-f0ef-4018-9055-e02f2db4464f
          Content-Type: application/json;charset=UTF-8
          {
              "principalName": "principal-1",
              "endpointName": "endpoint-1",
              "privateKey": "-----BEGIN RSA PRIVATE KEY-----    \r\nMIICWwIBAAKBgQC98S6X8nCB/3AdsK3uXpx7YfCP/……-----END RSA PRIVATE KEY-----\r\n",
              "password": "XM5kW9bZhRTWc/mag8TYZuVlUfdaLUju+kdwh9dfGKo=",
              "createTime": "2016-08-31T06:09:28Z",
              "cert": "-----BEGIN CERTIFICATE-----    \r\nMIIC4zCCAcsCCQC3v0MerfCjdjANBgkqhkiG9w0BAQsFADBqMQswCQYDVQQGEwJD\r    ……+LIJhgeE/2s67BdGEGHOjWhtdi1KT1    Og1A/t\r\nqhn/EexhgR6CgLNmxV4+tPN2CrJtL6c6j2moVq5dtP0g6VWk0bq2wMB2Ja2An1zz\r\nc1I0dXSIo1qwOmwBYBPBmVQlQSllKaA=\r\n-----END CERTIFICATE-----\r\n"
          }

          重新生成密钥

          相对URI HTTP 方式
          /v1/endpoint/{endpointName}/principal/{principalName} POST

          请求参数

          名称 类型 是否必选 含义
          endpointName String Y endpoint名称
          principalName String Y principal名称
          target String N 可选项:all,password,cert

          返回参数

          名称 类型 含义
          principalName String principal名称
          endpointName String 所属的Endpoint
          password String principal密钥
          privateKey String PEM格式的私钥
          cert String PEM格式的证书

          请求示例

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

          响应示例

          HTTP/1.1 200 Created
          x-bce-request-id: 9f913092-f0ef-4018-9055-e02f2db4464f
          Content-Type: application/json;charset=UTF-8
          {
              "principalName": "principal-1",
              "endpointName": "endpoint-1",
              "privateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nMIICXgIBAAKBgQCuoZEOP+3c/ur8x0bVzVFHBApx2gCi1X+r/q/5B4EDDp33+wZe\r\n+tJ6MfbkgZbvNxEZ....\n88WhhVIDdnneYTe8wIJ1PVBZG0kv6c9wCRg6QGHUpMpUrw==\r\n-----END RSA PRIVATE KEY-----\r\n",
              "password": "pNO4VRhK2h0BJpp3ayyHuy+dY0t7HFAlW1rtnoRJ76g=",
              "cert": "-----BEGIN CERTIFICATE-----\r\nMIIC4zCCAcsCCQDHBYyIQT8cajANBgkqhkiG9w0BAQsFADBqMQswCQYDVQQGEwJD\r....\nrSe0T4miCW7kXLNwqNW7SwB7NZ4GgG8nsKllFSfx2hK7a41vvEl8+xiszhJlBHhF\r\nAGhpPDgBUcgy77G4W3+kg0XRdVm77vI=\r\n-----END CERTIFICATE-----\r\n"
          }

          删除principal

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

          请求参数

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

          返回参数

          无特殊返回参数。

          请求示例

          DELETE /v1/endpoint/endpoint-1/principal/principal-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: 7dda6e6a-08cd-4301-90df-a5c0f7a502e8
          Content-Type: application/json;charset=UTF-8
          上一篇
          Thing
          下一篇
          Policy