Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Querying CBH Details/ Checking CBH Instance Network Connection
Updated on 2023-05-16 GMT+08:00
View PDF

Checking CBH Instance Network Connection

Function

This API is used to check network connection of a CBH instance.

URI

POST /v1/{project_id}/cbs/network/configuration

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. You can obtain the project ID by referring to https://support.huaweicloud.com/intl/en-us/api-cbh/cbh_02_0020.html.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

CBH instance status. The value can be:

  • create: The instance is being created.

  • renewals: The instance is being renewed.

  • change: The instance specifications are being changed. When the status is renewals or change, server_id must be included.

security_groups

Yes

Array of SecurityGroup objects

Security group that the CBH instance belongs to.

nics

Yes

Array of Nics objects

NIC the CBH instance uses.

server_id

No

String

CBH instance ID.
Table 3 SecurityGroup

Parameter

Mandatory

Type

Description

id

Yes

String

Security group ID, which consists of letters, digits, and underscores (_).
Table 4 Nics

Parameter

Mandatory

Type

Description

subnet_id

Yes

String

Subnet ID, which consists of letters, digits, and underscores (_).

ip_address

No

String

IP address. If the value of this parameter is left blank or is set to an empty string, the IP address is automatically assigned.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

status

Boolean

CBH instance network status The CBH instance network is normal when all of the three are true. If any of them is false, the network is abnormal.

security_grp_status

Boolean

CBH instance security group status.

  • true: The status is normal.

  • false: The status is abnormal.

firewall_status

Boolean

CBH instance firewall status.

  • true: The status is normal.

  • false: The status is abnormal.

public_eip_status

Boolean

CBH instance EIP status.

  • true: The status is normal.

  • false: The status is abnormal.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

Incorrect request parameter.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

Failed to verify the token.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

Permissions required.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_description

String

CBH instances not found.

Example Requests

{
  "type" : "create",
  "security_groups" : [ {
    "id" : "02dcf62d-b84d-4a14-aad3-c310f2ceea55"
  } ],
  "nics" : [ {
    "subnet_id" : "dd08a6a9-ced7-484b-ace6-1b821854a772",
    "ip_address" : "100.93.5.36"
  } ]
}

Example Responses

Status code: 200

Cbh GetNetworkConfiguration Success

{
  "status" : false,
  "security_grp_status" : true,
  "firewall_status" : false,
  "public_eip_status" : true
}

Status Codes

Status Code

Description

200

Cbh GetNetworkConfiguration Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Querying CBH Details