Diese Seite ist in Ihrer lokalen Sprache noch nicht verfügbar. Wir arbeiten daran, weitere Sprachversionen hinzuzufügen. Vielen Dank für Ihre Unterstützung.
Creating an Endpoint
Function
This API is used to create an endpoint.
URI
POST /v1/{project_id}/endpoints
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant project ID. |
Request 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 |
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
Parameter |
Type |
Description |
---|---|---|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
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:
|
type |
String |
Type of the endpoint. Enumeration values:
|
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. |
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
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
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
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
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
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.