检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
调用说明 智能边缘云提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
镜像ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“我的凭证”页面的项目列表中查看账号ID。 图1 获取账号ID
切换操作系统 功能介绍 切换边缘实例操作系统,支持边缘实例创建成功后,保持ip、数据盘不变的情况下重装操作系统。 调用该接口后,系统将卸载系统盘,然后使用新镜像重新创建系统盘,并挂载至实例,实现切换操作系统功能。 接口约束 关机状态或者重装/切换操作系统失败的边缘实例才能执行切换操作。
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 IEC.000000 get the quota failed 查询配额信息失败 内部错误,请稍后重试 400 IEC.000006 the
带宽id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 无 请求示例 DELETE https
终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 父主题: 使用前必读
密钥对名称。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 无 请求示例 DELETE https
您可以使用本文档提供的API对智能边缘云进行相关操作,如创建部署计划、执行部署计划、创建虚拟机私有云等。支持的全部操作请参见API概览。 在调用智能边缘云API之前,请确保已经充分了解智能边缘云相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
安全组的ID。uuid 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 无 请求示例 DELETE https
由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
执行部署计划 场景描述 本章节指导用户通过API执行部署计划,并基于部署计划创建边缘业务。API的调用方法请参见如何调用API 。 约束限制 执行部署计划前,请预先创建好待执行的部署计划。 涉及接口 执行部署计划后将创建一个边缘业务,涉及的接口如下: 执行部署计划:创建边缘业务。
创建部署计划 场景描述 本章节指导用户通过API创建部署计划。API的调用方法请参见如何调用API 。 约束限制 创建部署计划前,请预先创建好虚拟私有云,创建安全组并配置安全组规则,如需使用密钥或私有镜像,需预先创建。 涉及接口 创建部署计划时,需要进行规格查询、边缘站点查询、虚拟私有云查询等操作,涉及的接口如下:
部署计划ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 无 请求示例 DELETE https