华为云用户手册

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Application", "metadata" : { "id" : "02022b3f-0594-496e-b34e-b41acd2bdde4", "name" : "test", "created_at" : "2022-06-10T06:49:24.836171213Z", "updated_at" : "2022-06-10T06:49:24.836171213Z" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“Application”，该值不可修改。 metadata metadata object 响应数据。 表6 metadata 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 created_at String 创建时间。 updated_at String 更新时间。

请求参数 表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类型，固定值“Application”，该值不可修改。 metadata 是 metadata object 请求数据。 表4 metadata 参数 是否必选 参数类型 描述 name 是 String 应用名称。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“Component”，该值不可修改。 items Array of MountComponent objects 挂载组件列表。 表4 MountComponent 参数 参数类型 描述 env_id String 环境ID。 env_name String 环境名称。 app_id String 应用ID。 app_name String 应用名称。 component_id String 组件ID。 component_name String 组件名称。

响应示例 状态码： 200 返回{}表示成功，返回组件信息，表明这些组件挂载了当前 云存储 ，当前云存储不能解绑。 { "api_version" : "v1", "kind" : "Component", "items" : [ { "env_id" : "5d3d1e90-2f5d-4ef1-958b-3fc1ed0b0898", "env_name" : "test", "app_id" : "c904781d-aea0-49d4-b756-9b847a10a437", "app_name" : "test", "component_id" : "f5de88cc-64be-4f70-ac17-db745eb76e67", "component_name" : "test-config" } ] }

请求参数 表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。

请求示例 使用源码仓库创建组件，组件名称“test-code”，版本“1.0.0”，选择GitLab源码仓库，运行时为Java8。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-code", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_path" : "./Dockerfile" } }, "source" : { "type" : "code", "sub_type" : "GitLab", "url" : "https://xxx:8090/xxx/cae-frontend.git", "code" : { "branch" : "master", "auth_name" : "gitlab-xxx", "namespace" : "em1n" } }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } } 使用镜像创建组件，组件名称“test-image”，版本“1.0.0”，选择nginx镜像，运行时为Docker。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-image", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Docker", "source" : { "type" : "image", "url" : "nginx:stable-alpine-perl" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } } 使用软件包创建组件，组件名称“test-jar”，版本“1.0.0”，在OBS对象存储中选择名称为“forecast-1.0.0.jar”的软件包，运行时为Java8。 POST https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components { "api_version" : "v1", "kind" : "Component", "metadata" : { "name" : "test-jar", "annotations" : { "version" : "1.0.0" } }, "spec" : { "runtime" : "Java8", "build" : { "archive" : { "artifact_namespace" : "xxx" }, "parameters" : { "base_image" : "openjdk:8u181-jdk-alpine", "dockerfile_content" : "FROM java:8 \\nADD forecast-1.0.0.jar \\nEXPOSE 8080 \\nENTRYPOINT [\"java\",\"-jar\",\"forecast-1.0.0.jar\"]" } }, "source" : { "type" : "softwarePackage", "sub_type" : "BinObs", "url" : "https://xxx.obs.region.xxx.huawei.com/xxx/forecast-1.0.0.jar" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "replica" : 1 } }

响应示例 状态码： 200 请求成功。 { "api_version": "v1", "kind": "Component", "metadata": { "id": "cac09548-047f-46c4-abbd-a6a652305565", "name": "test-code", "annotations": { "log_group_id": "5b13213a-84f8-4b72-8ca5-530e15cc1402", "log_stream_id": "6ddf6c71-4767-46db-98a2-fe5fb301b366", "version": "1.0.0" }, "created_at": "2023-02-13T02:38:22.689607114Z", "updated_at": "2023-02-13T02:38:22.689607114Z" }, "spec": { "runtime": "Java8", "env_id": "9819b3f5-dd08-44ff-ba88-eb38e435594c", "replica": 1, "source": { "type": "code", "sub_type": "GitLab", "url": "http://xxx@cpe.gitlab.com:8090/xxx/cae-backend.git", "code": { "branch": "master", "auth_name": "gitlab-xxx", "namespace": "em1n" } }, "build": { "archive": { "artifact_namespace": "xxx" }, "parameters": { "base_image": "openjdk:8u181-jdk-alpine" "dockerfile_path": "./Dockerfile" } }, "resource_limit": { "cpu_limit": "500m", "memory_limit": "1Gi" }, "available_replica": 0, "status": "created" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“ComponentSnapshot”，该值不可修改。 items Array of ComponentSnapshotItem objects 快照列表。 表4 ComponentSnapshotItem 参数 参数类型 描述 component_id String 组件ID。 index Integer 快照索引。 context ComponentSnapshotContext object 上下文信息。 created_at String 创建时间。 updated_at String 更新时间。 表5 ComponentSnapshotContext 参数 参数类型 描述 app_id String 应用ID。 available_replica Integer 可用实例个数。 build String 组件构建信息。 build_id String 构建任务ID。 build_log_id String 构建日志ID。 env_id String 环境ID。 id String 组件ID。 image_url String 镜像地址。 job_id String 任务ID。 log_group_id String LTS日志组的ID。 log_stream_id String LTS日志流的ID name String 组件名称。 operation String 组件操作。 operation_status String 组件操作状态。 replica Integer 实例个数。 resource_limit String 组件规格。 runtime String 语言/运行时。 source String 组件源信息。 status String 组件状态。 version String 组件版本。 created_at String 创建时间。 updated_at String 更新时间。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "ComponentSnapshot", "items" : [ { "component_id" : "79229698-e2ec-47db-81df-599b59a9fc17", "index" : 1, "context" : { "app_id" : "d65fd1d7-9df8-424f-ba4d-44b1bb7cfc05", "available_replica" : 1, "build" : "{\"archive\":{\"artifact_namespace\":\"cae-test\"},\"parameters\":{\"base_image\":\"\"}}", "env_id" : "7eb2f920-e183-4d4e-9b9d-fffb875ae520", "id" : "79229698-e2ec-47db-81df-599b59a9fc17", "image_url" : "nginx:stable-alpine-perl", "job_id" : "4681ac3f-5771-4d98-97ad-9e25171b26b8", "log_group_id" : "96fe4c34-578a-4ea8-8e77-ee59bf8a0fd1", "log_stream_id" : "9c024ad2-5c80-45ee-8651-5f2bd89d3c7e", "name" : "test", "operation" : "deploy", "operation_status" : "started", "replica" : 1, "resource_limit" : "{\"cpu_limit\":\"500m\",\"memory_limit\":\"1Gi\"}", "runtime" : "Docker", "source" : "{\"type\":\"image\",\"url\":\"nginx:stable-alpine-perl\"}", "status" : "running", "version" : "1.0.0", "created_at" : "2023-02-27T06:22:46.812877Z", "updated_at" : "2023-02-27T06:22:46.812877Z" }, "created_at" : "2023-02-27T08:26:39.362226Z", "updated_at" : "2023-02-27T08:26:39.362226Z" } ] }

URI GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/snapshots 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表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。

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

响应示例 状态码： 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" } } ] }

请求参数 表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。

URI GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 application_id 是 String 应用ID。 component_id 是 String 组件ID。

请求参数 表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。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Component", "metadata" : { "id" : "b04980af-5f20-49ec-b499-79b5a4eb8a43", "name" : "test", "annotations" : { "log_group_id" : "96fe4c34-578a-4ea8-8e77-ee59bf8a0fd1", "log_stream_id" : "9c024ad2-5c80-45ee-8651-5f2bd89d3c7e", "version" : "1.0.0" }, "created_at" : "2023-03-03T03:32:10.040303Z", "updated_at" : "2023-03-03T03:32:10.040303Z" }, "spec" : { "runtime" : "Docker", "env_id" : "7eb2f920-e183-4d4e-9b9d-fffb875ae520", "replica" : 1, "source" : { "type" : "image", "url" : "nginx:stable-alpine-perl" }, "resource_limit" : { "cpu_limit" : "500m", "memory_limit" : "1Gi" }, "image_url" : "nginx:stable-alpine-perl", "available_replica" : 1, "job_id" : "c96c6907-5c69-4d72-bce0-03926a857b21", "status" : "running" } }

请求示例 创建CAE环境访问VPC配置。 POST https://{endpoint}/v1/{project_id}/cae/vpc-egress { "api_version" : "v1", "kind" : "VpcEgress", "spec" : { "cidrs" : [ { "cidr" : "test_cidr", "route_table_id" : "test_route_table_id" } ] } }

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "VpcEgress", "spec" : { "vpc_id" : "test_vpc_id", "subnet_id" : "test_subnet_id", "cidrs" : [ { "cidr" : "192.168.0.0/24", "id" : "test_id", "route_table_id" : "test_route_table_id" } ] } }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“VpcEgress”，该值不可修改。 spec VpcEgressResponseBodySpec object 创建CAE环境访问VPC配置。 表7 VpcEgressResponseBodySpec 参数 参数类型 描述 vpc_id String CAE环境VPCID。 subnet_id String CAE环境子网ID。 cidrs Array of EgressCidr objects CAE环境访问VPC配置。 表8 EgressCidr 参数 参数类型 描述 cidr String 目的网络Cidr。 route_table_id String 目的网络所属CAE环境VPC的路由表ID。 id String CAE环境访问VPC配置ID。

请求参数 表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类型，固定值“VpcEgress”，该值不可修改。 spec 否 VpcEgressRequestBodySpec object 创建CAE环境访问VPC配置。 表4 VpcEgressRequestBodySpec 参数 是否必选 参数类型 描述 cidrs 是 Array of EgressCidr objects CAE环境访问VPC配置。 表5 EgressCidr 参数 是否必选 参数类型 描述 cidr 是 String 目的网络Cidr。 route_table_id 是 String 目的网络所属CAE环境VPC的路由表ID。 id 否 String CAE环境访问VPC配置ID。

请求参数 表3 请求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。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "Volume", "items" : [ { "id" : "a061934d-52e3-4b36-aea7-6c51879f84c9", "resource_name" : "test", "resource_sub_type" : "parallel_file_system", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "access" : "xxx", "time" : "2023-02-08T09:31:39.858115Z" }, { "id" : "bef119d0-c7d1-4b58-9794-8b74faf80a59", "resource_name" : "test-nacos", "resource_sub_type" : "object_bucket", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "access" : "xxx", "time" : "2023-02-08T09:31:49.232412Z" }, { "id" : "ece8ebcd-3f1e-4175-98ea-369036acbfce", "resource_name" : "test-nginx", "resource_sub_type" : "parallel_file_system", "resource_info" : { "capacity" : "0.00MB", "obsType" : "STANDARD", "region" : "region" }, "access" : "xxx", "time" : "2023-02-15T03:24:08.146911Z" } ] }

请求参数 表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的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

请求参数 表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的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "MonitorSystem", "spec" : { "id" : "3ae303c7-10e2-497f-8e2c-79b47a******", "type" : "opentelemetry", "instrumentation" : "automatic", "access_token" : "******", "apm_application" : "test", "version" : "1.32.0.14", "image_pull_policy" : "Always", "created_at" : "2023-12-08T13:16:39.606846Z", "updated_at" : "2023-12-10T12:01:12.367968Z" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 api_version String API版本，固定值“v1”，该值不可修改。 kind String API类型，固定值“MonitorSystem”，该值不可修改。 spec ShowMonitorSystemResponseBodySpec object 查询监控系统详情。 表4 ShowMonitorSystemResponseBodySpec 参数 参数类型 描述 id String 监控系统id。 type String 采集方式。 instrumentation String 探针注入方式。 access_key String apm2访问密钥Key。 access_value String apm2访问密钥value。 access_token String apm2 opentelemetry接入token。 master_address String 探针接入点。 apm_application String apm2应用。 version String 增强型探针/opentelemetry探针版本。 image_pull_policy String 探针镜像更新策略。 created_at String 创建时间。 updated_at String 更新时间。

请求参数 表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。

响应示例 状态码： 200 请求成功。 { "api_version" : "v1", "kind" : "VpcEgress", "spec" : { "vpc_id" : "test_vpc_id", "subnet_id" : "test_subnet_id", "cidrs" : [ { "cidr" : "192.168.0.0/24", "id" : "test_id", "route_table_id" : "test_route_table_id" } ] } }