-
调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v4/projects/”，其中{Endpoint}为需求管理的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“project_id”即为项目ID。 {
"projects" : [ {
"project_num_id" : 3183801,
"project_id" : "41bd3eab86544863b8fc92ffcd35e3c8",
"project_name" : "demo_project",
"description" : "demo",
"created_time" : 1576114296000,
"updated_time" : 1576114296000,
"project_type" : "xboard",
"creator" : {
"user_num_id" : 4097,
"user_id" : "c4bd39f0573a436589714bedbcca8536",
"user_name" : "modile_user",
"domain_id" : "2489d8cbba804db8bcd35384685ff3ac",
"domain_name" : "modile_user",
"nick_name" : "Tom.M.Riddle"
}
} ],
"total" : 10
}
-
请求示例 查询应用项目级权限矩阵 https://{endpoint}/v3/applications/permissions?project_id=0a38ce9ba3c740c199a0f872b6163661 查询应用实例级权限矩阵 https://{endpoint}/v3/applications/permissions?app_id=0a38ce9ba3c740c199a0f872b6163661
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 result Array of ApplicationPermissionVO objects 角色应用权限 status String 请求成功失败状态 表4 ApplicationPermissionVO 参数 参数类型 描述 can_modify Boolean 是否有编辑权限 can_delete Boolean 是否有删除的权限 can_view Boolean 是否有查看权限 can_execute Boolean 是否有执行权限 can_copy Boolean 是否有复制权限 can_manage Boolean 是否有管理权限，包含增删改查执行以及权限修改 can_create_env Boolean 是否有新建环境权限 can_disable Boolean 是否有禁用权限 name String 角色名称 region String 局点信息 role_id String 角色id role_type String 角色类型， app-creator： 应用创建者； project： 项目管理员；template-customized-inst：系统角色； template-project-customized、project-customized：自定义角色
-
响应示例 状态码：200 OK 请求响应成功 {
"result" : [ {
"can_copy" : true,
"can_create_env" : true,
"can_delete" : true,
"can_disable" : true,
"can_execute" : true,
"can_manage" : true,
"can_modify" : true,
"can_view" : true,
"name" : "应用创建者",
"region" : "cn-north-7",
"role_id" : "0",
"role_type" : "app-creator"
}, {
"can_copy" : true,
"can_create_env" : true,
"can_delete" : true,
"can_disable" : true,
"can_execute" : true,
"can_manage" : true,
"can_modify" : true,
"can_view" : true,
"name" : "项目管理员",
"region" : "cn-north-7",
"role_id" : "2e510051361942a8b7ecea00144172b3",
"role_type" : "project"
} ],
"status" : "success"
}
-
请求示例 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 环境描述
-
响应示例 状态码：200 OK 请求响应成功 [ {
"region" : "region",
"name" : "Host cluster creator",
"role_id" : "0",
"devuc_role_id_list" : null,
"group_id" : "2a8c2da888c04a5eaff10d0787c90ea4",
"can_view" : true,
"can_edit" : true,
"can_delete" : true,
"can_add_host" : true,
"can_manage" : true,
"can_copy" : true,
"create_time" : "2024-05-31 14:32:59.0",
"update_time" : "2024-05-31 14:32:59.0",
"role_type" : "cluster-creator"
}, {
"region" : "region",
"name" : "Project admin",
"role_id" : "a2e65d2647574f8491cac659a0249d24",
"devuc_role_id_list" : null,
"group_id" : "2a8c2da888c04a5eaff10d0787c90ea4",
"can_view" : true,
"can_edit" : true,
"can_delete" : true,
"can_add_host" : true,
"can_manage" : true,
"can_copy" : true,
"create_time" : "2024-05-31 14:32:59.0",
"update_time" : "2024-05-31 14:32:59.0",
"role_type" : "project"
} ]
-
响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of DevUcClusterPermission objects 主机集群权限矩阵 表4 DevUcClusterPermission 参数 参数类型 描述 region String 局点信息 role_id String 角色id devuc_role_id_list Array of strings 角色id列表 name String 角色名称 group_id String 主机集群id can_view Boolean 是否有查看权限 can_edit Boolean 是否有编辑权限 can_delete Boolean 是否有删除权限 can_add_host Boolean 是否有添加主机权限 can_manage Boolean 是否有权限管理权限 can_copy Boolean 是否有拷贝权限 create_time String 创建时间 update_time String 修改时间 role_type String 角色类型，project-customized：自定义角色；template-project-customized：系统自定义角色；template-customized-inst：系统角色；cluster-creator：集群创建者；project_admin 项目创建者
-
响应示例 状态码：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 表2 Query参数 参数 是否必选 参数类型 描述 key_field 否 String 主机名模糊查询信息 environment_id 否 String 环境id page_index 否 Integer 页码数 page_size 否 Integer 每页显示的条目数量，默认为10 sort_key 否 String 排序字段：as_proxy|host_name|owner_name，不传使用默认排序 sort_dir 否 String 排序方式：DESC、ASC，默认为DESC as_proxy 否 Boolean 是否为代理机
-
响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 主机数量 status String 请求成功失败状态 result Array of HostInfo objects 主机信息列表 表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 用户名，可输入中英文，数字和符号(-_.)。 password String 密码，认证类型为0时，密码必填。 private_key String 密钥，认证类型为1时，密钥必填 trusted_type Integer 认证类型，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 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 DeploymentHostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 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 连接结果 表4 DeploymentHostAuthorizationBody 参数 参数类型 描述 username String 用户名，可输入中英文，数字和符号(-_.)。 password String 密码，认证类型为0时，密码必填。 private_key String 密钥，认证类型为1时，密钥必填 trusted_type Integer 认证类型，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
{
"host_name" : "100.101.28.215",
"ip" : "100.101.28.215",
"port" : "22",
"os" : "linux",
"as_proxy" : false,
"proxy_host_id" : "",
"authorization" : {
"username" : "root",
"password" : "*****",
"private_key" : "",
"trusted_type" : 0
},
"install_icagent" : true
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式） X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 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 是 DeploymentHostAuthorizationBody object 登录主机鉴权，使用密码登录则填写密码即可，使用密钥则填写密钥，二选一即可。 install_icagent 否 Boolean 免费启用应用运维服务（AOM），提供指标监控、日志查询、告警功能（自动安装数据采集器 ICAgent，仅支持华为云linux主机） 表4 DeploymentHostAuthorizationBody 参数 是否必选 参数类型 描述 username 是 String 用户名，可输入中英文，数字和符号(-_.)。 password 否 String 密码，认证类型为0时，密码必填。 private_key 否 String 密钥，认证类型为1时，密钥必填 trusted_type 是 Integer 认证类型，0表示使用密码认证，1表示使用密钥认证
