Checking Server Endpoint Creation Status

Function

This API is used to query the creation status of each server endpoint.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/host-management/vpc-endpointes/batch-query

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
host_id_list	No	Array of strings	Definition Server ID list. Range The value can contain 1 to 64 characters.
vpc_id_list	No	Array of strings	Definition VPC ID list. Range The value can contain 1 to 64 characters.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data_list	Array of HostStatusInfo objects	Definition Server status list. Constraints N/A

**Table 5** HostStatusInfo
Parameter	Type	Description
host_id	String	Definition Server ID. Range The value can contain 1 to 64 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 128 characters.
public_ip	Array of strings	Definition EIP.
private_ip	Array of strings	Definition Private IP address.
status	String	Definition Server status. Range The value can contain 1 to 128 characters.
vpc_id	String	Definition VPC ID. Range The value can contain 1 to 128 characters.

Example Requests

Query the creation status of each server endpoint

GET https://{endpoint}/v5/{project_id}/host-management/vpc-endpointes/batch-query

{
  "host_id_list" : [ "xxxxxxxx" ],
  "vpc_id_list" : [ "xxxxxxxx" ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "host_id" : "12336789"
  }, {
    "host_name" : "name"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Server Management

Previous topic: Upgrading the Agent

Next topic: Creating a VPC Endpoint

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot