云应用引擎 CAE-华为云

云应用引擎 CAE-使用前必读:基本概念

基本概念账号用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。用户由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。区域（Region）从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。详情请参见区域和可用区。可用区（AZ，Availability Zone）一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。项目华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。查看项目ID，请参考获取项目ID 图1 项目隔离模型同样在我的凭证下，您可以查看项目ID。企业项目企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

云应用引擎 CAE

云应用引擎 CAE-使用前必读:终端节点

终端节点终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询云审计服务的终端节点。云应用引擎服务的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。表1 云应用引擎服务的终端节点区域名称区域终端节点（Endpoint）非洲-约翰内斯堡 af-south-1 cae.af-south-1.myhuaweicloud.com 亚太-新加坡 ap-southeast-3 cae.ap-southeast-3.myhuaweicloud.com 华东-上海一 cn-east-3 cae.cn-east-3.myhuaweicloud.com 华北-北京四 cn-north-4 cae.cn-north-4.myhuaweicloud.com 华南-广州 cn-south-1 cae.cn-south-1.myhuaweicloud.com

云应用引擎 CAE

云应用引擎 CAE-创建环境:请求示例

请求示例创建环境，环境名称为“test”，组织名“cae-test”，绑定虚拟私有云VPC 。 POST https://{endpoint}/v1/{project_id}/cae/environments { "api_version" : "v1", "kind" : "Environment", "metadata" : { "annotations" : { "vpc_id" : "9b320498-6c39-4fe7-a758-79636dd68a82", "group_name" : "cae-test", "type" : "exclusive", "subnet_id" : "1c75734a-132c-459f-86e2-a3db86a66b86", "security_group_id" : "e6c5a41d-8f47-48bd-a21b-0a4b10766aef" }, "name" : "test" } }

云应用引擎 CAE

云应用引擎 CAE-获取任务详情:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“Job”，该值不可修改。 spec JobSpec object job规格信息。表4 JobSpec 参数参数类型描述 progress Number 任务进度。 status String 任务状态。 tasks Array of Task objects 子任务。表5 Task 参数参数类型描述 index Integer 任务序号。 name String 任务名称。 status String 任务状态。 detail String 任务详情。 created_at String 创建时间。 updated_at String 更新时间。

云应用引擎 CAE 任务

云应用引擎 CAE-获取任务详情:响应示例

响应示例状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Job", "spec" : { "progress" : 0, "status" : "running", "tasks" : [ { "index" : 1, "name" : "upgrade", "status" : "init", "detail" : "", "created_at" : "2023-02-16T11:24:07.950175Z", "updated_at" : "2023-02-16T11:24:07.950175Z" } ] } }

云应用引擎 CAE 任务

云应用引擎 CAE-获取任务详情:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。获取Token ，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String 企业项目ID。创建环境时，环境会绑定企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

云应用引擎 CAE 任务

云应用引擎 CAE-创建域名:响应示例

响应示例状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Domain", "items" : [ { "metadata" : { "id" : "4475ba56-7669-4af8-8707-c9b1368c3f9c", "name" : "example.cn", "created_at" : "2022-12-30T08:33:35.140718Z" } } ] }

云应用引擎 CAE

云应用引擎 CAE-创建域名:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 api_version String API版本，固定值“v1”，该值不可修改。 items Array of DomainItem objects 域名列表。 kind String API类型，固定值“Domain”，该值不可修改。表6 DomainItem 参数参数类型描述 metadata MetaDomain object 响应数据。表7 MetaDomain 参数参数类型描述 id String 域名ID。 name String 域名名称。 created_at String 创建时间。

云应用引擎 CAE

云应用引擎 CAE-创建域名:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String 企业项目ID。创建环境时，环境会绑定企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。表3 请求Body参数参数是否必选参数类型描述 api_version 是 String API版本，固定值“v1”，该值不可修改。 kind 是 String API类型，固定值“Domain”，该值不可修改。 metadata 是 CreateMetaDomain object 请求数据。表4 CreateMetaDomain 参数是否必选参数类型描述 name 是 String 域名名称。

云应用引擎 CAE

云应用引擎 CAE-创建事件通知规则:响应示例

响应示例状态码： 200 请求成功。 { "api_version": "v1", "kind": "NoticeRule", "spec": { "id": "133da017-423c-4e1c-80be-8c8c71c9b84e", "name": "test", "event_name": "Started", "scope": { "type": "environments", "environments": [ "f3c12180-b34a-42d8-bb5a-12ba0a6b579e" ] }, "trigger_policy": { "trigger_type": "immediately" }, "notification": { "protocol": "email", "endpoint": "123@example.com" "template": "ZH" }, "enable": true } }

云应用引擎 CAE

云应用引擎 CAE-创建事件通知规则:请求示例

请求示例创建事件通知规则。 POST https://{endpoint}/v1/{project_id}/cae/notice-rules { "api_version" : "v1", "kind" : "NoticeRule", "spec" : { "name" : "test", "event_name" : "Started", "scope" : { "type" : "environments", "environments" : [ "f3c12180-b34a-42d8-bb5a-12ba0a6b579e" ] }, "trigger_policy" : { "trigger_type" : "immediately" }, "notification" : { "protocol" : "email", "endpoint" : "123@example.com", "template" : "ZH" }, "enable" : true } }

云应用引擎 CAE

云应用引擎 CAE-创建定时启停规则:请求示例

请求示例创建定时启停规则，策略名称为“test-2”，是一个启动策略，生效组件范围涉及环境中的所有组件，触发策略为“执行一次”。 POST https://{endpoint}/v1/{project_id}/cae/timer-rules { "api_version" : "v1", "kind" : "TimerRule", "spec" : { "name" : "test-2", "type" : "start", "cron" : "0 55 16 22 2 ? 2023", "status" : "on", "env_id" : "c41a8e9f-5447-406a-8783-85885f3870a3", "effective_range" : "environment", "effective_policy" : "onetime" } }

云应用引擎 CAE

云应用引擎 CAE-创建定时启停规则:响应示例

响应示例状态码： 200 请求成功。 { "api_version": "v1", "kind": "TimerRule", "items": [ { "id": "string", "name": "string", "type": "start", "env_id": "string", "cron": "0 16 17 31 1 ? 2023", "component_number": 2, "status": "off", "last_execution_status": "normal", "effective_range": "application", "effective_policy": "onetime", "apps": [ { "app_id": "string", "app_name": "string" } ] ] }

云应用引擎 CAE

云应用引擎 CAE-创建定时启停规则:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Enterprise-Project-ID 否 String 企业项目ID。创建环境时，环境会绑定企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。说明：关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 X-Environment-ID 是 String 环境ID。获取环境ID，通过《云应用引擎API参考》的“获取环境列表”章节获取环境信息。请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。表3 请求Body参数参数是否必选参数类型描述 api_version 否 String API版本，固定值“v1”，该值不可修改。 kind 否 String API类型，固定值“TimerRule”，该值不可修改。 spec 否 UpdateTimerRuleDetails object 启停规则规格信息。表4 UpdateTimerRuleDetails 参数是否必选参数类型描述 name 是 String 定时启停规则名称。 type 是 String 定时启停规则的类型：stop/start。 status 是 String 定时启停规则状态（是否开启）：on/off。 apps 否 Array of AppInfo objects 定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。 components 否 Array of ComponentInfo objects 在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。 cron 是 String cron表达式。 effective_range 是 String 定时启停规则生效范围: component/application/environment。 effective_policy 是 String 定时启停规则的定时类别: onetime/periodic。表5 AppInfo 参数是否必选参数类型描述 app_id 否 String 应用ID。 app_name 否 String 应用名称。表6 ComponentInfo 参数是否必选参数类型描述 component_id 否 String 组件ID。 component_name 否 String 组件名称。

云应用引擎 CAE

云应用引擎 CAE-创建定时启停规则:响应参数

响应参数状态码： 200 表7 响应Body参数参数参数类型描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“TimerRule”，该值不可修改。 items Array of TimerRuleDetails objects 启停规则列表。表8 TimerRuleDetails 参数参数类型描述 id String 定时启停规则ID，在创建定时启停规则时会忽略。 name String 定时启停规则名称。 type String 定时启停规则的类型：stop/start。 status String 定时启停规则状态（是否开启）：on/off。 env_id String 环境ID。 apps Array of AppInfo objects 定时启停规则所包含的所有应用，只在生效范围为application的时候需要填写。 components Array of ComponentInfo objects 在定时启停规则所包含的所有组件，只在生效范围为component的时候需要填写。 component_number Integer 定时启停规则包含的组件个数，在创建定时启停规则时会忽略。 cron String cron表达式。 effective_range String 定时启停规则生效范围: component/application/environment。 effective_policy String 定时启停规则的定时类别: onetime/periodic。 last_execution_status String 上次执行的状态：abnormal/normal/executing，在创建定时启停规则时会忽略。表9 AppInfo 参数参数类型描述 app_id String 应用ID。 app_name String 应用名称。表10 ComponentInfo 参数参数类型描述 component_id String 组件ID。 component_name String 组件名称。

云应用引擎 CAE

云服务器内容精选

云应用引擎 CAE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线