云服务器内容精选

  • 请求示例 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 消息体的类型(格式) X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 name 是 String 环境名称 deploy_type 是 Integer 部署类型:0表示主机, 1表示kubernetes os 是 String 操作系统:windows|linux,需要和主机集群保持一致 description 否 String 环境描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 String 分组id application_ids 是 Array of strings 应用id列表
  • 请求示例 https://{endpoint}/v1/projects/0a38ce9ba3c740c199a0f872b6163661/applications/groups/move{ "application_ids" : [ "a958794f9f4f4a24a96950c9cb279a4d", "a958794f9f4f4a24a96950c9cb279a4f" ], "group_id" : "ec3ccc617cf3405b8a6236f26223112b"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Array of MoveAppToGroupResult objects 移动应用至指定分组结果,仅返回移动失败的列表 status String 请求成功失败状态 表5 MoveAppToGroupResult 参数 参数类型 描述 code String 是否失败 application_id String 应用id application_name String 应用名称 error_code String 错误码 error_msg String 错误信息
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式) X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 page 是 Integer 参数解释: 分页页码,表示从此页开始查询。 约束限制: 不涉及。 取值范围: 1-99999 默认取值: 不涉及。 size 是 Integer 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 不涉及。 sort_name 否 String 参数解释: 排序字段的名称。 约束限制: 不涉及。 取值范围: name: 应用名称 startTime: 开始时间 默认取值: 不涉及。 sort_by 否 String 参数解释: 排序顺序。 约束限制: 不涉及。 取值范围: ASC: 正序 asc: 正序 DESC: 逆序 desc: 逆序 默认取值: 不涉及。 states 否 Array of strings 参数解释: 应用状态列表。 约束限制: 不涉及。 取值范围: abort: 部署中止 failed: 部署失败 not_started: 取消执行 pending: 排队中 running: 正在部署 succeeded: 部署成功 timeout: 部署超时 not_executed: 未执行 默认取值: 不涉及。 group_id 否 String 参数解释: 应用的分组id,传入no_grouped为查询未分组的应用。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符 或者 no_grouped。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_num Integer 参数解释: 应用总数。 取值范围: 不涉及。 result Array of AppExecutionInfo objects 参数解释: 应用列表数组。 表4 AppExecutionInfo 参数 参数类型 描述 id String 参数解释: 应用id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 name String 参数解释: 应用名称。 取值范围: 由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。 duration String 参数解释: 部署时间。 取值范围: 不涉及。 is_disable Boolean 参数解释: 当前应用是否被禁用。 取值范围: true: 被禁用 false: 未被禁用 project_id String 参数解释: 项目id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 project_name String 参数解释: 项目名称。 取值范围: 长度为[3,128]个字符。 is_care Boolean 参数解释: 当前用户是否已收藏。 取值范围: true: 已收藏 false: 未收藏 can_modify Boolean 参数解释: 是否有编辑权限。 取值范围: true: 有权限 false: 无权限 can_delete Boolean 参数解释: 是否有删除的权限。 取值范围: true: 有权限 false: 无权限 can_view Boolean 参数解释: 是否有查看权限。 取值范围: true: 有权限 false: 无权限 can_execute Boolean 参数解释: 是否有部署权限。 取值范围: true: 有权限 false: 无权限 can_copy Boolean 参数解释: 是否有复制权限。 取值范围: true: 有权限 false: 无权限 can_manage Boolean 参数解释: 是否有编辑应用权限矩阵的权限。 取值范围: true: 有权限 false: 无权限 can_create_env Boolean 参数解释: 是否有创建环境的权限。 取值范围: true: 有权限 false: 无权限 can_disable Boolean 参数解释: 是否有禁用应用的权限。 取值范围: true: 有权限 false: 无权限 deploy_system String 参数解释: 部署类型模式。 取值范围: deployTemplate: 部署模板 create_user_id String 参数解释: 应用创建者用户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 create_tenant_id String 参数解释: 应用创建者租户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 create_time String 参数解释: 创建时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 update_time String 参数解释: 修改时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 execution_time String 参数解释: 最后一次部署时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 end_time String 参数解释: 部署结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 execution_state String 参数解释: 部署状态。 取值范围: 不涉及。 release_id Integer 参数解释: 部署记录序列号。 取值范围: 不涉及。 executor_id String 参数解释: 部署者id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 executor_nick_name String 参数解释: 部署者昵称。 取值范围: 不涉及。 arrange_infos Array of TaskBaseResponseBody objects 参数解释: 部署任务信息。 表5 TaskBaseResponseBody 参数 参数类型 描述 id String 参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 state String 参数解释: 部署任务状态。 取值范围: Available: 可执行状态 Draft: 草稿状态 deploy_system String 参数解释: 部署类型模式。 取值范围: deployTemplate: 部署模板
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "id" : "cb439d016d8641c8a44c177a121fad15", "name" : "Test", "duration" : "00:00:17", "is_disable" : true, "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde", "project_name" : "项目1", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : false, "can_create_env" : false, "can_disable" : false, "create_user_id" : "04ec4661a8df4359b50980a9c958c86d", "create_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d", "create_time" : "2023-07-05 20:34:40.0", "update_time" : "2023-08-02 14:20:30.0", "execution_time" : "2023-08-18 09:40:16", "end_time" : "2023-08-18 09:40:33", "execution_state" : "failed", "release_id" : 4, "executor_id" : "6baa7454109d47c192f22078fe6cda20", "executor_nick_name" : "测试账号", "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b", "state" : "failed", "deploy_system" : "deployTemplate" } ] } ], "total_num" : 1}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Array of ExecuteRecordV2Body objects 参数解释: 应用历史部署记录列表。 total_num Integer 参数解释: 开始时间和结束时间内应用历史部署记录总数。 取值范围: 不涉及。 表5 ExecuteRecordV2Body 参数 参数类型 描述 duration String 参数解释: 部署用时。 取值范围: 不涉及。 state String 参数解释: 应用状态。 取值范围: 不涉及。 operator String 参数解释: 操作人用户名。 取值范围: 不涉及。 execution_id String 参数解释: 部署记录id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 start_time String 参数解释: 部署应用的开始时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 nickname String 参数解释: 操作人昵称。 取值范围: 不涉及。 end_time String 参数解释: 部署应用的结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 release_id Long 参数解释: 部署记录序列号。 取值范围: 不涉及。 type String 参数解释: 部署类型。 取值范围: install: 安装部署
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "duration" : "00:16:53", "state" : "succeeded", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "50f18ce454a64ea5a62a33d56617b831", "start_time" : "2022-04-15 15:03:24", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:20:17", "release_id" : 20 }, { "duration" : "00:15:31", "state" : "failed", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "f757fbe93d35494ba0ff73b34e2f79aa", "start_time" : "2022-04-15 15:03:15", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:18:46", "release_id" : 19 } ], "total_num" : 20}
  • URI GET /v2/{project_id}/task/{id}/history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 id 是 String 参数解释: 部署任务id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 参数解释: 分页页码, 表示从此页开始查询。 约束限制: 不涉及。 取值范围: 1-99999 默认取值: 不涉及。 size 是 Integer 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 不涉及。 start_date 是 String 参数解释: 区间开始时间。格式为yyyy-MM-dd。例如:2022-03-16。 约束限制: 与end_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。 取值范围: 不涉及。 默认取值: 不涉及。 end_date 是 String 参数解释: 区间结束时间。格式为yyyy-MM-dd。例如:2022-04-15。 约束限制: 与start_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI GET /v2/{project_id}/tasks/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 分页页码, 表示从此页开始查询, page大于等于1 size 是 Integer 每页显示的条目数量,size小于等于100
  • 响应示例 状态码: 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}
  • 请求示例 https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/tasks/metrics/success-rate{ "start_date" : "2022-01-01", "end_date" : "2022-10-26", "task_ids" : [ "5bf0a54f36b04ddda7b94470fee39307", "b6d20b703ffe4a04bc68790ddabf6ab7" ]}
  • 响应示例 状态码: 200 OK 请求响应成功 { "project_id" : "89931e210b214b5892ea833712f0f5e0", "project_name" : "Happy", "start_date" : "2022-01-01", "end_date" : "2022-10-26", "tasks_success_rate" : [ { "task_id" : "5bf0a54f36b04ddda7b94470fee39307", "task_name" : "happy482URL健康测试", "success_rate" : "0", "record_count" : 8, "success_record_count" : 0 }, { "task_id" : "b6d20b703ffe4a04bc68790ddabf6ab7", "task_name" : "happy486启动停止Tomcat", "success_rate" : "14.29", "record_count" : 14, "success_record_count" : 2 } ]}