云服务器内容精选

  • 请求示例 https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments { "project_id" : "55837d272adf4eee90319800e2da6961", "name" : "Environment name", "deploy_type" : 0, "description" : "Environment Description", "os" : "linux" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json;charset=utf-8 枚举值: application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:20000 表3 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 name 是 String 环境名称 deploy_type 是 Integer 部署类型:0表示主机, 1表示kubernetes 缺省值:0 枚举值: 0 1 os 是 String 操作系统:windows|linux,需要和主机集群保持一致 缺省值:linux 枚举值: windows linux description 否 String 环境描述
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : { "id" : "e700f15965694253940502911220d76b", "name" : "testApp", "region" : "cn-north-7", "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b" } ] }, "status" : "success" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json;charset=utf-8 枚举值: application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:20000 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id name 是 String 应用名称 最小长度:3 最大长度:128 description 否 String 描述 group_id 否 String 分组id is_draft 是 Boolean 是否为草稿 create_type 是 String 创建类型,创建类型只有一个'template',即根据模板创建 枚举值: template slave_cluster_id 否 String 自定义slave资源池id trigger 否 TaskTriggerVO object 部署任务触发场景配置 arrange_infos 否 Array of TaskV2RequestBody objects 部署任务列表信息 表3 TaskTriggerVO 参数 是否必选 参数类型 描述 trigger_source 否 String 部署任务允许执行的场景。其中0:所有执行请求均可,1:只允许流水线触发 artifact_source_system 否 String 当任务只允许流水线触发执行时,流水线传递的来源信息,当前只有CodeArtsArtifact artifact_type 否 String 当任务只允许流水线触发执行时,对应流水线源的制品仓库类型(generic、docker) 表4 TaskV2RequestBody 参数 是否必选 参数类型 描述 template_id 否 String 模板id operation_list 否 Array of DeployV2OperationsDO objects 部署编排列表信息 表5 DeployV2OperationsDO 参数 是否必选 参数类型 描述 id 否 String 步骤id name 否 String 步骤名称 description 否 String 步骤描述 code 否 String 下载地址 params 否 String 步骤详细定义 entrance 否 String 入口函数 version 否 String 版本 module_id 否 String 模块id
  • 请求示例 创建一个应用 https://{endpoint}/v1/applications { "name" : "deployenv20230822192953", "project_id" : "55837d272adf4eee90319800e2da6961", "description" : "使用空白模板创建应用", "trigger" : { "trigger_source" : 0, "artifact_source_system" : "", "artifact_type" : "" }, "slave_cluster_id" : "", "create_type" : "template", "is_draft" : true, "arrange_infos" : [ ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 status String 请求成功失败状态 result AppBaseResponse object 创建和删除应用响应体 表7 AppBaseResponse 参数 参数类型 描述 id String 创建的应用id name String 创建应用名称 region String 应用所属区域 arrange_infos Array of TaskBaseBody objects 部署任务列表 表8 TaskBaseBody 参数 参数类型 描述 id String 创建的部署任务id
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json 缺省值:application/json;charset=utf-8 枚举值: application/json;charset=utf-8 application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:0 最大长度:20000
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "id" : "2c82ffe8d00d4968a4e5f7a36d87ae17", "name" : " 消息通知 ", "state" : "succeeded", "owner" : "devcloud_devcloud_l00490255_01", "duration" : "00:00:50", "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7", "project_name" : "DeployMan-UI-L0", "deploy_system" : "deployTemplate", "create_time" : "2022-02-09 16:34:20", "update_time" : "2022-03-05 09:04:39", "execution_time" : "2022-04-11 15:50:23", "execution_state" : "succeeded", "role_id" : -1, "is_defaut_permission" : false, "executor_id" : "6baa7454109d47c192f22078fe6cda20", "executor_nick_name" : "AB边账号", "nick_name" : "AB边账号", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "is_care" : true, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "release_id" : 61640, "is_disable" : true }, { "id" : "a9c3ef27a1f34a1abf1dc84d927d7d39", "name" : "412", "state" : "failed", "owner" : "paas_clouddeploy_h00472130_01", "duration" : "00:02:36", "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7", "project_name" : "DeployMan-UI-L0", "deploy_system" : "deployTemplate", "create_time" : "2022-04-12 17:26:07", "update_time" : "2022-04-12 17:26:07", "execution_time" : "2022-04-13 11:45:09", "execution_state" : "failed", "role_id" : -1, "is_defaut_permission" : false, "executor_id" : "04ec4661a8df4359b50980a9c958c86d", "executor_nick_name" : "paas_clouddeploy_h00472130_01", "nick_name" : "paas_clouddeploy_h00472130_01", "owner_id" : "04ec4661a8df4359b50980a9c958c86d", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "release_id" : 29, "is_disable" : true } ], "total_num" : 331 }
  • URI GET /v2/{project_id}/tasks/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 分页页码, 表示从此页开始查询, page大于等于1 size 是 Integer 每页显示的条目数量,size小于等于100
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "host_name" : "100.101.28.203", "ip" : "100.101.28.203", "port" : 22, "os" : "linux", "authorization" : { "username" : "root", "password" : null, "private_key" : null, "trusted_type" : 0 }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_copy" : true }, "uuid" : "2cc913cc9a494f09b7320801ebacad02", "group_id" : "ab7647b0863c4e969c8949d38d591339", "as_proxy" : false, "proxy_host_id" : "", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "owner_name" : "devcloud_devcloud_l00490255_01", "connection_status" : "success", "create_time" : "2021-04-15 11:01:51", "connection_result" : "连接成功", "lastest_connection_time" : "2021-04-15 11:02:00", "nick_name" : "AB边账号", "proxy_host" : null, "import_status" : null, "env_count" : 1 } ], "total" : 1, "status" : "success" }
  • URI GET /v1/resources/host-groups/{group_id}/hosts 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 项目id 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 key_field 否 String 主机名模糊查询信息 最小长度:1 最大长度:256 environment_id 否 String 环境id 最小长度:32 最大长度:32 page_index 否 Integer 页码数 最小值:0 page_size 否 Integer 每页显示的条目数量,默认为10 最小值:1 最大值:1000 sort_key 否 String 排序字段:as_proxy|host_name|owner_name,不传使用默认排序 sort_dir 否 String 排序方式:DESC、ASC,默认为DESC 枚举值: DESC ASC as_proxy 否 Boolean 是否为代理机
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 主机数量 最小值:0 最大值:200 status String 请求成功失败状态 result Array of HostInfo objects 主机信息列表 数组长度:0 - 200 表5 HostInfo 参数 参数类型 描述 uuid String 主机id ip String 主机IP os String 主机操作系统 port Integer 端口 authorization HostAuthorizationBody object 登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。 permission PermissionHostDetailNew object 主机相关权限详情类 host_name String 主机名称 as_proxy Boolean 是否为代理机 group_id String 主机集群id proxy_host_id String 代理机id owner_id String 主机所属人id owner_name String 主机所属人名称 proxy_host HostInfo object 代理机信息详情 connection_status String 连通性状态 create_time String 创建时间 lastest_connection_time String 上次连通时间 connection_result String 连通性验证结果 nick_name String 主机所属人昵称 import_status String 导入状态 env_count Integer 关联环境数量 表6 HostAuthorizationBody 参数 参数类型 描述 username String 用户名,可输入中英文,数字和符号(-_.)。 最小长度:3 最大长度:128 password String 密码,认证类型为0时,密码必填。 private_key String 密钥,认证类型为1时,密钥必填 最小长度:1 最大长度:5000 trusted_type Integer 认证类型,0表示使用密码认证,1表示使用密钥认证 枚举值: 0 1 表7 PermissionHostDetailNew 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_copy Boolean 是否有复制主机权限
  • 响应示例 状态码: 200 OK 请求响应成功 { "ip" : "100.101.28.215", "port" : 22, "os" : "linux", "authorization" : { "username" : "root", "password" : null, "private_key" : null, "trusted_type" : 0 }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_connection_test" : true }, "group_id" : "ab7647b0863c4e969c8949d38d591339", "host_name" : "100.101.28.215", "as_proxy" : false, "proxy_host_id" : null, "owner_id" : "6baa7454109d47c192f22078fe6cda20", "owner_name" : "devcloud_devcloud_l00490255_01", "updator_id" : "6baa7454109d47c192f22078fe6cda20", "updator_name" : "devcloud_devcloud_l00490255_01", "connection_status" : "success", "install_icagent" : false, "create_time" : "2021-05-13 09:35:41", "update_time" : "2021-05-13 09:35:41", "connection_result" : "连接成功", "lastest_connection_time" : "2021-05-13 09:36:11", "nick_name" : "AB边账号", "host_id" : "300d6d2e53624d0da08b182099ad10f7" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 group_id String 主机集群id 最小长度:32 最大长度:32 host_name String 主机名称 最小长度:3 最大长度:128 ip String IP,请输入弹性ip格式:161.17.101.12 port Integer ssh端口,如:22 os String 操作系统:windows|linux,需要和主机集群保持一致 枚举值: windows linux as_proxy Boolean 是否为代理机 proxy_host_id String 代理机id authorization DeploymentHostAuthorizationBody object 登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。 install_icagent Boolean 免费启用应用运维服务( AOM ),提供指标监控、日志查询、告警功能(自动安装数据采集器 ICAgent,仅支持华为云linux主机) host_id String 主机id proxy_host DeploymentHostDetail object 代理机信息详情 group_name String 主机集群名 最小长度:3 最大长度:128 project_id String 项目id,获取方式请参见获取项目id。 project_name String 项目名称 最小长度:3 最大长度:128 permission PermissionHostDetail object 主机相关权限详情类 update_time String 更新时间 lastest_connection_time String 最后连接时间 connection_status String 连接状态 owner_name String 拥有者名称 updator_id String 维护者id create_time String 创建时间 nick_name String 昵称 owner_id String 拥有者id updator_name String 维护者名称 connection_result String 连接结果 表4 DeploymentHostAuthorizationBody 参数 参数类型 描述 username String 用户名,可输入中英文,数字和符号(-_.)。 最小长度:3 最大长度:128 password String 密码,认证类型为0时,密码必填。 private_key String 密钥,认证类型为1时,密钥必填 最小长度:1 最大长度:5000 trusted_type Integer 认证类型,0表示使用密码认证,1表示使用密钥认证 枚举值: 0 1 表5 PermissionHostDetail 参数 参数类型 描述 can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_connection_test Boolean 是否有测试主机连通性权限
  • 请求示例 修改目标主机基本信息,信息包含主机名称、IP地址、端口等。 https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339/hosts/300d6d2e53624d0da08b182099ad10f7 { "host_name" : "100.101.28.215", "ip" : "100.101.28.215", "port" : 22, "as_proxy" : false, "proxy_host_id" : null, "authorization" : { "username" : "root", "password" : null, "private_key" : "", "trusted_type" : 0 }, "install_icagent" : false, "sync" : true }