检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 CAE API为符合API设计规范的自研接口。 环境接口 表1 环境接口介绍 API 说明 获取环境列表 此API用来获取当前项目下的环境列表。 创建环境 此API用来创建环境。 删除环境 此API用来删除对应的环境。 云存储接口 表2 卷接口介绍 API 说明 获取云存储列表
CAE API 环境 应用 组件 组件配置 云存储 委托 任务 域名 证书 定时启停规则 弹性公网IP 监控系统 CAE环境访问VPC 事件通知规则
如何调用API 构造请求 认证鉴权 返回结果
创建应用 本示例在环境下创建一个应用。 概述 本文通过调用创建组件接口创建一个组件。 API的调用方法请参见3 如何调用API。 操作步骤 创建应用。 调用创建应用接口,请求示例如下。 curl -k -H "Content-Type:application/json" -H "X-Environment-ID:
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本,固定值“v1”,该值不可修改。
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token
X-Environment-ID 是 String 环境ID。 获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 响应参数 无 请求示例 删除应用。 DELETE https
对于“管理员创建IAM用户”接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于“管理员创建IAM用户”接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID username为要创建的IAM用户名。 email为IAM用户的邮箱。
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本,固定值“v1”,该值不可修改。
X-Environment-ID 是 String 环境ID。 获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 响应参数 无 请求示例 删除证书。 DELETE https
vpc_id:创建环境绑定的VPC的ID。 group_name:创建环境绑定的SWR组织的组织名称。 type:环境类型,当前仅支持exclusive类型。 subnet_id: 创建环境绑定的VPC子网的ID。 security_group_id:创建环境绑定的安全组的ID,可不填,不填由CAE后台自动创建。
环境下面创建对应的应用、组件等。 下面介绍如何调用创建环境接口,API的调用方法请参见3 如何调用API。 前提条件 您需要规划环境所在的区域信息,并根据区域确定调用API的Endpoint,详细信息请参见地区和终端节点。 操作步骤 创建环境。 调用创建环境接口,请求示例如下: curl
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本,固定值“v1”,该值不可修改。
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本,固定值“v1”,该值不可修改。
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本,固定值“v1”,该值不可修改。
X-Environment-ID 是 String 环境ID。 获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 响应参数 无 请求示例 删除域名。 DELETE https
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 api_version 是 String API版本,固定值“v1”,该值不可修改。
X-Auth-Token 是 String 用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String
获取环境ID,通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息,其中id字段即是环境ID。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本,固定值“v1”,该值不可修改。