Help Center/ EventGrid/ API Reference/ APIs/ Endpoint Management/ Creating an Endpoint
Updated on 2023-05-24 GMT+08:00
View PDF

Creating an Endpoint

Function

This API is used to create an endpoint.

URI

POST /v1/{project_id}/endpoints

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token 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.

Minimum: 1

Maximum: 16384
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the endpoint. The value must be unique under a tenant. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit.

Minimum: 1

Maximum: 128

vpc_id

Yes

String

ID of the VPC to which the endpoint belongs.

Maximum: 64

subnet_id

Yes

String

ID of the subnet to which the endpoint belongs.

Maximum: 64

description

No

String

Description.

Maximum: 255

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

id

String

ID of the endpoint.

name

String

Name of the endpoint.

vpc_id

String

ID of the VPC to which the endpoint belongs.

subnet_id

String

ID of the subnet to which the endpoint belongs.

domain

String

Access domain name.

description

String

Description.

status

String

Status of the endpoint.

Enumeration values:

  • CREATED

  • CREATING

  • CREATE_FAILED

  • DELETE_FAILED

type

String

Type of the endpoint.

Enumeration values:

  • PRIVATE

  • PUBLIC

scalable

Boolean

Whether the endpoint is accessible.

created_time

String

UTC time when the endpoint is created.

updated_time

String

UTC time when the endpoint is updated.

endpoints

Array of EndpointConnection objects

List of endpoints.
Table 6 EndpointConnection

Parameter

Type

Description

endpoint_service_id

String

Service ID of the endpoint.

endpoint_service_name

String

Service name of the endpoint.

marker_id

String

Packet ID of the endpoint.

id

String

Node ID of the endpoint.

ip

String

Node IP address of the endpoint.

created_time

String

Time when the endpoint is created.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 512

error_details

String

Error details.

Minimum: 1

Maximum: 1024

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

Create an endpoint.

/v1/{project_id}/endpoints

{
  "name" : "test",
  "description" : "",
  "subnet_id" : "{{subnet-id}}",
  "vpc_id" : "{{vpc-id}}"
}

Example Responses

Status code: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

Status code: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

Status code: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code

Description

200

Operation successful.

400

Invalid request.

401

Unauthorized.

403

Access denied.

404

Resource not found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Endpoint Management