Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Operation Management/ Logging In to a CBH Instance Console as User admin
Updated on 2025-12-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Logging In to a CBH Instance Console as User admin

Function

This API is used to log in to a CBH instance console as user admin.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/instances/{server_id}/admin-url

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

To obtain the value, see Obtaining a Project ID.

server_id

Yes

String

CBH instance ID, in UUID format.

For details about how to obtain the value, see " Viewing CBH Instance Details" in Cloud Bastion Host User Guide.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

For details, see Obtaining a User Token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

admin_url

String

URL for logging in to a CBH instance as user admin.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 7 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

Cbh Login Instance admin Success

{
  "admin_url" : "https://x.x.x.x:443?cbhinfo=xxxx"
}

Status Codes

Status Code

Description

200

Cbh Login Instance admin Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Operation Management