华为云用户手册

  • URI DELETE /v2/{project_id}/cas/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 application_id 是 String 应用ID。获取方法,请参考获取所有应用。 component_id 是 String 组件ID。获取方法,请参考获取应用所有组件。 表2 查询参数 参数 是否必选 参数类型 描述 force 否 boolean 是否强制删除。
  • 请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称,通过获取仓库授权列表获取对应的授权名称。
  • URI GET /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 sha。
  • 响应消息 表4 响应参数 参数 参数类型 描述 authorization Object 授权结构体,请参考表5。 表5 authorization 参数 参数类型 描述 name String 授权名称。 repo_type String 仓库类型。 取值范围:github、gitlab、gitee。 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:未认证
  • 响应示例 { "authorization": { "name": "token1", "repo_type": "github", "repo_host": "https://api.github.com", "repo_home": "https://github.com/tom-repo", "repo_user": "tom-repo", "avartar": "https://avatars.githubusercontent.com/u/73919264?v=4", "token_type": "personal", "create_time": 1649762172340, "update_time": 1649762172340, "status": 0 } }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 授权名称。 token 是 String 仓库Token。 host 否 String 仓库地址。
  • 响应示例 { "runtimes": [ { "type_name": "Java8", "display_name": "Java 8", "container_default_port": 8080, "type_desc": "Java 8 runtime server" } ] }
  • 请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称,通过获取仓库授权列表获取对应的授权名称。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String tags名称。 description 是 String 描述。
  • URI POST /v1/{project_id}/git/repos/{namespace}/{project}/tags 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 表2 查询参数 参数 是否必选 参数类型 描述 ref 是 String 分支名称或者tag名称或者commit sha。
  • 响应示例 { "addons": [ { "status": "FAILED", "id": "a2cdf0e2-8495-4db5-82f7-a23b97b57787", "name": "sermantInjector", "version": "1.3.1.0", "cce_id": "02f9a523-cefe-11ee-afc1-0255ac100045", "cse_id": "b4e49ad5-5142-437d-8a6b-1de66b1af0db", "job_id": "JOB195d62a9-6446-4ac4-a42e-034a48d6a10b", "environment_id": "7e2af5b5-4223-40b7-b89b-ee9059827248" } ] }
  • 响应消息 表3 响应参数 参数 参数类型 描述 addons Arrays of objects 插件列表,请参考表4。 表4 addons 参数 参数类型 描述 cce_id String 插件所绑定的CCE集群ID。 cse_id String 插件所绑定的 CS E微服务引擎ID。 environment_id String 插件所在的环境ID。 id String 插件ID job_id String 插件执行的最后一个任务的ID。 name String 插件名称。 sermantInjector:Sermant Injector插件。用于自动挂载Sermant Agent,通过Sermant Agent接入未开启安全认证的ServiceComb引擎。无需修改应用代码即可接入引擎并使用应用注册发现、全链路灰度发布、优雅上下线、标签路由等功能,但是不支持使用微服务治理功能。 status String 插件状态。 INITIALIZING,初始化。 UPGRADING,升级中。 FAILED,失败。 SUCCEEDED,成功。 DELETING,删除中。 version String 插件版本。
  • 响应示例 { "snapshots": [ { "version": "1.0.0", "description": "{\"action\":\"New Version: 1.0.0\"}", "instance_id": "11eddb33-140b-4e51-b1e2-6ec265373ca3", "create_time": 1610331830841 } ], "count": 1 }
  • URI GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances/{instance_id}/snapshots 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 application_id 是 String 应用ID。获取方法,请参考获取所有应用。 component_id 是 String 组件ID。获取方法,请参考获取应用所有组件。 instance_id 是 String 组件实例ID。获取方法,请参考获取组件实例。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定个数,取值[0, 100]或者1000,指定的值不在该范围内的话相当于赋值为10。默认1000,用于不分页的场景。分页的场景取值请用[0, 100]。 offset 否 Integer 指定偏移量。 order_by 否 String 排序字段,默认按创建时间排序。 order 否 String 排序方式。 desc,降序排序,默认为desc。 asc,升序排序。
  • URI POST /v1/{project_id}/git/repos/{namespace}/{project}/hooks 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称,通过获取仓库授权列表获取对应的授权名称。 表3 请求Body参数 参数 是否必选 参数类型 描述 secret 是 String 用于验证接收到的payloads的字符串。 url 是 String hook触发时回调的url。
  • 响应消息 表3 响应参数 参数 参数类型 描述 runtime_stacks Array of objects 运行时栈,请参考表4。 表4 runtime_stacks 参数 参数类型 描述 name String 运行时名称。 deploy_mode String 部署类型。 container,容器部署。 virtualmachine,虚拟机部署。 version String 版本号。 type String 技术栈类型。 Nodejs Java Tomcat Python Php Docker status String 技术栈状态。 Supported,启用。 Deprecated,已弃用。
  • 响应消息 表4 响应参数 参数 参数类型 描述 authorization Object 授权结构体,请参考表5。 表5 authorization 参数 参数类型 描述 name String 授权名称。 repo_type String 仓库类型。 取值范围:codearts、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:未认证
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 授权名称。 user 是 String 仓库用户名。 password 是 String 仓库密码。
  • 响应示例 { "authorization": { "name": "pass1", "repo_type": "bitbucket", "repo_host": "https://api.bitbucket.org", "repo_home": "https://bitbucket.org/%7B63cc78de-***********-9505c0335f96%7D/", "repo_user": "bucket-ljn", "avartar": "https://secure.gravatar.com/avatar/05a7b4a2302750*********cf64?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FB-2.png", "token_type": "password", "create_time": 1634119075119, "update_time": 1634119075119, "status": 0 } }
  • 响应示例 { "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": "container", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "type": "cce", "name": "cce-test" } ], "optional_resources": [ { "id": "9963306a-791e-468c-9306-cf80a9d00298", "type": "elb", "name": "elb-2dd2" } ], "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610420992462 }
  • 响应消息 表4 响应参数 参数 参数类型 描述 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 基础资源,请参考表5。 optional_resources Array of objects 可选资源,请参考表5。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表5 resources 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源:cce、ecs、as。 可选资源:rds、dcs、elb、cse等其他类型。
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 环境名称。 由英文字母、数字、中划线(-)、下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,英文字母不区分大小写,长度为2~64个字符。 alias 否 String 环境别名。 最大长度为64个字符。 description 否 String 环境描述。 最大长度为128个字符。
  • 响应示例 { "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 }
  • 请求示例 创建软件包部署的应用微服务组件,运行时设置为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" } } } }
  • 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”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称。通过获取仓库授权列表获取对应的授权名称。
  • URI DELETE /v1/{project_id}/git/repos/{namespace}/{project}/tags/{tag_name} 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 tag_name 是 String tag名称。获取方法,请参考获取项目tags。
  • 请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 X-Repo-Auth 是 String 授权名称。通过获取仓库授权列表获取对应的授权名称。
  • URI GET /v1/{project_id}/git/files/{namespace}/{project}/trees 参数说明见表1。 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 表2 查询参数 参数 是否必选 参数类型 描述 ref 是 String 分支名称或者tag名称或者commit sha。
  • 响应示例 { "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 }
共100000条