Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Obtaining an O&M URL
Updated on 2024-06-13 GMT+08:00
View PDF
Share

Obtaining an O&M URL

Function

This API is used to obtain an O&M URL.

URI

GET /v2/{project_id}/cbs/instance/get-om-url

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

For details about how to obtain the project ID, see "Obtaining a Project ID".
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

server_id

Yes

String

ID of the server where the CBH instance is deployed.

ip_address

Yes

String

IP address of the server managed by the CBH instance.

host_account_name

Yes

String

Account that the managed server belongs to.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

For details, see "Obtaining the Token of an IAM User."

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

state

String

Status of the task for obtaining an O&M URL. #SUCCESS(0): The URL has been obtained. If the status is not SUCCESS, the task failed. Locate the cause by referring to the following error codes and the corresponding descriptions.

IAM_USER_CONFLICT(1016): There were IAM user conflicts.

HOST_NOT_MANAGE(1): The server requested has not be managed by CBH.

HOST_ACCOUNT_NOT_EXIST(553): The account for logging in to the server is unavailable.

IAM_USER_NO_PERMISSION(901): IAM user does not have the permission to maintain the server.

CUR_VERSION_NOT_SUPPORT_OPERATION(9001): The current service version does not support the task.

INS_WHITE_LIST_INITIALIZING(9002): The instance trustlist is being initialized. Please try again later.

UNKNOWN_ERROR(9003): Unknown error

Enumeration values:

  • SUCCESS

  • IAM_USER_CONFLICT

  • HOST_NOT_MANAGE

  • HOST_ACCOUNT_NOT_EXIST

  • IAM_USER_NO_PERMISSION

  • CUR_VERSION_NOT_SUPPORT_OPERATION

  • INS_WHITE_LIST_INITIALIZING

  • UNKNOWN_ERROR

description

String

Message displayed when the task for obtaining an URL fails.

login_url

String

ECS O&M login address

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

Get HOST O&M URL Success

{
  "state" : "SUCCESS",
  "login_url" : "xxxxxx"
}

Status Codes

Status Code

Description

200

Get HOST O&M URL Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Operation Management