华为云用户手册

响应示例 { "config_groups": [{ "id": "0f5722ea-ee97-42bf-8583-404caa0a46e5", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test1", "description": "", "create_time": 1717482692680, "creator": "ss-test" }, { "id": "49cb9636-9f89-44c3-af68-95282887b377", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test2", "description": "", "create_time": 1717481328004, "creator": "ss-test" }], "count": 2 }

URI GET /v3/{project_id}/cas/config-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 表2 查询参数 参数 是否必选 参数类型 描述 name 否 String 配置分组名称。 limit 否 integer 指定个数，取值[0, 100]。 offset 否 integer 指定偏移量。 order_by 否 String 排序字段，默认按创建时间排序。 排序字段支持枚举值： create_time，配置分组创建时间。 name，配置分组名称。 update_time，配置分组修改时间。 order 否 String 排序方式。 desc，降序排序，默认排序方式。 asc，升序排序。

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 配置分组总数。 config_groups Array of objects 分组列表，请参考表5。 表5 config_groups 参数 参数类型 描述 id String 配置分组ID。 project_id String 项目ID。 name String 配置分组名称。 description String 配置分组描述。 creator String 创建人。 create_time Integer 创建时间。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。

请求示例 创建软件包部署的应用微服务组件，运行时设置为Java8，组件软件包来源选择存储在obs下myapp桶中的demo.jar包。 { "name": "mycomponent", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "build": { "parameters": { "artifact_namespace": "ns", "use_public_cluster": false, "cluster_id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "cluster_name": "cce-test", "cluster_type": "VirtualMachine" } }, "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" } } } }

响应示例 { "id": "384eb8d4-c193-4d84-9558-6fda2366b536", "name": "mycomponent", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "project_id": "384eb8d4-c193-4d84-9558-6fda23698536", "application_id": "a8f7eed5-0aa0-4251-9723-c9119a6bf56d", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://myapp/demo.jar", "properties": { "bucket": "myapp", "key": "demo.jar", "endpoint": "https://obs.region_id.external_domain_name.com" } } }, "build": { "id": "w3dpv7p0t1vpxvey5hjb22iuwxway1vupwx0nae1", "parameters": { "artifact_namespace": "ns", "dockerfile_path": "./" } }, "status": 0, "creator": "test_user", "create_time": 1610333934288, "update_time": 1610333934288 }

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

URI DELETE /v2/{project_id}/cas/applications/{application_id}/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 environment_id 是 String 环境ID。获取方法，请参考获取所有环境。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 { "id": "1cfdda6f-84cd-4ead-8e09-628fabf662e2", "name": "test-micro", "runtime": "Java8", "category": "MicroService", "sub_category": "Java Chassis", "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "application_id": "4d92833a-fa05-4fc0-a761-e67620022310", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://test-soft/fusionweather-1.0.0.jar", "auth": "iam", "properties": { "bucket": "test-soft", "endpoint": "https://obs.region_id.development.com:443", "key": "fusionweather-1.0.0.jar" } } }, "build": { "id": "zpdkj42b3rnko8bmyojzt1ng828ubychw13j8flv", "parameters": { "artifact_namespace": "ns", "cluster_id": "523498f1-36c4-11eb-ae36-0255ac1000c2" } }, "status": 0, "creator": "ss-test", "create_time": 1610331760105, "update_time": 1610519881943 }

请求示例 修改指定组件ID对应的组件信息，修改组件名称为test-micro，设置组件软件包来源为存储在obs下test-soft桶中的fusionweather-1.0.0.jar包，指定cce-test集群为组件构建集群。 { "name": "test-micro", "description": "", "source": { "kind": "artifact", "spec": { "storage": "obs", "type": "package", "url": "obs://test-soft/fusionweather-1.0.0.jar", "auth": "iam", "webUrl": "", "properties": { "bucket": "test-soft", "endpoint": "https://obs.region_id.development.com:443", "key": "fusionweather-1.0.0.jar" } } }, "build": { "parameters": { "artifact_namespace": "ns", "use_public_cluster": false, "cluster_id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "cluster_name": "cce-test", "cluster_type": "VirtualMachine" } }, }

URI PUT /v2/{project_id}/cas/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。

响应示例 { "configuration": [ { "application_id": "e5213b62-0e3c-476f-9960-3e4108787350", "environment_id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "configuration": { "env": [ { "name": "env", "value": "value1" } ] } } ] }

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表4 响应参数 参数 参数类型 描述 configuration Array of objects 配置信息，请参考表5。 表5 应用配置信息 参数 参数类型 描述 application_id String 应用ID。 environment_id String 环境ID。 configuration Object 应用配置信息，请参考表6。 表6 configuration 参数 参数类型 描述 env Array of objects 应用组件环境变量，请参考表7。 表7 env 参数 参数类型 描述 name String 环境变量名称 value String 环境变量取值

URI GET /v2/{project_id}/cas/applications/{application_id}/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 environment_id 否 String 环境ID，如果未提供，查询所有环境。获取方法，请参考获取所有环境。

响应消息 表4 响应参数 参数 参数类型 描述 id String 目标服务ID。 host String 目标服务host信息。 host信息由目标服务的接入引擎后的微服务名、微服务所在环境名、微服务所属应用名称已经微服务接入的引擎类型组成，以点号（.）分隔。 例如，unit-controller.testing.test-application.servicecomb。unit-controller为接入引擎的微服务名称，testing为unit-controller微服务所在环境名，test-application为unit-controller微服务所属应用名称，servicecomb表示unit-controller微服务接入的是ServiceComb引擎。 name String 目标服务名称。 service_source_name String 目标服务对应的服务来源名称。 engine_id String 目标服务对应的服务来源引擎ID。 engine_type String 目标服务对应的服务来源引擎类型。 swimlane_group_id String 泳道组ID。 swimlane_group_name String 泳道组名称。 status String 目标服务状态。 TARGET_SERVICE_MANAGED：目标服务已经被纳管。 MICROSERVICE_OF_TARGET_SERVICE_UNROUTING：目标服务对应的微服务不支持路由。 MICROSERVICE_OF_TARGET_SERVICE_MANAGED：目标服务对应的微服务被纳管。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应示例 [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "service_source_name": "cscs", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb", "swimlane_group_id": null, "swimlane_group_name": null, "status": null }, { "id": "8d8d5d85-2ae6-463b-b2e9-0fa9d9a0aa7d", "host": "test.static", "name": "test", "service_source_name": "static", "engine_id": null, "engine_type": null, "swimlane_group_id": null, "swimlane_group_name": null, "status": "MICROSERVICE_OF_TARGET_SERVICE_UNROUTING" } ]

响应消息 表5 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 应用创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 应用创建时间。 update_time Integer 应用修改时间。 labels Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表6。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。

响应示例 { "id": "dae29983-c1e9-437d-a6be-5256076fe605", "name": "app-xpmtii", "description": "test", "project_id": "063a3158b1a34710b36ad208b9497d00", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1679468852302, "update_time": 1679468852302, "labels": [ { "key": "key", "value": "var" } ] }

请求示例 创建名称为app-xpmtii的应用，描述信息输入test，标签键值对设置为"key":"var"。 { "name": "app-xpmtii", "description": "test", "labels": [ { "key": "key", "value": "var" } ] }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 应用名称。 由英文字母、数字、中划线（-）或下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，长度为2~64个字符。 description 否 String 应用描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 labels 否 Array of objects 标签，可使用标签管理服务通过标签过滤资源，请参考表4。 同一个应用下最多可以添加20个标签。 表4 labels 参数 是否必选 参数类型 描述 key 是 String 标签名称。 标签用于标识资源，当您拥有相同类型的许多资源时，可以使用标签按各种维度（例如用途、所有者或环境）对资源进行分类。 长度为1到36个字符，只能包含数字、英文字母、下划线（_）、中划线（-）或中文。 value 是 String 标签值。 长度为1到43个字符，只能包含数字、英文字母、下划线（_）、点（.）、中划线（-）或中文。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 route_status 是 String 泳道路由状态。 ENABLE：开启路由。 DISABLED：关闭路由。

响应示例 { "job": { "JOB_ID": "JOB474362ef-091d-429f-9b3e-c9246b37dee6", "JOB_NAME": "provision/provMain", "JOB_TYPE": "PROVISION", "SERVICE_INSTANCE_ID": "429a35a0-dee8-4648-86f6-d1f8bc74ba52", "PROJECT_ID": "063a3158b1a34710b36ad208b9497d00", "ORDER_ID": "", "JOB_DESC": "provision/provMain", "EXECUTION_STATUS": "FAILED", "CREATED_BY": "585cc5c16cda4954b28d4eb460f06261" }, "tasks": [ { "MESSAGES": "{}", "TASK_ID": "Task-bc64b46c-1688-4787-b7ff-87cb53b346ea", "TASK_TYPE": "echo", "TASK_INDEX": 1, "TASK_NAME": "SEPARATOR_PREPARE_RESOUR CES ", "TASK_STATUS": "SUCCEEDED", "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.344Z", "CREATED_AT": "2020-02-04T04:01:03.344Z", "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114" }, { "MESSAGES": "{}", "TASK_ID": "Task-15ec252f-bca0-401e-ae5b-798a639df92e", "TASK_TYPE": "echo", "TASK_INDEX": 4, "TASK_NAME": "SEPARATOR_BUILDING", "TASK_STATUS": "SUCCEEDED", "LAST_HEALTH_CHECK": "2020-02-04T04:01:03.346Z", "CREATED_AT": "2020-02-04T04:01:03.345Z", "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114" }, { "MESSAGES": "{}", "TASK_ID": "Task-52a5d1ae-2c54-46ec-8134-53e7b6a45fb7", "TASK_TYPE": "restful", "TASK_INDEX": 6, "TASK_NAME": "TN00091", "TASK_STATUS": "SUCCEEDED", "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.924Z", "CREATED_AT": "2020-02-04T04:01:03.346Z", "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114" }, { "MESSAGES": "{}", "TASK_ID": "Task-a149b585-d31b-4c72-a665-d820efcb0bf9", "TASK_TYPE": "restful", "TASK_INDEX": 7, "TASK_NAME": "TN00094", "TASK_STATUS": "SUCCEEDED", "LAST_HEALTH_CHECK": "2020-02-04T04:01:08.961Z", "CREATED_AT": "2020-02-04T04:01:08.925Z", "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114" }, { "MESSAGES": "{ \"Message\" : \"ECC00011\", \"Detail\" : \"Building failed.\" }", "TASK_ID": "Task-a72fe8d8-8cc1-42b5-a097-0cf9e29692a7", "TASK_TYPE": "restful", "TASK_INDEX": 9, "TASK_NAME": "TN00097", "TASK_STATUS": "FAILED", "LAST_HEALTH_CHECK": "2020-02-04T04:01:38.975Z", "CREATED_AT": "2020-02-04T04:01:08.962Z", "OWNER_ID": "cas-mgr-69bb87d7c-wpqwb:30114" } ], "task_count": 5 }

URI GET /v2/{project_id}/cas/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 job_id 是 String 部署任务ID，为创建组件实例接口响应参数的job_id。 表2 查询参数 参数 是否必选 参数类型 描述 instance_id 否 String 应用组件实例ID。获取方法，请参考获取组件实例。 limit 否 Integer 指定个数。 offset 否 Integer 指定偏移量。 desc 否 String 是否降序： true=desc，false=asc。

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

响应消息 表5 响应参数 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 alias String 环境别名。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 charge_mode String 收费模式。 deploy_mode String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 vpc_id String 虚拟私有云ID。 base_resources Array of objects 基础资源，请参考表6，返回为空。 optional_resources Array of objects 可选资源，请参考表6，返回为空。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表6 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。