华为云用户手册

响应消息 表5 响应参数 参数 参数类型 描述 authorization Object 授权结构体，请参考表6。 表6 authorization 参数 参数类型 描述 name String 授权名称。 repo_type String 仓库类型。 取值范围：github、gitlab、gitee、bitbucket。 repo_host String 仓库地址。 repo_home String 您的仓库主页。 repo_user String 您的仓库用户名。 avartar String 您的仓库头像。 token_type String 仓库授权方式。 create_time Long 仓库授权创建时间戳。 update_time Long 仓库授权修改时间戳。 status Integer 仓库授权状态。 0：正常 1：过期 2：未认证。

URI POST /v1/{project_id}/git/auths/{repo_type}/oauth 参数说明见表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。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 授权名称。 code 是 String git仓库授权后，重定向返回的url里面的code参数。 state 是 String git仓库授权后，一次性的认证编码和随机串。 code和state参数值获取方法： 在浏览器地址栏中输入访问获取授权重定向URL接口获取到的URL并回车。 在登录页面输入您的代码仓库账号和密码。 如果您已经登录代码仓库，则无需执行这一步。 在华为云控制台登录页面输入账号和密码，单击“登录”。 如果您已经登录华为云控制台，则无需执行这一步。 等待页面显示新建授权失败后，复制地址栏的URL。 例如： https://console.huaweicloud.com/servicestage/oauth?repo_type=github&code=04bed2df009f3fc9***c&state=%242a%2410%24.uQYThj5yKFs51w9s9ajeuQ0NSGshPH7IUfXoZLPlz7J%2FoAJ8B*** 对获取到的URL进行URL解码，获得解码后的URL。 示例如下： https://console.huaweicloud.com/servicestage/oauth?repo_type=github&code=04bed2df009f3fc9***c&state=$2a$10$.uQYThj5yKFs51w9s9ajeuQ0NSGshPH7IUfXoZLPlz7J/oAJ8B*** 获取其中code和state对应的参数值。 获取到的state参数值为一次性的认证编码和随机串，仅支持使用一次。如需再次调用本接口创建OAuth授权，请再次执行获取授权重定向URL获取URL并参考本方法获取code和state参数值。

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

响应消息 表3 响应参数 参数 参数类型 描述 addons Arrays of objects 插件版本信息，请参考表4。 表4 addons 参数 参数类型 描述 name String 插件名称。 sermantInjector：Sermant Injector插件。用于自动挂载Sermant Agent，通过Sermant Agent接入未开启安全认证的ServiceComb引擎。无需修改应用代码即可接入引擎并使用应用注册发现、全链路灰度发布、优雅上下线、标签路由等功能，但是不支持使用微服务治理功能。 latest_version String 插件最新版本。

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式），默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种，如果您使用的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 GET /v1/{project_id}/git/repos/{namespace}/{project}/tags 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。

响应示例 { "id": "11eddb33-140b-4e51-b1e2-6ec265373ca3", "name": "test-micro-test-env-7iafjk", "environment_id": "61b81021-21d5-42f3-b80e-0b6bd10dbf7d", "platform_type": "cce", "flavor_id": "CUSTOM-10G:250m-250m:0.5Gi-0.5Gi", "artifacts": { "test-micro": { "storage": "swr", "type": "image", "url": "swr.region_id.development.com/ns/examples:v2", "auth": "iam", "version": "1.0.0", "properties": {} } }, "version": "1.0.2", "description": "", "configuration": { "env": [ { "name": "PAAS_PROJECT_ID", "value": "e7d2e9c589e5445e808a8ff0d1235aca", "internal": true } ], "lifecycle": { "post-start": null, "pre-stop": null }, "scheduler": { "affinity": { "az": [], "node": [], "application": [] }, "anti-affinity": { "az": [], "node": [], "application": [] }, "isSynchronized": true }, "strategy": { "upgrade": "RollingUpdate", "spec": { "maxSurge": 0, "maxUnavailable": 1 } } }, "creator": null, "create_time": 1610331819996, "update_time": 1610522676792, "external_accesses": null, "refer_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "type": "cce", "parameters": { "namespace": "default" } }, { "id": "default", "type": "cse" } ], "status_detail": { "status": "RUNNING", "replica": 1, "available_replica": 1, "fail_detail": null, "last_job_id": "JOB16c33466-41e6-4c5b-a9ac-2059253a1e5c", "last_job_status": "SUCCEEDED", "enterprise_project_id": "0" } }

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

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

请求消息 表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}/components/{component_id}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法，请参考获取项目ID。 application_id 是 String 应用ID。获取方法，请参考获取所有应用。 component_id 是 String 组件ID。获取方法，请参考获取应用所有组件。 instance_id 是 String 组件实例ID。获取方法，请参考获取组件实例。 表2 查询参数 参数 是否必选 参数类型 描述 force 否 boolean 是否强制删除。

请求消息 表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哈希。

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

响应消息 表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。 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。

响应示例 { "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" }

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

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 站点标签。

请求示例 修改环境资源，添加名称为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" } ] }

响应消息 表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 }

请求消息 表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等其他类型。

请求消息 表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。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作，支持start、stop、restart、scale、rollback。 start：启动组件实例。 stop：停止组件实例。 restart：重启组件实例。 scale：伸缩组件实例。 rollback：回滚组件实例到上个版本。 parameters 否 Object 操作参数，action为scale和rollback时必选，请参考表4。 表4 parameters 参数 是否必选 参数类型 描述 replica 否 Integer 实例数，在scale操作时必选。 hosts 否 Array ECS id列表，指定虚机伸缩的时候部署的ECS主机，在scale操作时必选。 version 否 String 版本号，在rollback操作时必选，通过获取组件实例快照获取。

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