华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 终端节点(Endpoint) 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询智能边缘平台的终端节点。 表1 IEF的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京一 cn-north-1 ief2.cn-north-1.myhuaweicloud.com 华北-北京四 cn-north-4 ief2.cn-north-4.myhuaweicloud.com 华东-上海一 cn-east-3 ief.cn-east-3.myhuaweicloud.com 华东-上海二 cn-east-2 ief2.cn-east-2.myhuaweicloud.com 华南-广州 cn-south-1 ief.cn-south-1.myhuaweicloud.com 父主题: 使用前必读
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 响应示例 状态码: 200 ok { "count" : 1, "device_templates" : [ { "property_visitors" : { }, "description" : "", "tags" : { "key1" : "value1" }, "created_at" : "2019-10-09T00:51:11.890571+08:00", "updated_at" : null, "access_protocol" : "userdefine", "twin" : { }, "attributes" : { "ggg" : { "optional" : true, "value" : "ggg", "metadata" : { "type" : "string" } } }, "project_id" : "13b43583216e426b9dc9fad4000e9e1a", "id" : "3950b024-7716-4580-8b85-4ab4bd3eeef0", "name" : "mmmmmmm" } ]}
  • URI GET /v2/{project_id}/edgemgr/device-templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 终端设备名称,模糊匹配 offset 否 String 查询的起始位置,取值范围为非负整数,默认为0 limit 否 String 每页显示的条目数量,取值范围1~1000,默认为1000
  • 请求参数 表3 请求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参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 响应示例 状态码: 201 创建成功 { "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" }}
  • 请求示例 创建一个服务,服务端口名为“http-0”,服务监听的端口号为“8888”,转发到后端Pod的端口号为“80”,TCP协议。 { "service" : { "meta_data" : { "name" : "service-example", "labels" : { } }, "spec" : { "cluster_ip" : "None", "external_ips" : [ ], "external_name" : "", "ports" : [ { "name" : "http-0", "port" : "8888", "target_port" : "80", "protocol" : "TCP", "node_port" : "" } ], "selector" : { "app" : "ief-nginx" }, "type" : "" } }}
  • 响应示例 状态码: 200 查询成功 { "job_count" : 2, "jobs" : [ { "job_name" : "aaa", "job_type" : "deployment_deploy", "job_id" : "66273c66-f72e-4607-8769-3663d255fb83", "status" : "Successful", "created_at" : 1667218308, "status_last_updated_at" : 1667218329, "task_total_count" : 2, "task_failed_count" : 0, "task_success_count" : 2, "description" : "" }, { "job_name" : "test0929-pm", "job_type" : "deployment_deploy", "job_id" : "0a95c8df-eab5-4a8b-a63b-df9f208ad0ce", "status" : "Successful", "created_at" : 1664444410, "status_last_updated_at" : 1664444411, "task_total_count" : 1, "task_failed_count" : 0, "task_success_count" : 1, "description" : "" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 job_count Integer 数目 jobs Array of BatchJobForList objects 批量处理作业详情 表5 BatchJobForList 参数 参数类型 描述 job_id String 批量处理作业ID job_name String 批量处理作业名称 job_type String 批量处理作业类型,支持以下选项: node_upgrade: 节点升级 deployment_deploy:应用部署 deployment_upgrade:应用升级 created_at Integer 创建时间戳 status String 执行状态 task_total_count Integer 任务总数 task_success_count Integer 任务项执行成功数 task_failed_count Integer 任务项执行失败数 status_last_updated_at Integer 状态更新时间戳 description String 任务描述
  • URI GET /v2/{project_id}/productmgr/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 job_type 否 String 批量处理作业类型,支持以下选项: node_upgrade: 节点升级 deployment_deploy:应用部署 deployment_upgrade:应用升级 limit 否 Integer 查询返回记录的数量限制 offset 否 Integer 偏移量,表示查询该偏移量后面的记录 sort 否 String 查询结果排序,如按照创建时间降序排序为created_at:desc,升序排序为created_at:asc
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of EdgeGroupCertListResp objects 查询成功 表5 EdgeGroupCertListResp 参数 参数类型 描述 count Integer 边缘节点组证书数目 groupcerts Array of EdgeGroupCert objects 边缘节点证书详情 表6 EdgeGroupCert 参数 参数类型 描述 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 查询成功 { "count" : 1, "groupcerts" : [ { "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 } ]}
  • 请求参数 表2 请求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/groups/{group_id}/certs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID group_id 是 String 边缘节点组ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回记录的数量限制 offset 否 Integer 偏移量,表示查询该偏移量后面的记录
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”
  • URI GET /v2/{project_id}/routemgr/rules/{rule_id}/errors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID rule_id 是 String 规则ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回记录的数量限制 offset 否 Integer 偏移量,表示查询该偏移量后面的记录
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json” X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 ief-instance-id 否 String 铂金版实例ID,专业版实例为空值
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 满足条件的错误个数 errors Array of Error objects 错误列表 表5 Error 参数 参数类型 描述 detail String 错误详情 ief_instance_id String 铂金版实例ID,如果为空则表示是专业版实例。 project_id String 项目ID rule_id String 规则ID time String 错误发生的时间 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述信息 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述信息
  • 响应示例 状态码: 200 查询成功 { "count" : 3, "node_certs" : [ { "description" : "test device cert", "created_at" : "2020-03-31T14:52:25.405025+08:00", "serial_num" : null, "node_id" : "f66bfc52-db62-4701-b93d-50843262cbfb", "type" : "device", "id" : "104344d9-3e76-4ddc-8a90-ac601d812251", "name" : "device-cert" }, { "description" : "", "created_at" : "2020-03-31T07:32:36.992162+08:00", "serial_num" : "", "node_id" : "f66bfc52-db62-4701-b93d-50843262cbfb", "type" : "system", "id" : "54c66dbf-d0e9-4c25-8843-146199e434ea", "name" : "sys-cert" }, { "description" : "test application cert", "created_at" : "2020-03-31T14:50:28.544569+08:00", "serial_num" : null, "node_id" : "f66bfc52-db62-4701-b93d-50843262cbfb", "type" : "application", "id" : "65e8cb68-5b5d-4777-984c-94d16b39753a", "name" : "app-cert" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 节点上已关联的应用证书和设备证书的数目 node_certs Array of NodeCert objects 节点上的证书列表 表5 NodeCert 参数 参数类型 描述 id String 证书id name String 证书名称 description String 证书的描述 created_at String 证书的创建时间 node_id String 节点id type String 证书类型,包含: system:创建节点时会默认创建一套系统证书 application:应用证书 device:设备证书 serial_num String 证书序列号
  • 请求参数 表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/{node_id}/certs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID node_id 是 String 节点ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询返回记录的数量限制 offset 否 Integer 偏移量,表示查询该偏移量后面的记录
  • 响应参数 状态码: 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 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" }}
  • 响应示例 状态码: 201 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" }}
共100000条