- 最新动态
- 功能总览
- 产品介绍
- 快速入门
-
用户指南
- 部署服务CodeArts Deploy使用流程
- 购买并授权使用CodeArts Deploy
- 访问CodeArts Deploy服务首页
- 配置部署服务的主机集群
-
使用空白模板新建并部署应用
- 使用空白模板创建CodeArts Deploy应用
- 配置CodeArts Deploy应用的部署步骤
- 配置CodeArts Deploy应用的参数
- 配置CodeArts Deploy应用的主机环境
- 配置CodeArts Deploy应用不同角色的管理权限
- 部署CodeArts Deploy应用并查看结果
- 配置CodeArts Deploy应用的系统通知和第三方订阅通知
- 使用预置模板新建并部署应用
- 使用自定义模板新建并部署应用
- 查询审计日志(可选)
- 最佳实践
- API参考
- 场景代码示例
-
常见问题
- 主机管理
- 应用部署
-
公共问题
- 一台主机是否只能对应一个项目?
- 是否需要事先将运行环境(Tomcat、python等)安装到用户主机中,再部署应用?
- 部署应用失败,提示“AnsibleUndefinedVariable: 'xxxx' is undefined”,怎样处理?
- 应用部署成功但应用验证路径下的url无法访问,怎样处理?
- 部署应用失败,日志提示DNS解析问题如何解决?
- 草稿应用无法部署,如何解决?
- 部署应用失败,JDK已安装且已配置环境变量,但报错:please configure JDK environment variables,怎样处理?
- 日志提示权限不够,怎样处理?
- 路径不合法,怎样处理?
- 提示“环境下没有主机”,怎样处理?
- 使用sudo权限执行报错,怎样处理?
- 文件不存在或者路径不正确,怎样处理?
- 当前主机用户权限不足,怎样处理?
- 文件路径不存在,怎样处理?
- 选择【Docker应用部署-Linux】系统模板,Ubuntu22执行步骤“创建并启动容器”时失败,怎样处理?
- Windows主机部署过程中,偶现连接超时,怎样处理?
-
自定义应用步骤问题
- URL健康测试
- 选择部署来源
- 停止服务
-
拷贝文件
- 没有找到目标文件
- 文件路径不合法
- 文件不存在或者路径不正确
- 部署“拷贝文件”步骤显示成功但没达到预期结果
- 当前主机用户权限不足
- Linux环境间拷贝文件报错: copy file failed
- windows环境间拷贝文件报错:Windows does not support copying files between hosts
- 环境间拷贝文件报错:Hosts using secret key credit do not support copying files between
- 部署应用中断
- 权限不够
- 参数含反斜杠“\”(特例)
- 环境下没有主机
- 环境不存在
- windows主机部署应用失败
- 使用sudo权限执行报错
- 部署进程被第三方杀毒软件拦截
- 路径不合法
- 在Centos上安装软件提示网络故障
- 在Ubuntu上安装软件提示网络故障
- Linux机器输入Windows路径,提示安装路径输入不合法
- 删除文件
- 解压文件
- 配置文件修改
- 启动/停止Tomcat服务
- 启动/停止Go服务
- 启动/停止SpringBoot服务
- 启动/停止Nginx
- 启动/停止IIS服务
- 启动/停止Node.js
-
执行shell命令
- 部署“执行shell命令”步骤,提示新建失败
- 使用Shell命令启动服务日志显示成功实际没有启动
- 使用了服务器未识别的Shell命令
- Shell命令中引用了不存在的文件或文件夹
- Shell命令如何引用参数设置中的参数
- 部署“执行Shell命令”步骤超时
- 使用了交互性的Shell命令
- 使用su命令切换用户后再部署shell命令超时
- 部署应用中断
- 权限不够
- 参数含反斜杠“\”(特例)
- 环境下没有主机
- 环境不存在
- 使用sudo权限执行报错
- 部署进程被第三方杀毒软件拦截
- 路径不合法
- 在Centos上安装软件提示网络故障
- 在Ubuntu上安装软件提示网络故障
- Linux机器输入Windows路径,提示安装路径输入不合法
- 其它常见问题
- 执行Shell脚本
- 执行PowerShell命令
- 执行PowerShell脚本
-
执行Docker命令
- docker服务未安装
- 执行Docker命令参数错误
- 当前用户没有部署权限
- 镜像不存在
- login命令部署失败
- build命令部署失败
- tag命令部署失败
- push命令部署失败
- run命令部署失败
- start、restart、stop、rm命令部署失败
- rmi命令部署失败
- pull命令部署失败
- rm命令部署失败
- 连接超时
- 部署应用中断
- 权限不够
- 参数含反斜杠“\”(特例)
- 环境下没有主机
- 环境不存在
- windows主机部署应用失败
- 使用sudo权限执行报错
- 部署进程被第三方杀毒软件拦截
- 路径不合法
- 在Centos上安装软件提示网络故障
- 在Ubuntu上安装软件提示网络故障
- Linux机器输入Windows路径,提示安装路径输入不合法
- 执行等待
- ServiceStage相关问题
- Kubernetes部署步骤操作相关问题
-
Ansible
- 非法的入口文件路径
- 找不到入口文件
- Ansible步骤关于copy模块的报错
- 替换json参数解析错误
- Playbook脚本中service模块启动/停止服务不成功
- Ansible应用部署失败
- 执行Ansible提示Do not use the delegate_to, connection, hosts command in the Ansible PlayBook script for executing the local computer,怎样处理?
- 部署应用中断
- 权限不够
- 参数含反斜杠“\”(特例)
- 环境下没有主机
- 环境不存在
- windows主机部署应用失败
- 使用sudo权限执行报错
- 部署进程被第三方杀毒软件拦截
- 路径不合法
- 在Centos上安装软件提示网络故障
- 在Ubuntu上安装软件提示网络故障
- Linux机器输入Windows路径,提示安装路径输入不合法
- 新建IIS站点
- 安装IIS
- 安装JDK
- 安装Tomcat
- 安装Nginx
- 安装GO语言
- 安装PHP
- 安装Node.js
- 安装Python
- 安装/卸载Docker
- Istio灰度发布
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询主机列表
功能介绍
根据主机集群id查询指定主机集群下的主机列表。该接口于2024年09月30日后不再维护,推荐使用新版查询主机列表(ListNewHosts)接口。
调用方法
请参见如何调用API。
URI
GET /v2/host-groups/{group_id}/hosts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
主机集群id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
as_proxy |
否 |
Boolean |
是否为代理机 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0 |
limit |
否 |
Integer |
每页显示的条目数量,默认为1000 |
name |
否 |
String |
主机名,可输入中英文,数字和符号(-_.) |
sort_key |
否 |
String |
排序字段,支持:AS_PROXY|HOST_NAME|OS|OWNER_NAME|as_proxy|host_name|os|owner_name|nickName。不填默认为:as_proxy |
sort_dir |
否 |
String |
排序方式,默认为:DESC。DESC:降序排序。ASC:升序排序 |
with_auth |
否 |
Boolean |
返回结果是否加密 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
主机数量 |
group_name |
String |
主机集群名称 |
hosts |
Array of DeploymentHostDetail objects |
主机列表信息 |
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
主机集群id |
host_name |
String |
主机名称 |
ip |
String |
IPv4/IPv6格式的IP地址 |
port |
Integer |
ssh端口,如:22 |
os |
String |
操作系统:windows|linux,需要和主机集群保持一致 |
as_proxy |
Boolean |
是否为代理机 |
proxy_host_id |
String |
代理机id |
authorization |
登录主机鉴权,使用密码登录则填写密码即可,使用密钥则填写密钥,二选一即可。 |
|
install_icagent |
Boolean |
免费启用应用运维服务(AOM),提供指标监控、日志查询、告警功能(自动安装数据采集器 ICAgent,仅支持华为云linux主机) |
host_id |
String |
主机id |
proxy_host |
DeploymentHostDetail object |
代理机信息详情 |
group_name |
String |
主机集群名 |
project_id |
String |
项目id,获取方式请参见获取项目id。 |
project_name |
String |
项目名称 |
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 |
连接结果 |
请求示例
https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339/hosts?offset=0&limit=10&sort_key=AS_PROXY&sort_dir=asc&with_auth=false
响应示例
状态码: 200
OK 请求响应成功
{ "hosts" : [ { "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_connection_test" : true }, "host_id" : "2cc913cc9a494f09b7320801ebacad02", "group_id" : "ab7647b0863c4e969c8949d38d591339", "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-04-15 11:01:51", "update_time" : "2021-04-21 15:04:24", "connection_result" : "连接成功", "lastest_connection_time" : "2021-04-15 11:02:00", "nick_name" : "AB边账号", "proxy_host" : null, "group_name" : null, "project_id" : "6039d4480efc4dddb178abff98719913", "project_name" : null } ], "total" : 1, "group_name" : "test" }
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。