获取运维链接 - ShowOmUrl
功能介绍
获取运维链接
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cbh:instance:getOmUrl
Read
instance *
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
- cbh:instance:getOmUrl
-
-
URI
GET /v2/{project_id}/cbs/instance/get-om-url
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_id |
是 |
String |
云堡垒机服务器ID |
|
ip_address |
是 |
String |
被纳管主机IP |
|
host_account_name |
是 |
String |
被纳管主机的账户 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 获取方法请参见获取用户Token。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
state |
String |
链接获取状态 - SUCCESS(0): 成功；非SUCCESS状态都认为获取失败，需要展示错误代码及description - IAM_USER_CONFLICT(1016): IAM用户冲突； - HOST_NOT_MANAGE(1): 查询主机未被纳管； - HOST_ACCOUNT_NOT_EXIST(553): 主机账户不可用； - IAM_USER_NO_PERMISSION(901): IAM用户无运维该主机权限； - CUR_VERSION_NOT_SUPPORT_OPERATION(9001):当前服务版本不支持; - INS_WHITE_LIST_INITIALIZING(9002):实例白名单正在初始化，请稍后重试; - UNKNOWN_ERROR(9003):未知错误; |
|
description |
String |
链接获取异常时说明提示 |
|
login_url |
String |
ECS运维登录地址 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_description |
String |
请求参数错误。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_description |
String |
校验TOKEN失败。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_description |
String |
租户无权限操作。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_description |
String |
没有找到CBH资源。 |
请求示例
无
响应示例
状态码：200
Get HOST O&M URL Success
{
"state" : "SUCCESS",
"login_url" : "xxxxxx"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Get HOST O&M URL Success |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
