检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 图1 API凭证-获取项目ID 调用API获取项目ID
查询编解码函数 功能介绍 提供查询编解码函数的功能。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/product-functions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建产品接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
查询数据流转流控策略列表 功能介绍 应用服务器可调用此接口查询在物联网平台设置的数据流转流控策略列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/routing-rule/flowcontrol-policy 表1 路径参数 参数
查询设备组列表 功能介绍 应用服务器可调用此接口查询物联网平台中的设备组信息列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/device-group 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询产品列表 功能介绍 应用服务器可调用此接口查询已导入物联网平台的产品模型信息列表,了解产品模型的概要信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/products 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询预调配模板详情 功能介绍 应用服务器可调用此接口在物联网平台查询指定预调配模板ID的详细信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/provisioning-templates/{template_id} 表1 路径参数
添加实例标签 功能介绍 添加实例标签。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/iotda-instances/{instance_id}/bind-tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询OTA升级包列表 功能介绍 用户可调用此接口查询关联OBS对象的升级包列表 使用前提:使用该API需要您授权设备接入服务(IoTDA)的实例访问对象存储服务(OBS)以及 密钥管理服务(KMS Administrator)的权限。在“统一身份认证服务(IAM) - 委托”中将
自定义模板鉴权使用说明 使用说明 图1 自定义模板鉴权流程图 操作步骤 创建鉴权模板:进入设备接入控制台左侧导航栏,选择“设备 > 自定义鉴权”,单击“自定义模板”,单击“创建鉴权模板”。本示例演示使用的鉴权模板与系统默认鉴权一致。 图2 自定义鉴权-创建鉴权模板 模板整体内容如下:
修改规则动作 功能介绍 应用服务器可调用此接口修改物联网平台中指定规则动作的配置。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/routing-rule/actions/{action_id} 表1 路径参数 参数 是否必选 参数类型
查询规则动作 功能介绍 应用服务器可调用此接口查询物联网平台中指定规则动作的配置信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/routing-rule/actions/{action_id} 表1 路径参数 参数 是否必选 参数类型
删除实例标签 功能介绍 删除实例标签。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/iotda-instances/{instance_id}/unbind-tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id
删除自定义鉴权 功能介绍 应用服务器可调用此接口在物联网平台上删除指定自定义鉴权。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/device-authorizers/{authorizer_id} 表1 路径参数 参数 是否必选
删除设备隧道 功能介绍 用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}
删除预调配模板 功能介绍 应用服务器可调用此接口在物联网平台上删除指定预调配模板。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/provisioning-templates/{template_id} 表1 路径参数 参数 是否必选
停止批量任务 功能介绍 应用服务器可调用此接口停止批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经完成(成功、失败、部分成功,已经停止)或正在停止中,则不可以调用该接口。如果请求Body为{},
删除编解码函数 功能介绍 提供删除编解码函数的功能。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/product-functions/{function_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
关闭设备隧道 功能介绍 应用服务器可通过该接口关闭某个设备隧道。关闭后可以再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/tunnels/{tunnel_id}