华为云用户手册

URI GET /v5/iotps/{project_id}/products 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由 物联网平台 返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24 region_id 是 String 区域ID，用于区分不同的区域。 最小长度：1 最大长度：64 access_point_id 是 String 接入点id，用于区分不同的区域。 最小长度：1 最大长度：64 app_id 否 String 应用id。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的产品列表，不携带该参数则会查询该用户下所有产品列表。 最小长度：1 最大长度：64 access_key 否 String 鉴权接入名。 最小长度：0 最大长度：256

响应示例 状态码： 200 Successful response { "products" : [ { "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "device_type" : "Thermometer", "model" : "123", "protocol_type" : "LWM2M", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei" } ], "page" : { "count" : 100, "marker" : "5c8f3d2d3df1f10d803adbda" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 products Array of ProductSummary objects 产品信息列表。 数组长度：0 - 100 page Page object 查询结果的分页信息。 表5 ProductSummary 参数 参数类型 描述 product_id String 产品ID，用于唯一标识一个产品模型，在物联网平台的SP Portal上导入产品模型后由平台分配获得。 最小长度：0 最大长度：64 name String 产品名称。 最小长度：0 最大长度：255 device_type String 设备类型。 最小长度：0 最大长度：255 model String 设备型号。 最小长度：0 最大长度：255 protocol_type String 设备使用的协议类型。 最小长度：0 最大长度：20 industry String 设备所属行业。 最小长度：0 最大长度：255 description String 产品的描述信息。 最小长度：0 最大长度：2048 表6 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数，最大返回1000条记录。 最小值：0 最大值：1000 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 最小长度：0 最大长度：64

请求示例 查询静态策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/base/599d1975-ec30-4a5f-a390-ef388a1fbc70 查询证书策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/certificates/599d1975-ec30-4a5f-a390-ef388a1fbc70 查询自定义策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/functions/599d1975-ec30-4a5f-a390-ef388a1fbc70

响应示例 状态码： 200 OK 示例 1 { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "base", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "base_strategy_info" : { "priority" : 0, "keyword" : "mqttd", "app_id" : "dc0f1016f495157344ac5f1296335cff725ef22f", "app_name" : "mqttApp", "keyword_from" : "payload" }} 示例 2 { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "certificates", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "cert_strategy_info" : { "cert_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "cert_name" : "mqttCaCert", "app_id" : "dc0f1016f495157344ac5f1296335cff725ef22f", "app_name" : "mqttApp" }} 示例 3 { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "functions", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "function_strategy_info" : { "func_name" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test" }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 strategy_id String 策略id。 最小长度：1 最大长度：64 strategy_type String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值：base authorizer TenantDomainResp object 授权账号信息结构体 access_points Array of AccessPointResp objects 发放区域。 数组长度：0 - 1000 base_strategy_info BaseStrategyInfo object 静态策略结构体 cert_strategy_info CertStrategyInfo object 证书策略结构体 function_strategy_info FunctionStrategyInfo object 自定义策略结构体 表4 TenantDomainResp 参数 参数类型 描述 domain_id String 公有云账户ID domain_name String 公有云账户名 最小长度：1 最大长度：64 表5 AccessPointResp 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云终端节点ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 表6 BaseStrategyInfo 参数 参数类型 描述 keyword String 静态策略的关键字。 最小长度：1 最大长度：256 priority Integer 静态策略的优先级别。 取值范围：0-4，0级最低，4级最高。 最小值：0 最大值：4 app_id String 应用ID。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 app_name String 应用名。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 keyword_from String 关键字来源。设备发放静态策略的匹配信息来源。 deviceName: 设备名称，默认的匹配方式，设备信息在被创建后，设备名称包涵设置的关键字，即可按照该行策略指定的发放应用进行实例发放。 payload: 数据上报，如果设备在连接后，进行发放publish时。上报Topic “$oc/devices/${deviceId}/sys/bootstrap/up” 中，json上报的属性 “baseStrategyKeyword” 包含设置的关键字，即可按该实例进行发放。 最小长度：1 最大长度：64 表7 CertStrategyInfo 参数 参数类型 描述 cert_id String 证书ID。 最小长度：1 最大长度：64 cert_name String 证书名称。 最小长度：0 最大长度：256 app_id String 应用ID。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 app_name String 应用名。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 表8 FunctionStrategyInfo 参数 参数类型 描述 func_name String function名称。 最小长度：1 最大长度：64 func_urn String 函数的URN（Uniform Resource Name），唯一标识函数 最小长度：1 最大长度：360

URI GET /v5/iotps/{project_id}/allocation-strategies/{strategy_type}/{strategy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 strategy_type 是 String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值：base strategy_id 是 String 策略ID。 最小长度：1 最大长度：36

响应示例 状态码： 200 OK { "certificate_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "cn_name" : "huawei", "owner" : "huawei", "status" : true, "verify_code" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "create_date" : "20190301T1910Z", "effective_date" : "20190301T1910Z", "expiry_date" : "20190301T1910Z"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 certificate_id String CA证书ID。 最小长度：0 最大长度：256 cn_name String CA证书CN名称。 最小长度：0 最大长度：128 owner String Ca证书所有者。 最小长度：0 最大长度：128 status Boolean CA证书验证状态。 verify_code String CA证书验证码。 最小长度：0 最大长度：256 create_date String 创建证书日期。 最小长度：0 最大长度：128 effective_date String CA证书生效日期 最小长度：0 最大长度：128 expiry_date String CA证书失效日期。 最小长度：0 最大长度：128 cert_name String CA证书名称。 最小长度：0 最大长度：256 cert_issue String CA证书颁发者。 最小长度：0 最大长度：128 update_date String CA证书更新日期。 最小长度：0 最大长度：128 expired Integer CA证书过期时间： 0：可用； 1：即将过期； 2：已经过期。 最小值：0 最大值：2 cert_hash String CA证书指纹。 最小长度：0 最大长度：128

请求示例 更新设备CA证书 PUT https://{endpoint}/v5/iotps/{project_id}/certificates/d4922d8a-6c8e-4396-852c-164aefa6638f{ "content" : "-----BEGIN CERTIFICATE-----\nMIID2TCCAsGgAwIBAgIJAOEDEgVdVMn9MA0G CS qGSIb3DQEBCwUAMIGCMQswCQYD\nVQQGEwJDTjERMA8GA1UECAwIR3VhbmRvbmcxETAPBgNVBAcMCFNoZW56aGVuMQ8w\nDQYDVQQKDAZIdWF3ZWkxDDAKBgNVBAsMA2lvdDESMBAGA1UEAwwJMTIzNDU2Nzg5\nMRowGAYJKoZIhvcNAQkBFgtkamthQHFxLmNvbTAeFw0xOTEyMTkxMzE1MjZaFw0y\nMjEwMDgxMzE1MjZaMIGCMQswCQYDVQQGEwJDTjERMA8GA1UECAwIR3VhbmRvbmcx\nETAPBgNVBAcMCFNoZW56aGVuMQ8wDQYDVQQKDAZIdWF3ZWkxDDAKBgNVBAsMA2lv\ndDESMBAGA1UEAwwJMTIzNDU2Nzg5MRowGAYJKoZIhvcNAQkBFgtkamthQHFxLmNv\nbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM72QUzoadvLfxGjt3UF\noZ4MJbblqnRbouO4KpOVHBXyS2yQVl4CWWMhLh4pp2efNUSqKuXHjY3r68PquyNn\nYk8zO59zVc7JHvjGkBvo7DgPRAhEKPLJIpRzkmlCBbxwTNCjc3FovGb/sHHNlpGn\ncCKUzMfPGNZuBiuemskuEXL/eMHxDPbXYWn4Wq0wt+28PKUL5jybY7nsXSNnmAPF\nTO0CAmq0meUukubT/jHDCQ78ihQ/iqw1RNq88aCqRleoHiGg5nWkjL+05GXqUrqV\nVnZNL+YqcXzuVMs5XgyhNM2AsuH2g3D8ZuF6Dj9qY1n/v/Cp/DGpxP3A74SlplnF\nD/0CAwEAAaNQME4wHQYDVR0OBBYEFAVPWVtpTdO6KQnmVrrNlMguWNR7MB8GA1Ud\nIwQYMBaAFAVPWVtpTdO6KQnmVrrNlMguWNR7MAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQELBQADggEBAE40ViqK+UaEn++Xq6f4Cmeg3JqYHu47v9RIAASNihYRBQ/r\n3RE7Af3GqjIO5nMJJuCMzdcoAU8N9KwkgXD+GLR9fYLEoEmq5CrhgaGDsCi85vCs\nmWhj5z8r5TG207xpmvH2KT447dnG+chMBE594ma85dCv+0mCDrqNToElipgT8+rY\nAYVClnIt3kbsTg1vSRNHadd+TpgRVxJZBF0fHcCAyc/2f3UJgPYNWShIetHM6BdI\n3fZ4H+eeHPjagm5kzmffli1cUv2/N+1hKUvcI4uFCqEwZRFtp90RyIbxUfQwi+Cs\nXVnwV+BZS5qD9bTcfxZMXhuVRwO/5xWYMYPN1uY=\n-----END CERTIFICATE-----"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 certificates Array of CertificatesRspDTO objects 证书列表。 数组长度：0 - 1000 page Page object 查询结果的分页信息。 表5 CertificatesRspDTO 参数 参数类型 描述 certificate_id String CA证书ID。 最小长度：0 最大长度：256 cn_name String CA证书CN名称。 最小长度：0 最大长度：128 owner String Ca证书所有者。 最小长度：0 最大长度：128 status Boolean CA证书验证状态。 verify_code String CA证书验证码。 最小长度：0 最大长度：256 create_date String 创建证书日期。 最小长度：0 最大长度：128 effective_date String CA证书生效日期 最小长度：0 最大长度：128 expiry_date String CA证书失效日期。 最小长度：0 最大长度：128 cert_name String CA证书名称。 最小长度：0 最大长度：256 cert_issue String CA证书颁发者。 最小长度：0 最大长度：128 update_date String CA证书更新日期。 最小长度：0 最大长度：128 expired Integer CA证书过期时间： 0：可用； 1：即将过期； 2：已经过期。 最小值：0 最大值：2 cert_hash String CA证书指纹。 最小长度：0 最大长度：128 表6 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数，最大返回1000条记录。 最小值：0 最大值：1000 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 最小长度：0 最大长度：64

URI GET /v5/iotps/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 cert_name 否 String 证书名称。 最小长度：0 最大长度：256 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10

响应示例 状态码： 200 OK { "certificates" : [ { "certificate_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "cert_name" : "huawei", "cn_name" : "huawei", "owner" : "huawei", "status" : true, "verify_code" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "create_date" : "20190301T1910Z", "effective_date" : "20190301T1910Z", "expiry_date" : "20190301T1910Z" } ], "page" : { "count" : 1, "marker" : "d4922d8a-6c8e-4396-852c-164aefa6638f" }}

注册组管理 API 说明 查询注册组列表 应用服务器可调用此接口查询物联网平台中的注册组信息列表。 创建注册组 应用服务器可调用此接口在物联网平台创建一个注册组。 删除注册组 应用服务器可调用此接口在物联网平台上根据注册组名称删除指定注册组。 查询注册组详情 应用服务器可调用此接口查询物联网平台中注册组详情。 删除注册组 应用服务器可调用此接口在物联网平台上根据注册组ID删除指定注册组。 修改注册组 应用服务器可调用此接口修改物联网平台中指定注册组的基本信息。 查询注册组下的设备 应用服务器可调用此接口查询物联网平台中注册组设备信息。

设备管理 API 说明 注册设备 应用服务器可调用此接口在物联网平台注册一个设备，仅在注册后设备才可以接入物联网平台。 查询设备列表 应用服务器可调用此接口查询物联网平台中的设备信息列表。 查询设备 应用服务器可调用此接口查询物联网平台中指定设备的详细信息。 修改设备 应用服务器可调用此接口修改物联网平台中指定设备的基本信息。 删除设备 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备，则必须把设备下的非直连设备都删除后，才能删除该设备。 操作设备 应用服务器可调用此接口对设备执行操作。 发放设备 应用服务器可调用此接口对设备执行发放操作。

证书管理 API 说明 上传设备CA证书 应用服务器可调用此接口在物联网平台上传设备的CA证书。 获取设备CA证书列表 应用服务器可调用此接口在物联网平台获取设备的CA证书列表。 删除设备CA证书 应用服务器可调用此接口在物联网平台删除设备的CA证书。 查询单个设备CA证书 应用服务器可调用此接口在物联网平台查询设备的CA证书。 更新单个设备CA证书 应用服务器可调用此接口在物联网平台更新设备的CA证书。 生成CA证书验证码/验证设备CA证书 应用服务器可调用此接口在物联网平台生成CA证书验证码或验证设备的CA证书。

URI GET /v5/iotps/{project_id}/allocation-strategies/{strategy_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 strategy_type 是 String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值：base 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 strategies Array of StrategyResp objects 发放策略实例列表 数组长度：0 - 1000 page Page object 查询结果的分页信息。 表5 StrategyResp 参数 参数类型 描述 strategy_id String 策略id。 最小长度：1 最大长度：64 strategy_type String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值：base authorizer TenantDomainResp object 授权账号信息结构体 access_points Array of AccessPointResp objects 发放区域。 数组长度：0 - 1000 base_strategy_info BaseStrategyInfo object 静态策略结构体 cert_strategy_info CertStrategyInfo object 证书策略结构体 function_strategy_info FunctionStrategyInfo object 自定义策略结构体 表6 TenantDomainResp 参数 参数类型 描述 domain_id String 公有云账户ID domain_name String 公有云账户名 最小长度：1 最大长度：64 表7 AccessPointResp 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云终端节点ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 表8 BaseStrategyInfo 参数 参数类型 描述 keyword String 静态策略的关键字。 最小长度：1 最大长度：256 priority Integer 静态策略的优先级别。 取值范围：0-4，0级最低，4级最高。 最小值：0 最大值：4 app_id String 应用ID。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 app_name String 应用名。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 keyword_from String 关键字来源。设备发放静态策略的匹配信息来源。 deviceName: 设备名称，默认的匹配方式，设备信息在被创建后，设备名称包涵设置的关键字，即可按照该行策略指定的发放应用进行实例发放。 payload: 数据上报，如果设备在连接后，进行发放publish时。上报Topic “$oc/devices/${deviceId}/sys/bootstrap/up” 中，json上报的属性 “baseStrategyKeyword” 包含设置的关键字，即可按该实例进行发放。 最小长度：1 最大长度：64 表9 CertStrategyInfo 参数 参数类型 描述 cert_id String 证书ID。 最小长度：1 最大长度：64 cert_name String 证书名称。 最小长度：0 最大长度：256 app_id String 应用ID。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 app_name String 应用名。设备发放的目的接入点的目的应用。 最小长度：1 最大长度：64 表10 FunctionStrategyInfo 参数 参数类型 描述 func_name String function名称。 最小长度：1 最大长度：64 func_urn String 函数的URN（Uniform Resource Name），唯一标识函数 最小长度：1 最大长度：360 表11 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数，最大返回1000条记录。 最小值：0 最大值：1000 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 最小长度：0 最大长度：64

请求示例 查询静态策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/base 查询证书策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/certificates 查询自定义策略请求示例 GET https://{endpoint}/v5/iotps/{project_id}/allocation-strategies/functions

响应示例 状态码： 200 OK 示例 1 { "page" : { "count" : 2, "marker" : 2 }, "strategies" : [ { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "base", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "base_strategy_info" : { "priority" : 0, "keyword" : "mqttd", "app_id" : "dc0f1016f495157344ac5f1296335cff725ef22f", "app_name" : "mqttApp" } }, { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "base", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "base_strategy_info" : { "priority" : 0, "keyword" : "mqttd", "app_id" : "dc0f1016f495157344ac5f1296335cff725ef22f", "app_name" : "mqttApp", "keyword_from" : "deviceName" } } ]} 示例 2 { "page" : { "count" : 1, "marker" : 1 }, "strategies" : [ { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "certificates", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "cert_strategy_info" : { "cert_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "cert_name" : "mqttCaCert", "app_id" : "dc0f1016f495157344ac5f1296335cff725ef22f", "app_name" : "mqttApp" } } ]} 示例 3 { "page" : { "count" : 1, "marker" : 1 }, "strategies" : [ { "strategy_id" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "strategy_type" : "functions", "access_points" : { "access_point_id" : "DMP-CNNorth-4-1", "access_point_name" : "设备管理-北京四-1", "region_id" : "cn-north-4" }, "function_strategy_info" : { "func_name" : "599d1975-ec30-4a5f-a390-ef388a1fbc70", "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test" } } ]}

URI POST /v5/iotps/{project_id}/devices/{device_id}/reset-fingerprint 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 参数说明：设备ID，用于唯一标识一个设备。在注册设备时直接指定，或者由物联网平台分配获得。由物联网平台分配时，生成规则为"product_id" + "" + "node_id"拼接而成。 取值范围：长度不超过128，只允许字母、数字、下划线（）、连接符（-）的组合。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 fingerprint 否 String 参数说明：设备指纹。设置改字段时平台将设备指纹重置为指定值；不携带时将之置空，后续设备第一次接入时，该设备指纹的值将设置为第一次接入时的证书指纹。 取值范围：长度为40的十六进制字符串或者长度为64的十六进制字符串。

响应示例 状态码： 200 OK { "devices" : [ { "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789", "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice", "node_type" : "ENDPOINT", "description" : "watermeter device", "auth_info" : { "auth_type" : "SECRET", "secret" : "3b935a250c50dc2c6d481d048cefdc3c", "fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f", "secure_access" : true, "timeout" : 300 }, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "create_time" : "20190303T081011Z", "provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4", "region_id" : "cn-north-4" }, "allocation_status" : 0, "allocation_strategy_type" : "base" } } ], "page" : { "count" : 1, "marker" : "d4922d8a-6c8e-4396-852c-164aefa6638f" }}

URI GET /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 表2 Query参数 参数 是否必选 参数类型 描述 product_id 否 String 设备关联的产品ID，用于唯一标识一个产品模型，在管理门户导入产品模型后由平台分配获得。 最小长度：1 最大长度：36 gateway_id 否 String 网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最小长度：1 最大长度：128 node_id 否 String 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。 最小长度：1 最大长度：64 device_name 否 String 设备名称。 最小长度：1 最大长度：256 limit 否 Integer 分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 marker 否 String 上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24 start_time 否 String 查询设备注册时间在startTime之后的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。 end_time 否 String 查询设备注册时间在endTime之前的记录，格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of QueryDeviceSimplify objects 设备信息列表。 数组长度：0 - 1000 page Page object 查询结果的分页信息。 表5 QueryDeviceSimplify 参数 参数类型 描述 device_id String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 最小长度：0 最大长度：256 node_id String 设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最小长度：0 最大长度：256 gateway_id String 网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最小长度：0 最大长度：256 device_name String 设备名称。 最小长度：0 最大长度：256 node_type String 设备节点类型。 ENDPOINT：非直连设备。 GATEWAY：直连设备或网关。 UNKNOWN：未知。 description String 设备的描述信息。 最小长度：0 最大长度：2048 product_id String 设备关联的产品ID，用于唯一标识一个产品模型。 provision_info ProvisionInfoResp object 设备的发放信息。 表6 ProvisionInfoResp 参数 参数类型 描述 access_point AccessPointResp object 发放区域。 allocation_status Integer 设备发放状态。 取值如下： 0：成功； 1：失败； 2：发放中； 3：未发放（默认）。 最小值：0 最大值：3 allocation_strategy_type String 策略类型。 取值如下： base：静态策略； certificates：证书策略； functions：自定义策略； nearby：就近策略。 缺省值：base life_time Integer LWM2M设备导入的默认生命周期。 最小值：0 最大值：864000 表7 AccessPointResp 参数 参数类型 描述 access_point_id String 接入点id。 最小长度：1 最大长度：256 access_point_name String 接入点名称。 最小长度：1 最大长度：256 region_id String 华为云终端节点ID。节选自https://developer.huaweicloud.com/endpoint。 最小长度：1 最大长度：128 表8 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数，最大返回1000条记录。 最小值：0 最大值：1000 marker String 本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 最小长度：0 最大长度：64

响应示例 状态码： 200 Successful response { "product_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "Thermometer", "device_type" : "Thermometer", "model" : "123", "protocol_type" : "LWM2M", "data_format" : "binary", "industry" : "smartCity", "description" : "this is a thermometer produced by Huawei", "service_capabilities" : [ { "service_id" : "temperature", "service_type" : "temperature", "properties" : [ { "property_name" : "temperature", "required" : true, "data_type" : "decimal", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "centigrade", "method" : "R", "description" : "force" } ], "commands" : [ { "command_name" : "reboot", "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "responses" : [ { "paras" : [ { "para_name" : "force", "required" : false, "data_type" : "string", "enum_list" : null, "min" : 1, "max" : 100, "max_length" : 100, "step" : 0.1, "unit" : "km/h", "description" : "force" } ], "response_name" : "ACK" } ] } ], "description" : "temperature", "option" : "Mandatory" } ], "create_time" : "20190303T081011Z"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 product_id String 产品ID，用于唯一标识一个产品模型，在物联网平台的SP Portal上导入产品模型后由平台分配获得。 最小长度：0 最大长度：255 name String 产品名称。 最小长度：0 最大长度：255 device_type String 设备类型。 最小长度：0 最大长度：255 model String 设备型号。 最小长度：0 最大长度：255 protocol_type String 设备使用的协议类型。 最小长度：0 最大长度：20 data_format String 设备上报数据的格式。 最小长度：0 最大长度：20 industry String 设备所属行业。 最小长度：0 最大长度：255 description String 产品的描述信息。 最小长度：0 最大长度：2048 service_capabilities Array of ServiceCapability objects 设备的服务能力列表。 数组长度：0 - 1000 create_time String 在物联网平台创建产品的时间。 最小长度：0 最大长度：128 表5 ServiceCapability 参数 参数类型 描述 service_id String 设备的服务ID。 service_type String 设备的服务类型。 properties Array of ServiceProperty objects 设备服务支持的属性列表。 数组长度：0 - 1000 commands Array of ServiceCommand objects 设备服务支持的命令列表。 数组长度：0 - 1000 description String 设备服务的描述信息。 option String 指定设备服务是否必选。Master（主服务）, Mandatory（必选服务）, Optional（可选服务），目前本字段为非功能性字段，仅起到标识作用。 表6 ServiceProperty 参数 参数类型 描述 property_name String 设备属性名称。 required Boolean 设备属性是否必选。 data_type String 设备属性的数据类型。 enum_list Array of strings 设备属性的枚举值列表。 数组长度：0 - 1000 min String 设备属性的最小值。 最小长度：1 最大长度：16 max String 设备属性的最大值。 最小长度：1 最大长度：16 max_length Integer 设备属性的最大长度。 step Double 设备属性的步长。 unit String 设备属性的单位。 method String 设备属性的访问模式。 R：属性值可读 W：属性值可写 E：属性值可订阅，即属性值变化时上报事件 description String 设备属性的描述。 表7 ServiceCommand 参数 参数类型 描述 command_name String 设备命令名称。 paras Array of ServiceCommandPara objects 设备命令的参数列表。 数组长度：0 - 100 responses Array of ServiceCommandResponse objects 设备命令的响应列表。 数组长度：0 - 1000 表8 ServiceCommandResponse 参数 参数类型 描述 paras Array of ServiceCommandPara objects 设备命令响应的参数列表。 数组长度：0 - 100 response_name String 设备命令响应名称。 表9 ServiceCommandPara 参数 参数类型 描述 para_name String 命令参数的名称。 required Boolean 命令参数是否必选。 data_type String 命令参数的数据类型。 enum_list Array of strings 命令参数的枚举值列表。 数组长度：0 - 1000 min String 命令参数的最小值。 最小长度：1 最大长度：16 max String 命令参数的最大值。 最小长度：1 最大长度：16 max_length Integer 命令参数的最大长度。 最小值：0 最大值：1000 step Double 命令参数的步长。 最小值：0 最大值：1000 unit String 命令参数的单位。 最小长度：0 最大长度：16 description String 命令参数的描述。

URI GET /v5/iotps/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 product_id 是 String 产品ID，用于唯一标识一个产品，在物联网平台的SP Portal上导入产品模型后由平台分配获得。 表2 Query参数 参数 是否必选 参数类型 描述 region_id 是 String 区域ID，用于区分不同的区域。 access_point_id 是 String 接入点id，用于区分不同的区域。

终端节点 终端节点 区 域名 称 区域 终端节点（Endpoint） 端口 协议 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud.com 5683 LWM2M 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud.com 5684 LWM2M + DTLS 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud.com 8883 MQ TTS 区域名称 区域 北向接入域名 华北-北京四 cn-north-4 iotps.cn-north-4.myhuaweicloud.com

URI GET /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度：1 最大长度：32 device_id 是 String 设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128