华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

响应示例 状态码： 200 ok { "configmap" : { "id" : "12ns9eb6cc0d49a0941df2f31283mds8 ", "name" : "test-cm", "description" : "this is a test cm2", "configs" : { "key1" : "val1", "key3" : "val3" }, "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "created_at" : "2018-07-16T13:41:25.347335", "updated_at" : "2018-07-19T13:41:25.347335" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 property_visitors ValueInPropertyVisitors object 孪生属性配置，与access_protocol关联。 twin ValueInTwinResponse object 终端设备静态属性信息 access_protocol String 访问协议，有如下选项： userdefine：自定义协议 modbus：modbus协议 opc-ua：opc-ua协议 表4 ValueInPropertyVisitors 参数 参数类型 描述 register_type ValueInAttributes object 寄存器类型，value值字段可选为CoilsRegisters、HoldingRegisters、DiscreteInputsRegisters、InputRegisters access_mode ValueInAttributes object 访问模式，value值字段可选为r和r/w register_index ValueInAttributes object 寄存器偏移地址，value值字段取值范围0-65535 register_num ValueInAttributes object 寄存器个数 scale_index ValueInAttributes object 缩放因子 original_datatype ValueInAttributes object 原始数据类型 expected_datatype ValueInAttributes object 期望数据类型 is_registerswap ValueInAttributes object 是否交换寄存器顺序 is_swap ValueInAttributes object 是否交换高低字节 sample_interval ValueInAttributes object 数据采集间隔，取值范围为1-3600 data_min ValueInAttributes object 原始数据值区间最小值，与原始数据类型关联 data_max ValueInAttributes object 原始数据值区间最大值，与原始数据类型关联 node_id ValueInAttributes object 节点id browse_name ValueInAttributes object 节点名称 表5 ValueInAttributes 参数 参数类型 描述 value String value 最大长度512，value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、* optional Boolean 标识属性是否可选，默认为true metadata Metadata object 静态属性的元数据信息，默认为{"type": "string"} 表6 ValueInTwinResponse 参数 参数类型 描述 excepted ExceptedActual object 动态属性的期望信息 actual ExceptedActual object 动态属性的实际信息 metadata Metadata object 动态属性的元数据信息 optional Boolean 标识属性是否可选，默认为true，继承模板的属性默认为false 表7 ExceptedActual 参数 参数类型 描述 value String 动态属性的初始值，最大长度512，value允许英文字母、数字、下划线、中划线、点、逗号、冒号、/、@、+、?、^、=、%、&、~、#、!、* 表8 Metadata 参数 参数类型 描述 type String 属性类型标识，string|int|float|boolean（boolean类型为true或false），默认为string

响应示例 状态码： 200 ok { "access_protocol" : "userdefine", "property_visitors" : { }, "twin" : { "devicestate" : { "expected" : { "value" : "running", "metadata" : { "timestamp" : 1523514289 } }, "actual" : { "value" : "stop", "metadata" : { "timestamp" : 1523514289 } }, "optional" : true, "metadata" : { "type" : "string" } } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值 表3 请求Body参数 参数 是否必选 参数类型 描述 node 是 Action object 节点 表4 Action 参数 是否必选 参数类型 描述 action 是 String 启用，停用边缘节点，支持start/stop

响应示例 状态码： 201 ok { "device" : { "id" : "1398f13d-f24d-4de4-8cd3-5905db1d6d9f", "name" : "device", "access_protocol" : "", "project_id" : "05e1aef9040010e22fccc009adecb056", "description" : "", "created_at" : "2020-09-23T02:00:22.858736Z", "updated_at" : "", "access_config" : { }, "connection_type" : "edge" } }

响应示例 状态码： 200 ok { "secret" : { "id" : "12ns9eb6cc0d49a0941df2f31283mds8 ", "name" : "test-secret", "description" : "this is a test secret", "secrets" : { "key1" : "val-1", "key2" : "val-2" }, "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "created_at" : "2018-07-16T13:41:25.347335", "updated_at" : "2018-07-18T13:41:25.347335", "type" : "Opaque" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

响应示例 状态码： 200 响应参数 { "count" : 1, "nodes" : [ { "comment" : null, "enable_npu" : false, "edged_version" : "2.6.0", "mqtt_internal" : "tls://0.0.0.0:8883", "ca" : null, "updated_at" : "2019-07-24T03:52:53.545185+08:00", "node_type" : null, "docker_enable" : true, "device_infos" : [ ], "upgrade_history" : [ { "to_version" : "2.3.0", "upgrade_time" : 1557987888, "result" : "install_success", "id" : 0 }, { "from_version" : "2.3.0", "to_version" : "2.3.0", "result" : "install_success", "dur_time" : 2248264, "upgrade_time" : 1560236152, "id" : 1 }, { "from_version" : "2.3.0", "to_version" : "2.3.0", "result" : "install_success", "dur_time" : 87129, "upgrade_time" : 1560323281, "id" : 2 }, { "from_version" : "2.3.0", "to_version" : "2.3.0", "result" : "install_success", "dur_time" : 158246, "upgrade_time" : 1560481527, "id" : 3 }, { "from_version" : "2.3.0", "to_version" : "2.5.0", "result" : "install_success", "dur_time" : 1466742, "upgrade_time" : 1561948269, "id" : 4 }, { "from_version" : "2.5.0", "to_version" : "2.5.0", "result" : "install_success", "dur_time" : 884941, "upgrade_time" : 1562833210, "id" : 5 }, { "from_version" : "2.5.0", "to_version" : "2.6.0", "result" : "install_success", "dur_time" : 1106868, "upgrade_time" : 1563940078, "id" : 6 } ], "pause_docker_image" : null, "ntp_configs" : { "ntp_servers" : [ "10.127.1.0", "ntp.myhuaweicloud.com" ], "ntp_enabled" : true }, "ief_node_version" : "2.6.0", "id" : "699de693-8493-4912-89dc-882134c5bf13", "device_num" : 0, "certificate" : null, "nics" : [ { "interface" : "eth0", "ip" : "10.0.0.41" } ], "gpu_num" : 0, "os_version" : "3.10.0-957.21.3.el7.x86_64", "state" : "RUNNING", "error_reason" : null, "memory" : 990, "mqtt_mode" : "internal", "project_id" : "", "private_key" : null, "os_name" : "CentOS Linux 7 (Core)", "description" : "", "gpu_info" : [ ], "attributes" : [ ], "mqtt_external" : null, "arch" : "x86_64", "host_ips" : [ "10.0.0.41" ], "enable_gpu" : false, "npu_type" : "", "name" : "ief-node", "deployment_num" : 0, "package" : null, "container_runtime_version" : "docker://19.03.0", "created_at" : "2019-05-16T06:19:10.303502+08:00", "cpu" : 1, "product_id" : null, "host_name" : "iefnode", "relation" : null, "os_type" : "linux", "log_configs" : [ ] } ] }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

URI GET /v2/{project_id}/edgemgr/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 边缘节点名称，模糊匹配 limit 否 String 每页显示的条目数量，取值范围1~1000，默认为500 offset 否 String 查询的起始位置，取值范围为非负整数，默认为0 sort 否 String 显示的条目排列顺序，使用:分隔参考值和顺序， 如sort=created_at%3Adesc表示根据创建时间逆序排列 device_id 否 String 按终端设备ID查找 device_name 否 String 按绑定终端设备名称查找 app_name 否 String 按应用名称查找 state 否 String 按边缘节点状态查找，节点状态可选项： RUNNING：运行中 FAIL：故障 UPGRADING：升级中 STOPPED：已停用 UNCONNECTED：未纳管 tags 否 String 标签的key和value通过点连接， 多个标签通过逗号连接，如：tags=key1.value1,key2.value2 group_id 否 String 按边缘节点组ID查找。仅支持在铂金版实例中使用

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 resources Array of Resource objects 资源实例 total_count Integer 总记录数 表8 Resource 参数 参数类型 描述 resource_id String 资源ID tags Array of ResourceTag objects 标签列表，没有标签默认为空数组 resource_name String 资源名称，资源没有名称时默认为空字符串。 表9 ResourceTag 参数 参数类型 描述 key String 键。最大长度36个unicode字符。 不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”。 value String 值。每个值最大长度43个unicode字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。 不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”。

请求示例 查询资源实例，按照过滤条件查询，搜索字段为“resource_name”，标签键值为“test”，值为“value1,value2”。 { "action" : "filter", "limit" : "10", "offset" : "0", "matches" : [ { "key" : "resource_name", "value" : "q" } ], "tags" : [ { "key" : "test", "values" : [ "value1", "value2" ] } ] }

响应示例 状态码： 200 ok { "total_count" : 2, "resources" : [ { "tags" : [ { "value" : "", "key" : "testtest" }, { "value" : "value2", "key" : "test" } ], "resource_name" : "node_test_0108_1", "resource_id" : "e25307d4-bd25-4c29-ba7f-176376ed2f99" }, { "tags" : [ { "value" : "value1", "key" : "key1" }, { "value" : "", "key" : "test" } ], "resource_name" : "node_test-0109_1", "resource_id" : "fc3aeee8-24e1-4912-bf7a-54854251d0e5" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of Tag objects 包含标签，最多包含20个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。如tags_any和tags字段同时存在，则去重后返回两者并集。无tag过滤条件时返回全量数据。 tags_any 否 Array of Tag objects 包含任意标签，最多包含20个key，每个key下面的value最多10个。Key不能重复，同一个key中values不能重复。结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。如tags_any和tags字段同时存在，则去重后返回两者并集。无过滤条件时返回全量数据。 not_tags 否 Array of Tag objects 不包含标签，最多包含20个key，每个key下面的value最多10个。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 not_tags_any 否 Array of Tag objects 不包含任意标签，最多包含20个key，每个key下面的value最多10个。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 limit 否 String 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000,不能为负数，最小值为1 offset 否 String 索引位置，偏移量（action为count时无此参数）从第一条数据偏移offset条数据后开始查询，如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数 action 是 String 操作标识（仅限于filter，count）：filter（过滤），count(查询总条数) 如果是filter就按照过滤条件查询，如果是count，只需要返回总条数，禁止返回其他字段。 matches 否 Array of Matches objects 搜索字段,key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写，不支持*，支持字符串匹配），如果value为空字符串则返回空列表（IEF服务不存在资源名称为空的情况，因此这类情况返回空列表）。 console 否 Boolean 确认是否请求源是否为console，通过该字段来判断是否返回resource_detail内容，如果为true则返回，如果为false或者不带该参数则返回空列表。 sorted 否 Sorted object 按标签过滤资源后返回结果的排序方式 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 标签key值，长度取值范围为1~36， 仅允许大小写英文字母、数字、下划线、中划线 values 否 Array of strings 标签value值，长度取值范围为0~43， 仅允许大小写英文字母、数字、下划线、中划线 表5 Matches 参数 是否必选 参数类型 描述 key 是 String 键。限定为resource_name,后续扩展。 value 否 String 值。每个值最大长度64个unicode字符。不校验字符集范围。 表6 Sorted 参数 是否必选 参数类型 描述 key 否 String 按key值对请求内容进行排序 reverse 否 Boolean 是否采用倒序

URI POST /v2/{project_id}/{resource_type}/resource_instances/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型 ief-edge_node ief-deployment ief-application ief-device

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 id String 证书id name String 证书名称 description String 证书的描述 created_at String 证书的创建时间 node_id String 节点id type String 证书类型，包含： system：创建节点时会默认创建一套系统证书 application：应用证书 device：设备证书 serial_num String 证书序列号 ca String 根证书 certificate String 证书 private_key String 私钥 package String 将证书文件certificate/ca/private_key打成.tar.gz包后用base64编码的字符串。 使用时请使用base64解码成.tar.gz包。

响应示例 状态码： 201 创建成功 { "id" : "243931b3-2651-4147-becc-d4215c8c2296", "name" : "app-cert", "description" : "", "created_at" : "2020-09-22T17:55:41.577635881Z", "node_id" : "9ebd8efb-9fdd-44a1-abda-9cdbc287a867", "type" : "application", "serial_num" : "", "ca" : "", "certificate" : "", "private_key" : "", "package" : "" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 标签列表 count Integer 标签数量 表4 Tag 参数 参数类型 描述 key String 标签key值，长度取值范围为1~36， 仅允许大小写英文字母、数字、下划线、中划线 values Array of strings 标签value值，长度取值范围为0~43， 仅允许大小写英文字母、数字、下划线、中划线

响应示例 状态码： 200 ok { "count" : 5, "tags" : [ { "values" : [ "hwg" ], "key" : "deployer" }, { "values" : [ "batchjob" ], "key" : "batchjob" }, { "values" : [ "2" ], "key" : "2" }, { "values" : [ "bbb" ], "key" : "aaa" }, { "values" : [ "autotest" ], "key" : "autotest" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 ief-instance-id 否 String 铂金版实例ID，专业版实例为空值

响应示例 状态码： 200 ok { "configmap" : { "id" : "12ns9eb6cc0d49a0941df2f31283mds8 ", "name" : "test-cm", "description" : "this is a test cm2", "configs" : { "key1" : "val1", "key3" : "val3" }, "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "created_at" : "2018-07-16T13:41:25.347335", "updated_at" : "2018-07-19T13:41:25.347335" } }

响应示例 状态码： 201 ok { "configmap" : { "id" : "12ns9eb6cc0d49a0941df2f31283mds8 ", "name" : "test-cm", "description" : "this is a test cm", "configs" : { "key1" : "val-1", "key2" : "val-2" }, "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "created_at" : "2018-07-16T13:41:25.347335", "updated_at" : "2018-07-18T13:41:25.347335" } }

URI GET /v2/{project_id}/edgemgr/configmaps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 配置项名称，模糊匹配 limit 否 String 每页显示的条目数量，取值范围1~1000，默认为1000 offset 否 String 查询的起始位置，取值范围为非负整数，默认为0

响应示例 状态码： 200 ok { "count" : 1, "configmaps" : [ { "id" : "12ns9eb6cc0d49a0941df2f31283mds8 ", "name" : "test-cm", "description" : "this is a test cm2", "configs" : { "key1" : "val1", "key3" : "val3" }, "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "created_at" : "2018-07-16T13:41:25.347335", "updated_at" : "2018-07-19T13:41:25.347335" } ] }