华为云用户手册

  • 响应示例 状态码: 200 ok { "device_template" : { "name" : "CameraTemplate", "description" : "This is a camera template", "created_at" : "2018-07-16T04:01:21.212072", "updated_at" : "2018-07-18T04:01:21.212017", "access_protocol" : "userdefine", "project_id" : "d16e6eb6cc0d49a0941df2f31285757a", "id" : "82952098-ec24-4643-94e6-9989174fce05", "attributes" : { "cameraURL" : { "value" : "127.0.0.1", "metadata" : { "type" : "string" } } }, "twin" : { "runstate" : { "expected" : { "value" : "running" }, "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,专业版实例为空值
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述信息 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述信息 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述信息
  • 响应示例 状态码: 200 ok { "service" : { "id" : "81acf9ff-de6d-4736-8d1a-f43bb058e79d", "project_id" : "e78acc02d9d141eda5ca8e88fa35f6f8", "meta_data" : { "name" : "service-example" }, "spec" : { "selector" : { "app" : "ief-nginx" }, "ports" : [ { "name" : "http-0", "protocol" : "TCP", "port" : "8888", "target_port" : "80" } ], "cluster_ip" : "None" }, "created_at" : "2020-07-08 01:23:25.845332209 +0000 UTC", "updated_at" : "2020-07-08 01:23:25.845332209 +0000 UTC" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 是 String 铂金版实例ID
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 quotas QuotaResourceList object 资源配额 表5 QuotaResourceList 参数 参数类型 描述 resources Array of QuotaResource objects 资源列表 表6 QuotaResource 参数 参数类型 描述 used Integer 已创建的资源个数 min Integer 最少可创建的资源个数 max Integer 最多可创建的资源个数 quota Integer 资源配额限制 project_id String 项目ID type String 查询配额的资源类型,支持填写: edge_node: 边缘节点 node_cert: 边缘节点证书 edge_group: 边缘节点组 group_cert: 边缘节点组证书 application: 应用模板 deployment: 容器应用 device_template: 终端设备模板 device: 终端设备 app_version: 应用模板的版本 tag: 标签 configmap: 配置项 secret: 密钥 ief_instance: 铂金版实例 service: 服务网格 gateway: 服务网关
  • URI GET /v2/{project_id}/edgemgr/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 types 否 String 查询配额的资源类型,支持填写: edge_node: 边缘节点 node_cert: 边缘节点证书 edge_group: 边缘节点组 group_cert: 边缘节点组证书 application: 应用模板 deployment: 容器应用 device_template: 终端设备模板 device: 终端设备 app_version: 应用模板的版本 tag: 标签 configmap: 配置项 secret: 密钥 ief_instance: 铂金版实例 service: 服务网格 gateway: 服务网关
  • 响应示例 状态码: 200 查询成功 { "product" : { "id" : "52b7e862-7b86-4b4d-b805-f580c4a25b0b", "name" : "a", "description" : "", "attributes" : { }, "project_id" : "ed202955e111444e8ced21a1bd75fc59", "created_at" : 1667214079 }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 证书ID name String 证书名称 description String 证书描述 created_at String 创建时间 updated_at String 更新时间 group_id String 证书绑定的边缘节点组ID is_deleted Boolean 证书是否处于删除中 project_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包。 cert_remaining_valid_time Integer 证书有效期持续时间
  • 响应示例 状态码: 200 查询成功 { "created_at" : "2022-08-25 11:04:47.211793039 +0000 UTC", "description" : "", "id" : "d84da122-9dce-4deb-9959-8bb9d73e0ab5", "name" : "group1", "updated_at" : "2022-08-25 11:04:47.211793039 +0000 UTC", "group_id" : "e4f9c0d6-e1d7-41d5-a108-f38aa8372ffd", "is_deleted" : false, "package" : "", "project_id" : "ed202955e111444e8ced21a1bd75fc59", "serial_num" : "", "type" : "application", "ca" : "", "certificate" : "", "private_key" : "", "cert_remaining_valid_time" : 3584}
  • 响应示例 状态码: 200 ok { "device_template" : { "property_visitors" : { }, "description" : "This is a camera template", "tags" : { }, "created_at" : "2019-11-07T03:20:04.041160+08:00", "updated_at" : "2019-11-07T03:21:00.347476+08:00", "access_protocol" : "userdefine", "twin" : { "runstate" : { "expected" : { "value" : "running" }, "optional" : true, "metadata" : { "type" : "string" } } }, "attributes" : { "cameraURL" : { "optional" : true, "value" : "127.0.0.1", "metadata" : { "type" : "string" } } }, "project_id" : "ed202955e111444e8ced21a1bd75fc59", "id" : "42e20164-5158-4316-a821-5fe127c483b0", "name" : "CameraTemplate" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值
  • 响应示例 状态码: 200 查询成功 { "job_name" : "aaa", "job_id" : "66273c66-f72e-4607-8769-3663d255fb83", "job_type" : "deployment_deploy", "target_type" : "node", "description" : "", "targets" : [ { "target_id" : "72eb5df1-295b-41f6-baed-d1a56728b0e0", "extension_info" : [ { "key" : "node_name", "value" : "test1" } ] }, { "target_id" : "b1c0e722-ee98-4ae3-9224-881224cb32c9", "extension_info" : [ { "key" : "node_name", "value" : "test2" } ] } ], "task_data" : "{\"deployment\":{\"replicas\":1,\"template\":{\"configs\":{\"host_network\":false,\"restart_policy\":\"Always\",\"host_pid\":false},\"containers\":[{\"name\":\"container-06fefd36\",\"version\":\"latest\",\"image_url\":\"sample:latest\",\"envs\":[],\"volumes\":[],\"resources\":{\"limits\":{\"cpu\":\"0.25\",\"memory\":\"512\"},\"requests\":{\"cpu\":\"0.25\",\"memory\":\"512\"}},\"privileged\":false,\"ports\":[]}]}},\"source\":\"userdefined\",\"name_prex\":\"aaa\",\"tags\":[],\"description\":\"\"}", "status" : "Successful", "created_at" : 1667218308, "status_last_updated_at" : 1667218329, "tasks" : [ { "task_name" : "aaa-c530d", "task_id" : "382cca3e-88e6-4a7c-bf23-b637a99761f9", "target_id" : "72eb5df1-295b-41f6-baed-d1a56728b0e0", "status" : "Successful", "created_at" : 1667218324, "reason" : "", "extension_info" : [ { "key" : "deployment_id", "value" : "9bdefd92-c724-41f4-b07a-4b1061e096d6" } ] }, { "task_name" : "aaa-ce854", "task_id" : "ac04605b-c286-4f23-97e0-fe08366c36f5", "target_id" : "b1c0e722-ee98-4ae3-9224-881224cb32c9", "status" : "Successful", "created_at" : 1667218325, "reason" : "", "extension_info" : [ { "key" : "deployment_id", "value" : "4b4c7b0c-7ee8-4a7e-b79e-9291b7fd365d" } ] } ], "task_total_count" : 2, "task_failed_count" : 2, "task_success_count" : 0}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 job_id String 批量处理作业ID job_name String 批量处理作业名称 job_type String 批量作业类型,支持以下选项: - node_upgrade: 节点升级 - deployment_deploy:应用部署 - deployment_upgrade:应用升级 description String 描述 created_at Integer 创建时间戳 status String 执行状态 task_total_count Integer 任务总数 task_failed_count Integer 任务项执行成功数 task_success_count Integer 任务项执行失败数 target_type String 批量作业对象类型,支持如下选项: - node:边缘节点 - node_group:边缘节点组 - deployment:边缘应用 task_data String 批量作业内容,仅在批量应用部署和批量应用升级时需要填写,填入的内容为:使用json结构体编写的创建应用部署接口请求体deployment参数,并将其转换为字符串 tasks Array of Task objects 任务项详情 targets Array of Target objects 批量处理对象详情 status_last_updated_at Integer 状态更新时间戳 表4 Task 参数 参数类型 描述 task_id String 任务项ID task_name String 任务项名称 status String 任务项状态 reason String 任务项失败的原因 created_at Integer 创建时间戳 target_id String 批量处理对象ID extension_info Array of Extension objects 批量处理对象基本信息 表5 Target 参数 参数类型 描述 extension_info Array of Extension objects 批量处理对象基本信息 target_id String 批量处理对象ID 表6 Extension 参数 参数类型 描述 key String 属性名,可填:node_name value String 属性值
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • URI POST /v3/{project_id}/edgemgr/deployments/{deployment_id}/pods/{pod_name}/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见获取项目ID。 deployment_id 是 String 应用部署ID pod_name 是 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参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 是 String 铂金版实例ID
  • 响应示例 状态码: 200 查询成功 { "count" : 1, "services" : [ { "id" : "3ca04e38-301d-425e-94eb-75ce7fe73efd", "project_id" : "ed202955e111444e8ced21a1bd75fc59", "meta_data" : { "name" : "example" }, "spec" : { "selector" : { "app" : "example-app" }, "ports" : [ { "name" : "http-0", "protocol" : "TCP", "port" : "8090", "target_port" : "8080" } ], "cluster_ip" : "None" }, "created_at" : "2022-09-07 02:28:08.395511 +0000 UTC", "updated_at" : "2022-09-07 02:28:08.395511 +0000 UTC" } ]}
  • URI GET /v2/{project_id}/edgemgr/services 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Long 指定分页查询每页的行数,最大为100,默认值为10。 offset 否 Long 指定要查询的偏移数量,默认为0。 sorted 否 String 响应中查询到的服务将按照指定的字段进行排序 name 否 String 服务名称 app 否 String 按照相关的应用查询服务
  • 响应示例 状态码: 200 创建成功 { "count" : 1, "products" : [ { "id" : "52b7e862-7b86-4b4d-b805-f580c4a25b0b", "name" : "a", "description" : "", "attributes" : { }, "project_id" : "ed202955e111444e8ced21a1bd75fc59", "created_at" : 1667214079 } ]}
  • URI GET /v2/{project_id}/productmgr/products 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回记录的数量限制 offset 否 Integer 偏移量,表示查询该偏移量后面的记录 sort 否 String 显示的条目排列顺序,使用:分隔参考值和顺序, 如sort=created_at%3Adesc表示根据创建时间逆序排列
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 错误码说明 当您使用智能边缘平台的API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见 API错误中心。 表1 错误码说明 错误码 错误信息 描述 处理措施 IEF.011002 The API is not registered. API未注册 确认请求的url是否拼写正确,如果确认使用正确,请联系技术支持工程师协助解决。 IEF.011005 Authentication failed. 认证鉴权失败 使用租户的project_id获取token后重试。如果确认token正确,请联系技术支持工程师协助解决。 IEF.100004 The request offset does not comply with specifications. 请求offset不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100005 The request limit does not comply with specifications. 请求limit不符合规范 查看请求返回体的错误信息,请根据具体失败原因,修改参数值后重试。 IEF.100009 The attached volume does not meet specifications. 挂载卷不符合规范 按照规范正确填写卷类型。 IEF.100010 The application version does not meet specifications. 应用版本不符合规范 按照规范正确填写应用版本的版本名称。 IEF.100011 The application template name does not comply with the specifications. 应用模板命名不符合规范 请按照规范正确填写应用模板名称后重试。 IEF.100012 The resource name does not comply with the specifications. 资源命名不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100013 The environment variable of the application version does not comply with the specifications. 应用版本环境变量不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100020 The application icon storage URL does not meet specifications. 应用图标存储url地址不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100021 The description or remarks of the device binding node do not comply with the specifications. 设备绑定节点,绑定关系描述或备注不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100040 Invalid image path 镜像地址无效 请填写正确的镜像地址后重试。 IEF.100047 The application template visualization parameter type is not supported. 应用模板可视化参数类型不支持 按照规范正确填写,模板可见性属性值仅支持public、private、shared或不填。 IEF.100058 The device has been bound to a node. 设备已经绑定节点 先解绑设备上的节点,再执行删除设备操作。 IEF.100065 The system subscription ID does not meet requirements. 系统订阅ID不符合规范 查看接口文档要求,按照规范正确填写消息主题后重试。 IEF.100067 The node cannot be deleted because it has bound devices. 节点存在绑定的设备,不允许删除 登录IEF控制台,进入“节点管理”页面,找到需要操作的节点,进入节点详情页,确认是否已绑定设备,解绑设备后,重新执行删除节点操作。 IEF.100100 The request parameter is incorrect. 请求参数存在错误 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100112 The configmap/secret of the mounted volume is incorrect. 挂载卷的configmap或secret存在错误 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100113 The resource configuration of the application version does not comply with the specifications. 应用版本资源配置不符合规范 按照规范正确填写应用版本资源配置。 IEF.100119 The name of the application configuration item does not comply with the specifications. 应用配置项命名不符合规范 按照规范正确填写配置项命名。 IEF.100120 The key of the application configuration item does not comply with the specifications. 应用配置项键不符合规范 按照规范正确填写配置项数据key。 IEF.100121 The value of the application configuration item does not meet the specifications. 应用配置项值不符合规范 按照规范正确填写配置项数据value。 IEF.100122 The configuration data of the application configuration item does not comply with the specifications. 应用配置项配置数据不符合规范 按照规范正确填写配置项数据。 IEF.100126 Insufficient resource quota 资源配额不足 请根据返回体中的错误详细原因,修改参数值,确保配额充足再重试。 IEF.100133 The probe configuration of the application version does not meet specifications. 应用版本探针配置不符合规范 按照规范正确填写探针属性,仅支持exec、http_get、tcp_socket_port。 IEF.100148 The name of the application key does not comply with the specifications. 应用密钥命名不符合规范 按照规范正确填写密钥名称。 IEF.100149 The application key data is invalid. 应用密钥数据不符合无效 按照规范正确填写密钥数据。 IEF.100150 The application key data type does not meet specifications. 应用密钥数据类型不符合规范 按照规范正确填写密钥类型。 IEF.100151 The application key does not comply with the specifications. 应用密钥键不符合规范 按照规范正确填写密钥键。 IEF.100152 The application key value does not meet specifications. 应用密钥值不符合规范 按照规范正确填写密钥值。 IEF.100155 The key is in use and cannot be deleted. 密钥在使用中,不允许删除 先停止密钥的使用,再执行删除密钥的动作。 IEF.100159 The application configuration item is in use and cannot be deleted. 应用配置项在使用中,不允许删除 先停止配置项的使用,再执行删除配置项的动作。 IEF.100161 The node is being updated. The application cannot be deleted. 节点更新中,不允许删除应用 先停止节点更新,再执行删除应用的动作。 IEF.100162 The advanced configuration parameters of the application version do not comply with the specifications. 应用版本高级配置参数不符合规范 按照规范正确填写应用版本高级配置参数。 IEF.100163 The node operation type is not supported. 节点操作类型不支持 请指定正确的节点操作类型。 IEF.100165 The application key data includes at least one key-value pair. 应用密钥数据至少包括一个键值对 检查密钥数据是否存在密钥数据记录,至少存在一个密钥记录。 IEF.100166 The node version is earlier than 2.1.5. The node cannot be updated. 节点版本低于2.1.5,不允许更新节点 建议升级节点到最新版本,可以在节点详情页确认节点版本,以及查看节点升级记录。 IEF.100167 Invalid application version schema 应用版本架构无效 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.100404 The resource does not exist. 资源不存在 请确保请求资源参数的正确性,如果确认使用正确,请联系技术支持工程师协助解决。 IEF.100412 Failed to query K8S cluster resources. 查询k8s集群资源失败 内部错误,请联系技术支持工程师协助解决。 IEF.101001 [Service Grid] Failed to convert the structure. 【服务网格】转换结构体失败 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.101002 [Service Grid] The service already exists. 【服务网格】服务已存在 修改服务参数,或者删除已存在的无用服务后重试。 IEF.101003 [Service Grid] The associated application does not exist. 【服务网格】关联应用不存在 确认关联应用是否存在,正确填写关联应用后重试。 IEF.101004 [Service Grid] Failed to Create K8S Cluster Resources 【服务网格】创建k8s集群资源失败 内部错误,请联系技术支持工程师协助解决。 IEF.101005 [Service Grid] Failed to Delete K8S Cluster Resources 【服务网格】删除k8s集群资源失败 内部错误,请联系技术支持工程师协助解决。 IEF.101006 [Service Grid] Failed to Query K8S Cluster Resources 【服务网格】查询k8s集群资源失败 内部错误,请联系技术支持工程师协助解决。 IEF.101007 [Service Grid] Failed to Update K8S Cluster Resources 【服务网格】更新k8s集群资源失败 内部错误,请联系技术支持工程师协助解决。 IEF.104004 The resource to be created already exists. 要创建的资源已经存在 修改资源参数,或者删除已存在的无用资源后重试。 IEF.110074 The specified application template cannot be found. 找不到指定的应用模板 查看相应的应用模板是否存在,正确填写存在的应用模板后重试。 IEF.110076 The specified app version cannot be found. 找不到指定的应用版本 确认指定的应用版本是否存在,正确填写应用版本后重试。 IEF.110080 Specified device not found 指定的设备未找到 确认指定的设备是否存在,正确填写设备后重试。 IEF.110081 The specified device template is not found. 指定的设备模板未找到 确认指定的设备模板是否存在,正确填写设备模板后重试。 IEF.120001 Internal error 内部错误 内部错误,请联系技术支持工程师协助解决。 IEF.130089 Insufficient resource quota 资源配额不足 请确认配额充足后再创建。 IEF.300000 Failed to obtain request parameters. 获取请求参数失败 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300001 The request parameter message endpoint does not meet the requirements. 请求参数消息端点不符合规范要求 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300002 The name of the request parameter message endpoint does not comply with the specifications. 请求参数消息端点命名不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300003 The description of the request parameter message endpoint does not comply with the specifications. 请求参数消息端点描述不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300004 The request parameter message endpoint type is not supported. 请求参数消息端点类型不支持 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300005 The endpoint attribute of the request parameter does not comply with the specifications. 请求参数消息端点属性不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300006 The request parameter message endpoint already exists. 请求参数消息端点已存在 修改消息端点命名,或者在确定不影响业务的情况下,删除已存在的消息端点后重试。 IEF.300007 The specified message endpoint does not exist. 指定消息端点不存在 确定指定的消息端点是否被删除,按照规范正确填写消息端点信息后重试。 IEF.300008 The message endpoint is in use and cannot be deleted. 消息端点在使用中,不允许删除 结束消息端点使用,或者等待消息端点使用结束后,再执行删除操作。 IEF.300009 Message Endpoint Quota Insufficient 消息端点配额不足 请减少资源使用量,或者联系技术支持工程师扩大配额。 IEF.300101 The request parameter message route does not comply with the specifications. 请求参数消息路由不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300102 The routing name of the request parameter does not comply with the specifications. 请求参数消息路由命名不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300103 The message route description of the request parameter does not comply with the specifications. 请求参数消息路由描述不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300104 The source endpoint ID of the message route does not comply with the specifications. 消息路由源端点ID不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300105 The source endpoint resource of the message route does not meet the specifications. 消息路由源端点资源不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300106 The destination endpoint ID of the message route does not comply with the specifications. 消息路由目的端点ID不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300107 The destination endpoint resource of the message route does not meet the specifications. 消息路由目的端点资源不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300108 The specified message route already exists. 指定消息路由已存在 修改消息路由命名,或者在确定不影响业务的情况下,删除已存在的消息路由后重试。 IEF.300109 The specified message route does not exist. 指定消息路由不存在 确定指定的消息路由是否被删除,按照规范正确填写消息路由信息后重试。 IEF.300110 Failed to obtain the message routing request action. 获取消息路由请求action失败 按照规范正确填写消息路由操作action后重试。 IEF.300111 The message routing request action is not supported. 消息路由请求action不支持 按照规范正确填写消息路由操作action后重试。 IEF.300112 The message route is being enabled and cannot be enabled. The message route is being disabled and cannot be disabled. 消息路由已经在启用中,不允许启用;消息路由停用中,不允许停用 登录IEF控制台,在“消息路由”页面找到指定的路由,确定路由当前状态,根据当前业务执行操作,如果路由已经在启用中,就不用再执行启用操作。 IEF.300113 Message routing quota is insufficient. 消息路由配额不足 请减少资源使用量,或者联系技术支持工程师扩大配额。 IEF.300114 The specified DIS channel does not exist. 指定dis通道不存在 确定指定的dis通道是否被删除,按照规范正确填写dis通道信息后重试。 IEF.300115 Invalid DIS channel requested 请求的dis通道无效 确定指定的dis通道是否被删除,按照规范正确填写dis通道信息后重试。 IEF.300116 The requested servicebus path does not meet specifications. 请求的servicebus路径不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300117 The requested eventbus topic does not meet specifications. 请求的eventbus Topic不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300118 The requested eventbus topic already exists. 请求的eventbus Topic已存在 修改eventbus Topic,或者在确定不影响业务的情况下,删除已存在的eventbus Topic后重试。 IEF.300119 The requested APIGW resource does not meet specifications. 请求的apigw的resource不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300120 The requested MQTT topic does not meet specifications. 请求的MQTT的Topic不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300121 Duplicate MQTT topic data. 请求的MQTT的Topic数据重复 修改MQTT的Topic,或者在确定不影响业务的情况下,删除已存在的MQTT的Topic后重试。 IEF.300122 The REST path of the request parameter does not meet the specifications. 请求参数rest路径不符合规范 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300123 Duplicate REST path data in the request parameter. 请求参数rest路径数据重复 修改rest路径或者在确定不影响业务的情况下,删除已存在的rest路径后重试。 IEF.300124 The request parameter device is faulty. 请求参数设备存在问题 根据返回的具体错误信息,或者对照接口文档,确认错误具体原因,修改参数值后重试。 IEF.300125 The requested device does not exist. 请求指定设备不存在 确定指定的设备是否被删除,按照规范正确填写设备信息后重试。 IEF.300126 The requested edge node does not exist. 请求的指定边缘节点不存在 确定指定的边缘节点是否被删除,按照规范正确填写边缘节点信息后重试。 IEF.300127 The requested edge node conflicts. 请求的边缘节点存在冲突 修改边缘节点,或者在确定不影响业务的情况下,删除已存在的边缘节点后重试。 IEF.300128 When the request destination port type is tsdb, the projectID is empty. 请求目的端口类型为tsdb时,projectID为空 请填写正确的project_id后重试。 IEF.300129 When the request destination port type is tsdb, projectID is invalid. 请求目的端口类型为tsdb时,projectID无效 请填写正确的project_id后重试。 IEF.300130 When the request destination port type is tsdb, domain_id is invalid. 请求目的端口类型为tsdb时,domain_id无效 请填写正确的domain_id后重试。 IEF.300131 The URL is invalid when the request destination port type is tsdb. 请求目的端口类型为tsdb时,url无效 请填写正确的URL后重试。 IEF.300132 When the request destination port type is tsdb, the label is invalid. 请求目的端口类型为tsdb时,标签无效 请填写正确的标签后重试。 IEF.300133 The requested edge node does not exist. 请求的边缘节点不存在 确定指定的边缘节点是否被删除,按照规范正确填写边缘节点信息后重试。 IEF.300134 When the request destination port type is tsdb, the resource does not meet the specifications. 请求目的端口类型为tsdb时,资源不符合规范 请填写正确的资源后重试。 IEF.300135 The nodeId is empty or does not comply with the specifications. nodeId为空或不符合规范 请填写正确的nodeId后重试。 IEF.300201 The quota type is incorrect. 配额类型错误 根据返回的具体错误信息,或者对照接口文档,修改配额类型后重试。 IEF.310000 The request does not contain a token. 请求未带token 确认请求header里带上正确的token。 IEF.310001 Failed to obtain the token in the request. 获取请求中token失败 确认填写正确token,或重新获取token。如果确认token正确,请联系技术支持工程师协助解决。 IEF.310002 The token has expired. token已过期 重新获取token。 IEF.310003 Failed to connect to the database. 连接数据库失败 内部错误,请联系技术支持工程师协助解决。 IEF.330000 Failed to connect to the DIS service. 连接dis服务失败 内部错误,请联系技术支持工程师协助解决。 IEF.330001 Failed to connect to the edgebroker. 连接edgebroker失败 内部错误,请联系技术支持工程师协助解决。 IEF.340000 Failed to convert the token. 转换token失败 请确认使用了正确的token,或者请联系技术支持工程师协助解决。 IEF.340001 Internal error 内部错误 内部错误,请联系技术支持工程师协助解决。
  • 请求参数 表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/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 终端设备名称,模糊匹配 node_id 否 String 节点ID, 精确匹配 limit 否 String 每页显示的条目数量,取值范围1~1000,默认为1000 offset 否 String 查询的起始位置,取值范围为非负整数,默认为0 is_binding 否 String 是否绑定到边缘节点,为“true”时返回所有已绑定到节点的设备列表;为“false”则返回未绑定节点的设备列表。 tags 否 String 标签的key和value通过点连接, 多个标签通过逗号连接,如:tags=key1.value1,key2.value2
  • 响应示例 状态码: 200 查询成功 { "devices" : [ { "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" } ], "count" : 1}
共100000条