Function
This API is used to query versions of VPCEP APIs.
+- Example response
{ - "versions":[ - { - "updated":"2018-09-30T00:00:00Z", - "version":"1", - "min_version":"", - "status":"CURRENT", - "id":"v1", - "links":[ +- Example response
{ + "versions": [ { - "href":"https://{vpcep_uri}/v1", - "type":"application/json", - "rel":"self" + "status": "CURRENT", + "id": "v1", + "updated": "2018-09-30T00:00:00Z", + "version": "1", + "links": [ + { + "rel": "self", + "href": "https://{vpcep_uri}/v1", + "type": "application/json" + } + ], + "min_version": "" + }, + { + "status": "CURRENT", + "id": "v2", + "updated": "2020-03-30T00:00:00Z", + "version": "2", + "links": [ + { + "rel": "self", + "href": "https://{vpcep_uri}/v2", + "type": "application/json" + } + ], + "min_version": "" } - ] - } - ] + ] }
diff --git a/docs/vpcep/api-ref/vpcep_06_0102.html b/docs/vpcep/api-ref/vpcep_06_0102.html index 3997abd16..2d9079d1f 100644 --- a/docs/vpcep/api-ref/vpcep_06_0102.html +++ b/docs/vpcep/api-ref/vpcep_06_0102.html @@ -6,7 +6,7 @@URI
GET /{version}
Request
- Parameters
-
Table 1 Request parameters Parameter
+Table 1 Request parameter Parameter
Mandatory
- Example request
-Response
- Parameters
-
Table 2 Response parameters Parameter
+Response
- Parameter
+-
Table 2 Response parameter Parameter
Type
Table 3 VersionModel parameters Parameter
+ -Table 4 VersionLink parameters Parameter
+Table 4 VersionLink parameters Parameter
Type
diff --git a/docs/vpcep/api-ref/vpcep_06_0200.html b/docs/vpcep/api-ref/vpcep_06_0200.html index 67ea22462..b08377eac 100644 --- a/docs/vpcep/api-ref/vpcep_06_0200.html +++ b/docs/vpcep/api-ref/vpcep_06_0200.html @@ -6,7 +6,7 @@- Creating a VPC Endpoint Service
- - Querying Details of a VPC Endpoint Service
+ - Querying Details About a VPC Endpoint Service
- Modifying a VPC Endpoint Service
@@ -18,9 +18,13 @@
- Accepting or Rejecting a VPC Endpoint
- - Querying the Whitelist Records of a VPC Endpoint Service
+ - Querying Whitelist Records of a VPC Endpoint Service
- - Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service
+ - Batch Adding or Deleting Whitelist Records
+
+ - Querying Public VPC Endpoint Services
+
+ - Querying Basic Information About a VPC Endpoint Service
Creating a VPC Endpoint Service
-Function
This API is used to create a VPC endpoint service. Other users can create a VPC endpoint to connect to the endpoint service.
-
This API is an asynchronous interface. If it is successfully invoked, status code 200 is returned, indicating that the request has been successfully delivered. It takes 1 to 2 minutes to create a VPC endpoint service. You can view the creation result by performing operations in Querying Details of a VPC Endpoint Service.
+Function
This API is used to create a VPC endpoint service. Other users can create a VPC endpoint to connect to the endpoint service.
+ This API is asynchronous. If it is successfully invoked, status code 200 is returned, indicating that the request has been successfully delivered. It takes 1 to 2 minutes to create a VPC endpoint service. You can view the creation result by performing operations in Querying Details About a VPC Endpoint Service.
URI
POST /v1/{project_id}/vpc-endpoint-services
-Table 1 describes the required parameters. -Table 1 Parameter description Parameter
+Table 1 describes the parameter in this URI. +Table 1 URI parameter Parameter
Mandatory
Yes
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Request
- Parameter description
-
Table 2 Request parameters Parameter
+-Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
String
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID.
+Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in universally unique identifier (UUID) format.
The values are as follows:
-- If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field vip_port_id in Querying Details of a Load Balancer in the Elastic Load Balancing API Reference.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see Querying NICs of an ECS in the Elastic Load Balancing API Reference.
- If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
NOTE:- To create a VPC endpoint service, the CIDR block of the VPC where the VPC endpoint service is deployed cannot overlap with 198.19.128.0/20.
- The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/20.
- If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field port_id in Querying Details of a Load Balancer and Viewing Details of a Load Balancer in the Elastic Load Balancing API Reference.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see port_id in the response in section Querying NICs of an ECS in the Elastic Cloud Server API Reference.
- If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)
- If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)
NOTE:- To create a VPC endpoint service, the CIDR block of the VPC where the VPC endpoint service is deployed cannot overlap with 198.19.128.0/17.
- The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/17.
Specifies the ID of the cluster associated with the target VPCEP resource.
vip_port_id
-No
-String
-Specifies the ID of the virtual NIC to which the virtual IP address is bound.
-service_name
No
@@ -76,7 +67,7 @@String
Specifies the name of the VPC endpoint service. The name can contain a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).
-- If you do not specify this parameter, the VPC endpoint service name is in the format: regionName.serviceId.
- If you specify this parameter, the VPC endpoint service name is in the format: regionName.serviceName.serviceId.
- If you do not specify this parameter, the VPC endpoint service name is in the format: regionName.serviceId.
- If you specify this parameter, the VPC endpoint service name is in the format: regionName+.+serviceName+.+serviceId.
vpc_id
@@ -96,7 +87,7 @@Boolean
Specifies whether connection approval is required.
-- false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
- true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
- false: Connection approval is not required. The created VPC endpoint is in the accepted state.
- true: Connection approval is required. The created VPC endpoint is in the pendingAcceptance state until the owner of the associated VPC endpoint service approves the connection.
The default value is true.
String
Specifies the resource type.
-- VM: Select this value if the backend resource is an ECS. Backend resources of this type serve as servers.
- VIP: Select this value if the backend resource is a virtual IP address that functions as a physical server hosting virtual resources.
- LB: Select this value if the backend resource is an enhanced load balancer. Backend resources of this type suit services that receive high access traffic and demand high reliability and disaster recovery (DR) performance.
- LB: Select this value if the backend resource is a load balancer. Backend resources of this type suit services that receive high access traffic and demand high reliability and disaster recovery (DR) performance.
- VM: Select this value if the backend resource is an ECS. Backend resources of this type serve as servers.
- VIP: Select this value if the backend resource is a virtual IP address. (This value will be discarded. The LB type is recommended.)
- BMS: Select this value if the backend resource is a BMS. (This value will be discarded. The LB type is recommended.)
ports
@@ -129,7 +120,7 @@Array of objects
Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.
-Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same. A maximum of 200 port mappings can be created at a time.
+Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, either server_port or protocol, or both server_port and protocol of each VPC endpoint service must be unique. A maximum of 200 port mappings can be created at a time.
tcp_proxy
@@ -144,7 +135,7 @@- Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
This parameter is available only when the server can parse fields tcp option and tcp payload.
The values are as follows:
-- close: indicates that the TOA and Proxy Protocol methods are neither used.
- toa_open: indicates that the TOA method is used.
- proxy_open: indicates that the Proxy Protocol method is used.
- open: indicates that the TOA and Proxy Protocol methods are both used.
- close: The TOA and Proxy Protocol methods are neither used.
- toa_open: The TOA method is used.
- proxy_open: The Proxy Protocol method is used.
- open: The TOA and Proxy Protocol methods are both used.
- proxy_vni: The TOA Protocol method is not used. Proxy and virtual network ID are used.
The default value is close.
Table 3 Port mapping parameters Parameter
+-Table 3 Port parameters Parameter
Mandatory
Type
+Type
Description
+Description
String
Specifies the protocol used in port mappings. The protocol can be TCP or UDP. The default protocol is TCP.
+Specifies the port mapping protocol. TCP is supported.
+The default value is TCP.
Table 4 ResourceTags parameters Parameter
+Table 4 Tags parameters Parameter
Mandatory
+Mandatory
Type
String
Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).
+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
@@ -261,11 +253,11 @@Response
- Parameter description
-
Table 5 Response parameters Parameter
+-Table 5 Response parameters Parameter
Type
+Type
Description
+Description
String
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:
-- If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
vip_port_id
-String
-Specifies the ID of the virtual NIC to which the virtual IP address is bound.
-This parameter is returned only when port_id is set to VIP.
+Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in UUID format. The values are as follows:
+- If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)
- If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)
service_name
@@ -314,7 +298,7 @@String
Specifies the resource type.
-- VM: indicates the ECS.
- VIP: indicates the virtual IP address.
- LB: indicates the enhanced load balancer.
- LB: indicates a load balancer.
- VM: indicates an ECS.
- VIP: indicates a virtual IP address. (This value has been discarded. The LB type is recommended.)
- BMS: indicates a BMS. (This value has been discarded. The LB type is recommended.)
vpc_id
@@ -336,7 +320,7 @@Boolean
Specifies whether connection approval is required.
-- false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
- true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
- false: Connection approval is not required. The created VPC endpoint is in the accepted state.
- true: Connection approval is required. The created VPC endpoint is in the pendingAcceptance state until the owner of the associated VPC endpoint service approves the connection.
status
@@ -344,7 +328,7 @@String
Specifies the status of the VPC endpoint service.
-- creating: indicates the VPC endpoint service is being created.
- available: indicates the VPC endpoint service is connectable.
- failed: indicates the creation of the VPC endpoint service failed.
- creating: The VPC endpoint service is being created.
- available: The VPC endpoint service is connectable.
- failed: The VPC endpoint service failed to be created.
created_at
@@ -367,16 +351,7 @@String
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-cidr_type
-String
-Specifies the network segment type. The type can be public or internal.
-- public: indicates the public subnet CIDR block.
- internal: indicates the private subnet CIDR block.
The default value is internal.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
ports
@@ -384,7 +359,7 @@Array of objects
Lists the port mappings opened to the VPC endpoint service. For details, see Table 6.
-Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.
+Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, either server_port or protocol, or both server_port and protocol of each of these endpoint services must be unique.
tcp_proxy
@@ -397,7 +372,7 @@- Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
This parameter is available only when the server can parse fields tcp option and tcp payload.
The values are as follows:
-- close: indicates that the TOA and Proxy Protocol methods are neither used.
- toa_open: indicates that the TOA method is used.
- proxy_open: indicates that the Proxy Protocol method is used.
- open: indicates that the TOA and Proxy Protocol methods are both used.
- close: The TOA and Proxy Protocol methods are neither used.
- toa_open: The TOA method is used.
- proxy_open: The Proxy Protocol method is used.
- open: The TOA and Proxy Protocol methods are both used.
- proxy_vni: The TOA Protocol method is not used. Proxy and virtual network ID are used.
The default value is close.
-Table 6 Port mapping parameters Parameter
+ +- -Table 6 Port parameters Parameter
Type
+Type
Description
+Description
client_port
+client_port
Integer
+Integer
Specifies the port for accessing the VPC endpoint.
+Specifies the port for accessing the VPC endpoint.
This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535
server_port
+server_port
Integer
+Integer
Specifies the port for accessing the VPC endpoint service.
+Specifies the port for accessing the VPC endpoint service.
This port is provided by the backend service to provide services. Supported range: 1 to 65535
protocol
+protocol
String
+String
Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.
+Specifies the port mapping protocol. TCP is supported.
+The default value is TCP.
Table 7 ResourceTags parameters Parameter
+Table 7 Tags parameters Parameter
Type
String
Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).
+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 (-), and underscores (_).
+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 (@).
diff --git a/docs/vpcep/api-ref/vpcep_06_0202.html b/docs/vpcep/api-ref/vpcep_06_0202.html index dfce1c9f4..f9169cbd3 100644 --- a/docs/vpcep/api-ref/vpcep_06_0202.html +++ b/docs/vpcep/api-ref/vpcep_06_0202.html @@ -1,11 +1,11 @@ -Querying Details of a VPC Endpoint Service
-Function
This API is used to query details of a VPC endpoint service.
+Querying Details About a VPC Endpoint Service
+Function
This API is used to query details about a VPC endpoint service.
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
-Table 1 describes the required parameters. -Table 1 Parameter description Parameter
+Table 1 describes parameters in this URI. +Table 1 URI parameters Parameter
Mandatory
Yes
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
vpc_endpoint_service_id
@@ -33,16 +33,16 @@Request
- Parameter description -
- Example requestThis request is to query details of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88+- Example request
Response
- Parameter description
-
Table 2 Response parameters Parameter
+-Table 2 Response parameters Parameter
Type
Description
+Description
String
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:
-- If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in UUID format. The values are as follows:
+- If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)
- If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)
pool_id
@@ -68,14 +68,6 @@Specifies the ID of the cluster associated with the target VPCEP resource.
vip_port_id
-String
-Specifies the ID of the virtual NIC to which the virtual IP address is bound.
-This parameter is returned only when port_id is set to VIP.
-service_name
String
@@ -88,7 +80,7 @@String
Specifies the resource type.
-- VM: indicates the ECS.
- VIP: indicates the virtual IP address.
- LB: indicates the enhanced load balancer.
- LB: indicates a load balancer.
- VM: indicates an ECS.
- VIP: indicates a virtual IP address. (This value has been discarded. The LB type is recommended.)
- BMS: indicates a BMS. (This value has been discarded. The LB type is recommended.)
vpc_id
@@ -103,7 +95,7 @@Boolean
Specifies whether connection approval is required.
-- false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
- true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
- false: Connection approval is not required. The created VPC endpoint is in the accepted state.
- true: Connection approval is required. The created VPC endpoint is in the pendingAcceptance state until the owner of the associated VPC endpoint service approves the connection.
status
@@ -111,7 +103,7 @@String
Specifies the status of the VPC endpoint service.
-- creating: indicates the VPC endpoint service is being created.
- available: indicates the VPC endpoint service is connectable.
- failed: indicates the creation of the VPC endpoint service failed.
- deleting: indicates the VPC endpoint service is being deleted.
- creating: The VPC endpoint service is being created.
- available: The VPC endpoint service is connectable.
- failed: The VPC endpoint service failed to be created.
- deleting: The VPC endpoint service is being deleted.
service_type
@@ -144,16 +136,7 @@String
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-cidr_type
-String
-Specifies the network segment type. The type can be public or internal.
-- public: indicates the public subnet CIDR block.
- internal: indicates the private subnet CIDR block.
The default value is internal.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
ports
@@ -161,7 +144,7 @@Array of objects
Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.
-Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.
+Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, either server_port or protocol, or both server_port and protocol of each of these endpoint services must be unique.
tcp_proxy
@@ -174,7 +157,7 @@- Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
This parameter is available only when the server can parse fields tcp option and tcp payload.
The values are as follows:
-- close: indicates that the TOA and Proxy Protocol methods are neither used.
- toa_open: indicates that the TOA method is used.
- proxy_open: indicates that the Proxy Protocol method is used.
- open: indicates that the TOA and Proxy Protocol methods are both used.
- close: The TOA and Proxy Protocol methods are neither used.
- toa_open: The TOA method is used.
- proxy_open: The Proxy Protocol method is used.
- open: The TOA and Proxy Protocol methods are both used.
- proxy_vni: The TOA Protocol method is not used. Proxy and virtual network ID are used.
The default value is close.
This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 5.
+description
+String
+Supplementary information about the VPC endpoint service.
+Table 3 Port mapping parameters Parameter
+-Table 3 Port parameters Parameter
Type
Description
+Description
String
Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.
+Specifies the port mapping protocol. TCP is supported.
+The default value is TCP.
Table 4 ResourceTags parameters Parameter
+Table 4 Tags parameters Parameter
Type
String
Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).
+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 (-), and underscores (_).
+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 5 Error parameters Parameter
Type
+Type
Description
diff --git a/docs/vpcep/api-ref/vpcep_06_0203.html b/docs/vpcep/api-ref/vpcep_06_0203.html index a9076eae9..5f854e57c 100644 --- a/docs/vpcep/api-ref/vpcep_06_0203.html +++ b/docs/vpcep/api-ref/vpcep_06_0203.html @@ -1,11 +1,11 @@Modifying a VPC Endpoint Service
-Function
This API is used to modify a VPC endpoint service.
+Function
This API is used to modify a VPC endpoint service.
URI
PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
-Table 1 describes the required parameters. -Table 1 Parameter description Parameter
+Table 1 describes parameters in this URI. +Table 1 URI parameters Parameter
Mandatory
Yes
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
vpc_endpoint_service_id
@@ -33,13 +33,13 @@Request
- Parameter description
-
Table 2 Request parameters Parameter
+-Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
Boolean
Specifies whether connection approval is required.
-- false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
- true: indicates that connection approval is required. The created VPC endpoint is unavailable until the owner of the associated VPC endpoint service approves the connection.
- false: Connection approval is not required. The created VPC endpoint is in the accepted state.
- true: Connection approval is required. The created VPC endpoint is unavailable until the owner of the associated VPC endpoint service approves the connection.
The default value is true.
Array of objects
Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.
-Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same. A maximum of 200 port mappings can be created at a time.
+Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, either server_port or protocol, or both server_port and protocol of each of these endpoint services must be unique. A maximum of 200 port mappings can be created at a time.
port_id
@@ -79,30 +79,46 @@String
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:
-- If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field vip_port_id in Querying Details of a Load Balancer in the Elastic Load Balancing API Reference.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see Querying NICs of an ECS in the Elastic Load Balancing API Reference.
- If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in UUID format. The values are as follows:
+- If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field port_id in Querying Details of a Load Balancer and Viewing Details of a Load Balancer in the Elastic Load Balancing API Reference.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see port_id in the response in section Querying NICs of an ECS in the Elastic Cloud Server API Reference.
- If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)
- If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)
vip_port_id
+tcp_proxy
No
+No
String
+String
Specifies the ID of the virtual NIC to which the virtual IP address is bound.
+Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:
+- TCP TOA: The client information is inserted into field tcp option and transmitted to the server.NOTE:+
TCP TOA is supported only when the backend resource is OBS.
+ - Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
This parameter is available only when the server can parse fields tcp option and tcp payload.
+The values are as follows:
+- close: The TOA and Proxy Protocol methods are neither used.
- toa_open: The TOA method is used.
- proxy_open: The Proxy Protocol method is used.
- open: The TOA and Proxy Protocol methods are both used.
- proxy_vni: The TOA Protocol method is not used. Proxy and virtual network ID are used.
The default value is close.
+description
+No
+String
+Supplementary information about the VPC endpoint service. The description can contain a maximum of 128 characters and cannot contain left angle brackets (<) or right angle brackets (>).
Table 3 Port mapping parameters Parameter
+Table 3 Port parameters Parameter
Mandatory
Type
+Type
Description
+Description
String
Specifies the protocol used in port mappings. The protocol can be TCP or UDP. The default protocol is TCP.
+Specifies the port mapping protocol. TCP is supported.
+The default value is TCP.
Response
- Parameter description
-
Table 4 Response parameters Parameter
+Table 4 Response parameters Parameter
Type
+Type
Description
+Description
String
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:
-- If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in UUID format. The values are as follows:
+- If the backend resource is a load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
- If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
- If the backend resource is a virtual IP address, the value is the port ID of the physical server where virtual resources are created. (This value will be discarded. The LB type is recommended.)
- If the backend resource is a BMS, the value is the NIC ID of the BMS where the VPC endpoint service is deployed. (This value will be discarded. The LB type is recommended.)
pool_id
@@ -190,13 +207,6 @@Specifies the ID of the cluster associated with the target VPCEP resource.
vip_port_id
-String
-Specifies the ID of the virtual NIC to which the virtual IP address is bound.
-service_name
String
@@ -209,7 +219,7 @@String
Specifies the resource type.
-- VM: indicates the ECS.
- VIP: indicates the virtual IP address.
- LB: indicates the enhanced load balancer.
- LB: indicates a load balancer.
- VM: indicates an ECS.
- VIP: indicates a virtual IP address. (This value has been discarded. The LB type is recommended.)
- BMS: indicates a BMS. (This value has been discarded. The LB type is recommended.)
vpc_id
@@ -224,7 +234,7 @@Boolean
Specifies whether connection approval is required.
-- false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
- true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
- false: Connection approval is not required. The created VPC endpoint is in the accepted state.
- true: Connection approval is required. The created VPC endpoint is in the pendingAcceptance state until the owner of the associated VPC endpoint service approves the connection.
status
@@ -232,7 +242,7 @@String
Specifies the status of the VPC endpoint service.
-available: indicates the VPC endpoint service is connectable.
+- creating: The VPC endpoint service is being created.
- available: The VPC endpoint service is connectable.
- failed: The VPC endpoint service failed to be created.
service_type
@@ -265,16 +275,7 @@String
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
-cidr_type
-String
-Specifies the network segment type. The type can be public or internal.
-- public: indicates the public subnet CIDR block.
- internal: indicates the private subnet CIDR block.
The default value is internal.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
ports
@@ -282,21 +283,21 @@Array of objects
Lists the port mappings opened to the VPC endpoint service. For details, see Table 5.
-Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.
+Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, either server_port or protocol, or both server_port and protocol of each of these endpoint services must be unique.
tcp_proxy
String
Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:
-- TCP TOA: The client information is inserted into field tcp option and transmitted to the server.NOTE:
TCP TOA is supported only when the backend resource is OBS.
+Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:
+- TCP TOA: The client information is inserted into field tcp option and transmitted to the server.NOTE:-
TCP TOA is supported only when the backend resource is OBS.
- Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
This parameter is available only when the server can parse fields tcp option and tcp payload.
+- Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
+This parameter is available only when the server can parse fields tcp option and tcp payload.
The values are as follows:
-- close: indicates that the TOA and Proxy Protocol methods are neither used.
- toa_open: indicates that the TOA method is used.
- proxy_open: indicates that the Proxy Protocol method is used.
- open: indicates that the TOA and Proxy Protocol methods are both used.
The default value is close.
+- close: The TOA and Proxy Protocol methods are neither used.
- toa_open: The TOA method is used.
- proxy_open: The Proxy Protocol method is used.
- open: The TOA and Proxy Protocol methods are both used.
- proxy_vni: The TOA Protocol method is not used. Proxy and virtual network ID are used.
The default value is close.
- TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
tags
@@ -306,15 +307,22 @@Lists the resource tags. For details, see Table 6.
description
+String
+Supplementary information about the VPC endpoint service.
+-Table 5 Port mapping parameters Parameter
+Table 5 Port parameters Parameter
Type
Description
+Description
String
Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.
+Specifies the port mapping protocol. TCP is supported.
+The default value is TCP.
Table 6 ResourceTags parameters Parameter
+Table 6 Tags parameters Parameter
Type
String
Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).
+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 (-), and underscores (_).
+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 (@).
diff --git a/docs/vpcep/api-ref/vpcep_06_0204.html b/docs/vpcep/api-ref/vpcep_06_0204.html index 4cbe0bc8f..1c0ed261b 100644 --- a/docs/vpcep/api-ref/vpcep_06_0204.html +++ b/docs/vpcep/api-ref/vpcep_06_0204.html @@ -1,11 +1,13 @@Deleting a VPC Endpoint Service
-Function
This API is used to delete a VPC endpoint service.
+Function
This API is used to delete a VPC endpoint service.
+ This API is asynchronous. If it is successfully invoked, status code 200 is returned, indicating that the request has been successfully delivered. It takes 1 to 2 minutes to delete a VPC endpoint service. You can view the deletion result by performing operations in Querying Details About a VPC Endpoint Service.
+URI
DELETE /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
-Table 1 describes the required parameters. -Table 1 Parameters Parameter
+Table 1 describes parameters in this URI. +Table 1 URI parameters Parameter
Mandatory
Yes
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
vpc_endpoint_service_id
@@ -39,7 +41,7 @@-Response
None
diff --git a/docs/vpcep/api-ref/vpcep_06_0205.html b/docs/vpcep/api-ref/vpcep_06_0205.html index 797c8fd90..1fd17e63c 100644 --- a/docs/vpcep/api-ref/vpcep_06_0205.html +++ b/docs/vpcep/api-ref/vpcep_06_0205.html @@ -4,8 +4,8 @@Function
This API is used to query VPC endpoint services.
URI
GET /v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}
-Table 1 describes the required parameters. -Table 1 Parameter description Parameter
+Table 1 describes the parameter in this URI. +- -Table 1 URI parameter Parameter
Mandatory
Yes
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
+Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Request
- Parameter description
-
- Creating a VPC Endpoint Service
- Parameter
+
- Example response