Querying VPC Endpoints¶

Function¶

This API is used to query VPC endpoints.

URI¶

GET /v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}

Table 1 describes the parameter in this URI.

**Table 1** URI parameter¶
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query parameters¶
Parameter	Mandatory	Type	Description
endpoint_service_name	No	String	Specifies the name of the VPC endpoint service. The name is not case-sensitive and supports fuzzy match.
vpc_id	No	String	Specifies the ID of the VPC where the VPC endpoint is to be created.
id	No	String	Specifies the unique ID of the VPC endpoint.
limit	No	Integer	Specifies the maximum number of VPC endpoints displayed on each page. The number ranges from 0 to 1000 and is generally 10, 20, or 50. The default number is 10.
offset	No	Integer	Specifies the offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.
sort_key	No	String	Specifies the sorting field of the VPC endpoint list. The field can be: created_at: VPC endpoints are sorted by creation time. updated_at: VPC endpoints are sorted by update time. The default field is created_at.
sort_dir	No	String	Specifies the sorting method of the VPC endpoint list. The method can be: desc: VPC endpoints are sorted in descending order. asc: VPC endpoints are sorted in ascending order. The default method is desc.

Request¶

Parameter description
None

Example request

GET https://{endpoint}/v1/{project_id}/vpc-endpoints

Response¶

Parameter description

**Table 3** Response parameters¶
Parameter	Type	Description
endpoints	Array of objects	Lists the VPC endpoints. For details, see Table 4.
total_count	Integer	Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by the limit or offset.

**Table 4** endpoint parameters¶
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint.
service_type	String	Specifies the type of the VPC endpoint service that is associated with the VPC endpoint. Gateway: VPC endpoint services of this type are configured by O&M personnel. You can use them directly without the need to create one by yourselves. Interface: VPC endpoint services of this type include cloud services configured by O&M personnel and private services created by yourselves. You cannot configure these cloud services, but can use them. You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.
status	String	Specifies the connection status of the VPC endpoint. pendingAcceptance: The VPC endpoint is to be accepted. creating: The VPC endpoint is being created. accepted: The VPC endpoint has been accepted. rejected: The VPC endpoint has been rejected. failed: The VPC endpoint failed to be created. deleting: The VPC endpoint is being deleted.
active_status	Array of strings	Specifies the account status. arrear_frozen: frozen due to arrears verify_frozen: frozen due to lack of real-name authentication police_frozen: frozen for legal management illegal_frozen: frozen due to abuse partner_frozen: frozen for partnership active: The account is normal.
endpoint_service_name	String	Specifies the name of the VPC endpoint service.
marker_id	Integer	Specifies the packet ID of the VPC endpoint.
endpoint_service_id	String	Specifies the ID of the VPC endpoint service.
enable_dns	Boolean	Specifies whether to create a private domain name. true: A private domain name is created. false: A private domain name is not created. Note When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter enable_dns is set to true or false.
dns_names	Array of strings	Specifies the domain name for accessing the associated VPC endpoint service. Note This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service and enable_dns is set to true.
ip	String	Specifies the IP address for accessing the associated VPC endpoint service. This parameter is returned only under the following conditions: You query a VPC endpoint for accessing an interface VPC endpoint service. The connection approval function is enabled for the VPC endpoint service, and the connection has been approved. The status of the VPC endpoint can be Accepted or Rejected. The Rejected status only appears when the VPC endpoint is accepted and then rejected.
vpc_id	String	Specifies the ID of the VPC where the VPC endpoint is to be created.
subnet_id	String	Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in UUID format. Note This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
created_at	String	Specifies the creation time of the VPC endpoint. The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.
updated_at	String	Specifies the update time of the VPC endpoint. The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.
project_id	String	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
tags	Array of objects	Lists the resource tags. For details, see Table 5.
error	Array of objects	Specifies the error message. This field is returned when the status of the VPC endpoint changes to failed. For details, see Table 7.
whitelist	Array of strings	Specifies the whitelist for controlling access to the VPC endpoint. If you do not specify this parameter, an empty whitelist is returned. Note This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
enable_whitelist	Boolean	Specifies whether access control is enabled. true: Access control is enabled. false: Access control is disabled. If you do not specify this parameter, the whitelist is not enabled. Note This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
routetables	Array of strings	Lists the IDs of route tables. If you do not specify this parameter, the route table ID of the VPC is returned. Note This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.
policy_statement	Array of PolicyStatement objects	Specifies the policy of the gateway VPC endpoint. This parameter is available only when you create a gateway VPC endpoint. Default value: { "Action": [ "obs::" ], "Resource": [ "obs::::/", "obs::::*" ], "Effect": "Allow" }
description	String	Specifies the description of the VPC endpoint.
specification_name	String	Specifies the name of the VPC endpoint specifications.
endpoint_pool_id	String	(To be discarded) Specifies the ID of the cluster associated with the VPC endpoint.
enable_status	String	Specifies whether to enable the endpoint. enable: The endpoint will be enabled. disable: The endpoint will be disabled.

**Table 5** Tags parameters¶
Parameter	Type	Description
key	String	Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. key cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).
value	String	Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).

**Table 6** PolicyStatement¶
Parameter	Mandatory	Type	Description
Effect	Yes	String	Specifies the policy effect, which can be Allow or Deny.
Action	Yes	Array of strings	Specifies OBS access permissions.
Resource	Yes	Array of strings	Specifies the OBS object.

**Table 7** Error parameters¶
Parameter	Type	Description
error_code	String	Specifies the error code.
error_message	String	Specifies the error message.

Example response

{
 "endpoints": [
{
 "id": "59a40a87-abe0-4c1f-8bf0-63700128cb39",
 "status": "accepted",
 "tags": [],
 "marker_id": 201421455,
 "active_status": [
  "active"
 ],
 "vpc_id": "4cbf8757-86d1-459a-a7db-0fac9c1f679f",
 "service_type": "gateway",
 "project_id": "0df25bbc878***f88c00c2959df9a",
 "routetables": [
  "6416b1df-bbe8-4e51-8fa3-4d169b8cc3aa"
 ],
 "created_at": "2024-08-13T06:56:41Z",
 "updated_at": "2024-08-13T06:56:47Z",
 "endpoint_service_id": "e4a21a61-f09e-41bc-b487-23d6204ae27b",
 "endpoint_service_name": "test123",
 "policy_statement": [
  {
   "Action": [
    "*"
   ],
   "Resource": [
    "*"
   ],
   "Effect": "Allow"
  }
 ],
 "specification_name": "default",
 "enable_status": "enable",
 "description": "",
 "endpoint_pool_id": "d86778c4-ad4b-4abd-988e-8c2572047fe4"
},
{
 "id": "530d6f2f-d115-4df2-8c36-32d19f3c0bbc",
 "status": "accepted",
 "ip": "192.168.14.23",
 "tags": [
  {
   "key": "test2",
   "value": "test2"
  }
 ],
 "whitelist": [],
 "marker_id": 201515772,
 "active_status": [
  "active"
 ],
 "vpc_id": "d7b2bf07-1b4c-43fa-bd88-d80c6ebea140",
 "service_type": "interface",
 "project_id": "0df25bbc878***2f88c00c2959df9a",
 "subnet_id": "61881173-3899-4981-a700-170253d469b6",
 "enable_dns": false,
 "created_at": "2024-08-23T07:37:37Z",
 "updated_at": "2024-08-23T07:37:39Z",
 "endpoint_service_id": "2da0fe8f-5cb7-4d93-bb35-dc05334da1be",
 "endpoint_service_name": "test456",
 "enable_whitelist": false,
 "specification_name": "default",
 "enable_status": "enable",
 "description": "",
 "endpoint_pool_id": "0e796c11-6cf1-484a-9b8c-f837cb925287"
}
],
 "total_count": 2
}

Status Codes¶

See Status Codes.

last updated: 2024-11-14 08:38 UTC - commit: d5f937b8ffcdec990d2b3c951f592107b12c8062