Obtaining an O&M URL_Operation Management_API Description_API Reference

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

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

**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.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token 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 a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
state	String	Link acquisition status. SUCCESS(0): successful. If the status is not SUCCESS, the request fails, and an error code and description need to be displayed. IAM_USER_CONFLICT(1016): IAM user conflict. HOST_NOT_MANAGE(1): The host is not managed. HOST_ACCOUNT_NOT_EXIST(553): The host account is unavailable. IAM_USER_NO_PERMISSION(901): The IAM user does not have the permission to operate the host. CUR_VERSION_NOT_SUPPORT_OPERATION(9001): The operation is not supported by the current service version. INS_WHITE_LIST_INITIALIZING(9002): The instance whitelist is being initialized. Try again later. UNKNOWN_ERROR(9003): unknown error
description	String	Message displayed when the link fails to be obtained.
login_url	String	Address for logging in to the ECS for O&M.

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	Token verification failed.

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.

None

Status code: 200

{
  "state" : "SUCCESS",
  "login_url" : "https://xxxxxx.xxxxx"
}

Obtaining an O&M URL