华为云用户手册

请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称，通过获取仓库授权列表获取对应的授权名称。 表4 请求Body参数 参数 是否必选 参数类型 描述 message 是 String 描述。 content 是 String base64编码后的文件内容。

URI POST /v1/{project_id}/git/files/{namespace}/{project}/{path} 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。 path 是 String 文件路径，需要将“/”替换为“:”。获取方法，请参考获取仓库文件目录。 表2 查询参数 参数 是否必选 参数类型 描述 ref 是 String 分支名称或者tag名称或者commit哈希。

响应消息 表3 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 创建时间。 update_time Integer 修改时间。 unified_model String 是否开启统一模型，返回固定值null。 component_count Integer 包含组件个数。

响应示例 { "id": "e5213b62-0e3c-476f-9960-3e4108787350", "name": "app-test", "description": "test", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1610432385245, "update_time": 1610433070875, "unified_model": null, "component_count": 0 }

请求消息 表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。 X-Repo-Auth 是 String 授权名称。通过获取仓库授权列表获取对应的授权名称。

URI DELETE /v1/{project_id}/git/repos/{namespace}/{project}/hooks/{hook_id} 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。 hook_id 是 String hook ID。获取方法，请参考获取项目hooks。

响应示例 { "id": "8f8a5b33-ee1f-4a70-b3a9-c1b179a69fd2", "name": "base", "swimlane_group_id": "5447f910-ab74-4d15-b2ab-dd0945900ce9", "type": "BASE", "tag": "base", "route_status": "ENABLE", "rule_match_mode": null, "project_id": "86a1f7b663b349e89071a3090d9d81f3", "rules": null, "creator": "test_user", "create_time": 1722848532908, "update_time": 1722848532908, "instances": [ { "componentId": "0b582884-1ad0-4183-8d6d-16998f54818f", "id": "887f99d7-4ce5-431d-924f-6a328cb05572", "name": "comp-uh59l7s2", "version": "1.0.0", "application_id": "70502782-4f93-4eda-af19-415bac2d12ae", "application_name": "app-apitest-1o6l", "replica": 0 } ], "instance_count": 1, "weight": 100, "batch_status": null, "latest_opt": null, "release_plan_id": null }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 为泳道关联移除组件操作。 ADD：关联组件。 REMOVE：移除组件。 instance_ids 是 Array of String 组件实例列表。

响应消息 表4 响应参数 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE：基线泳道。 GRAY：灰度泳道。 tag String 泳道标签，根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE：开启路由。 DISABLED：关闭路由。 rule_match_mode String 路由规则匹配模式。 当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。 ALL：匹配所有的规则。 ANY：匹配任一规则。 rules Array of objects 路由规则。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。请参考表5。 weight Integer 泳道流量权重，范围在0-100之间。当泳道组灰度类型为基于流量，即gray_release_type为WEIGHT时生效。 instances Array of objects 泳道中纳管的组件列表，请参考表6。 instance_count Integer 泳道中纳管的组件个数。 latest_opt String 泳道上一步的操作。 CLONE：克隆。 UPGRADE：升级。 ROLLBACK：回滚。 CREATE：创建。 release_plan_id String 泳道上一步操作关联的发布单ID。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表5 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT：精确匹配。 PREFIX：前缀匹配。 REGEX：正则匹配。 表6 instances 参数 参数类型 描述 id String 应用组件实例ID。 name String 应用组件实例名称。 version String 应用组件版本号。 application_id String 应用ID。 component_id String 组件ID。 application_name String 应用名称。 replica Integer 实例副本数。

响应示例 { "components": [ { "source": { "kind": "package", "url": "obs://bucket0001/weather-1.0.0.jar", "storage": "obs" }, "name": "mycomponent", "id": "b8702b0f-94d3-4822-98a1-56815632a0a0", "labels": null, "runtime_stack": { "name": "OpenJDK8", "deploy_mode": "virtualmachine", "version": "1.1.1" }, "external_accesses": null, "status": { "component_status": "RUNNING", "available_replica": 1, "replica": 1, "fail_detail": null, "last_job_id": "JOB8be53b2a-af9a-4e2b-8505-096688a52237", "creator": "ss-test", "create_time": 1679556221028, "update_time": 1679556318779 }, "environment_name": "sudo", "environment_id": "4d084044-0b80-4641-963c-b9c9f4092a4f", "application_name": "app-39mbbn", "application_id": "fc092465-a5fb-4a52-bc65-b735f18366d8", "creator": "ss-test", "platform_type": "cce", "version": "2023.0323.15181" } ], "count": 1 }

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 组件总数。 components Array of objects 组件参数，请参考表5。 表5 components 参数 参数类型 描述 id String 组件ID。 name String 组件名称。 labels Array of objects 标签。容器部署方式部署的组件可通过标签查询对应工作负载；虚机部署方式部署的组件可配置对应的微服务名称的标签来使用优雅上下线功能，请参考表10。 status Object 组件状态，请参考表8。 runtime_stack Object 技术栈，请参考表7。 application_name String 应用名称。 application_id String 应用ID。 environment_name String 环境名称。 environment_id String 环境ID。 version String 组件版本号。 source Object 代码/软件包来源，请参考表6。 creator String 组件创建人。 platform_type String 组件部署类型。 external_accesses Array of objects 外部访问，请参考表11。 表6 source 参数 参数类型 描述 kind String 组件来源类型。 code，源码。 package，软件包。 image，镜像包。 version String 版本号。 url String 包地址，类型为package和image时需要添加。 storage String 存储方式，支持镜像仓库swr、软件仓库swr、软件开发生产线codearts和对象存储obs，类型为package和image时需要添加。 auth String 认证方式，支持iam、none，默认是iam。 repo_auth String 授权名称，在授权列表获取。 repo_namespace String 代码仓库命名空间。 repo_ref String 代码分支或者Tag，默认是master。 repo_type String 代码仓类型，支持CodeArts、Gitee、GitHub、BitBucket、GitLab。 web_url String 代码跳转链接，例如：https://github.com/example/demo.git。 repo_url String 代码仓url，例如：https://github.com/example/demo.git。 表7 runtime_stack 参数 参数类型 描述 name String 技术栈名称，例如：OpenJDK8。 type String 技术栈类型，支持Java、Tomcat、Nodejs、Php、Docker、Python。 当部署模式为虚机部署时，仅支持Java、Tomcat、Nodejs；容器部署上述类型都支持。 version String 技术栈版本，例如：1.1.4。 deploy_mode String 部署模式。 容器部署，container。 虚机部署，virtualmachine。 表8 status 参数 参数类型 描述 component_status String 组件状态。 INITIALIZING，初始化。 UPGRADING，升级中。 FAILED，失败。 RUNNING，运行中。 DOWN，下线。 DELETING，删除中。 DELETED，已删除。 RESERVED，保留。 STARTING，启动中。 STOPPING，停止中。 STOPPED，停止。 RESTARTING，重启中。 PENDING，未就绪。 UNKNOWN，未知。 PARTIALLY_FAILED，部分失败。 available_replica Integer 可用实例。 replica Integer 总实例。 fail_detail String 失败原因。 cluster_deleted，集群被删除。 cluster_unavailable，集群不可用。 cluster_inaccessible，集群无法访问。 namespace_deleted，命名空间被删除。 namespace_unavailable，命名空间不可用。 namespace_inaccessible，命名空间无法访问。 resource_deleted，资源已删除。 create_failed，创建组件失败。 delete_failed，删除组件失败。 last_job_id String 最后执行任务ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 artifact Object 组件构建信息，请参考表9。 表9 artifact 参数 参数类型 描述 type String 组件来源类型。 虚拟机部署支持软件包package。 容器部署支持软件包package、镜像包image。 url String 软件包/镜像地址。 表10 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。 表11 external_accesses 参数 参数类型 描述 protocol String 外部访问类型，取值范围为：http、https。 address String 外部访问地址。 forward_port Integer 外部访问端口。

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

URI GET /v3/{project_id}/cas/applications/{application_id}/components 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 integer 查询个数，取值[0, 100]。 offset 否 integer 查询偏移量，表示查询第n条数据后的结果。 order_by 否 String 排序字段。 排序字段支持以下枚举值： create_time，组件创建时间，默认排序字段。 name，组件名称。 update_time，组件修改时间。 传值不在支持的枚举值范围内的话按默认排序字段排序。 order 否 String 排序方式。 desc，降序排序，默认排序方式。 asc，升序排序。

响应示例 { "url": "https://github.com/login/oauth/authorize?client_id=2993bccf255673ba****&redirect_uri=https%3A%2F%2Fconsole.huaweicloud.com%2Fservicestage%2Foauth%3Frepo_type%3Dgithub&state=%242a%2410%24%2FMOymg0euuGH%2FJNWIJI3FeSVZhTUVj%2FF7r52mqpUKcYXz7f6.****&scope=read%3Auser%20repo%20write%3Arepo_hook" }

URI GET /v1/{project_id}/git/auths/{repo_type}/redirect 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 repo_type 是 String 仓库类型。 取值范围：CodeArts、Gitee、GitHub、BitBucket、GitLab。 表2 查询参数 参数 是否必选 参数类型 描述 tag 否 String 站点标签。

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

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

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

响应示例 { "swimlanes": [ { "id": "8c6274b9-113e-4066-9b1c-320fe5ae327b", "name": "baselane", "swimlane_group_id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75", "type": "BASE", "tag": "base", "weight": 100, "route_status": "ENABLE", "swimlane_group": { "routeInGroupTags": null, "gateways": [ { "id": "6b44bcf9-99e9-46f4-9ab5-7670456073fc", "name": "microGateway-pyy-0127-1", "target_services": [ { "id": "e882070c-7d02-4db1-8b84-619ee88f1a25", "host": "unit-provider-all..wulumuqi.servicecomb", "name": "unit-provider-all" } ], "engine_id": "b4032a08-b09d-47e4-a01f-596906df6f55" } ], "id": "13c73b95-ec0f-4e11-8901-d1e3c9142d75", "name": "test-wqd", "gray_release_type": "WEIGHT", "description": "111" } } ], "count": 1 }

响应消息 表4 响应参数 参数 参数类型 描述 count Integer 泳道总数。 swimlanes Array of objects 泳道列表，请参考表5。 表5 swimlanes 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE：基线泳道。 GRAY：灰度泳道。 tag String 泳道标签，根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE：开启路由。 DISABLED：关闭路由。 rule_match_mode String 路由规则匹配模式。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。 ALL：匹配所有的规则。 ANY：匹配任一规则。 rules Array of objects 路由规则。当泳道组灰度类型为基于内容，即gray_release_type为CONTENT时生效。请参考表6。 weight Integer 泳道流量权重。范围在0-100之间。 当泳道组灰度类型为基于流量，即gray_release_type为WEIGHT时生效。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表6 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER，即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT：精确匹配。 PREFIX：前缀匹配。 REGEX：正则匹配。

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

响应消息 表7 响应参数 参数 参数类型 描述 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 基础资源。请参考表8。 optional_resources Array of objects 可选资源。请参考表8。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表8 schemas 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。

响应示例 { "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env2", "alias": null, "description": "here is description", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "charge_mode": "provided", "deploy_mode": "virtualmachine", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e", "type": "ecs", "name": "ecs-9876" } ], "optional_resources": [ { "id": "9963306a-791e-468c-9306-cf80a9d00298", "type": "elb", "name": "elb-2dd2" }, { "id": "default", "type": "cse", "name": "Cloud Service Engine" } ], "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610420992462 }

请求示例 修改环境资源，添加名称为ecs-9876的E CS 基础资源、专业版CSE可选资源，移除名称为test的ECS资源。 { "add_base_resources": [ { "id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e", "type": "ecs", "name": "ecs-9876" } ], "add_optional_resources": [ { "id": "default", "type": "cse", "name": "Cloud Service Engine" } ], "remove_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "name": "test", "type": "ecs" } ] }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 add_base_resources 否 Array of objects 添加基础资源，请参考表4。 add_optional_resources 否 Array of objects 添加可选资源，请参考表5。 remove_resources 否 Array of objects 移除资源，请参考表6。 表4 add_base_resources 参数 是否必选 参数类型 描述 id 是 String 资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。 name 否 String 资源名称。 type 是 String 基础资源：cce、ecs、as。 表5 add_optional_resources 参数 是否必选 参数类型 描述 id 是 String 资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。 name 否 String 资源名称。 type 是 String 可选资源：rds、dcs、elb、cse等其他类型。 表6 remove_resources 参数 是否必选 参数类型 描述 id 是 String 资源ID（为了保证接口调用正常，请您确保调用前输入正确的资源ID）。 name 否 String 资源名称。 type 是 String 基础资源：cce、ecs、as。当deploy_mode为virtualmachine时可添加ecs、as，为container时可添加cce资源。 可选资源：rds、dcs、elb、cse等其他类型。

响应示例 { "gateways": [ { "id": "71949725-9c8f-483a-a05f-74d33ff1613e", "name": "microGateway-cy8bhr", "target_services": [ { "id": "8177d237-b912-4167-a90d-33c603610d0b", "host": "provider..demo-java-chassis-cse-v2.servicecomb", "name": "provider", "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067", "engine_type": "servicecomb" } ], "engine_id": "d68a5ca7-b5b6-4917-a464-0adef94b8067" } ], "id": "ba1ca687-1895-4fc3-88ca-9db02ce2a14e", "name": "test", "gray_release_type": "WEIGHT", "description": "test", "project_id": "578ac30b81034b89a7255b3af26db9c9", "creator": "test_user", "create_time": 1726623793113, "update_time": 1726623793113, "gateway_engine_ids": [ "d68a5ca7-b5b6-4917-a464-0adef94b8067" ] }

响应消息 表3 响应参数 参数 参数类型 描述 count Integer 泳道组总数。 swimlaneGroups Array of objects 泳道组列表，请参考表4。 表4 swimlaneGroups 参数 参数类型 描述 description String 泳道组的描述。 gray_release_type String 灰度发布类型。 WEIGHT：基于流量比例进行全链路灰度。 CONTENT：基于内容进行全链路灰度。 gateways Array of objects 流量网关入口，请参考表5。 name String 泳道组的名称。 id String 泳道组的ID。 gateway_engine_ids Array of String 网关ID列表。 creator String 创建者。 create_time String 创建时间。 update_time String 更新时间 project_id String 租户项目ID。获取方法，请参考获取项目ID。 表5 gateways 参数 参数类型 描述 engine_id String 引擎ID。 id String 网关ID。 name String 网关名称。 target_services Array of objects 目标服务列表。请参考表6。 表6 target_services 参数 参数类型 描述 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 目标服务名称。 id String 目标服务ID。 engine_id String 引擎ID。 engine_type String 引擎类型。 servicecomb：ServiceComb引擎。 nacos：注册配置中心。

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

响应示例 { "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", "name": "dev-env", "description": "develop environment", "project_id": "bf8523d898b64e4eb956e3be3555ca16", "enterprise_project_id": "0", "deploy_mode": "virtualmachine", "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", "resources": [ { "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80", "type": "ecs", "name": "ecs-test" } ], "creator": "ss-test", "create_time": 1578984198394, "update_time": 1578984198394, "labels": null }