Parameter |
-Mandatory + | Mandatory |
Type |
@@ -255,9 +264,9 @@
|---|
Parameter |
-Type + | Type |
-Description + | Description |
String |
Specifies the type of the VPC endpoint service. -There are two types of VPC endpoint services: interface and gateway.
There are two types of VPC endpoint services: interface and gateway.
You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types. |
@@ -320,7 +329,7 @@
Boolean |
Specifies whether connection approval is required. -
|
|---|---|---|---|---|
status @@ -383,6 +392,13 @@ | Lists the resource tags. For details, see Table 7. |
|||
description + |
+String + |
+Supplementary information about the VPC endpoint service. + |
+
Type
Description
+Description
Response
- Parameter description
-
Table 2 Response parameters Parameter
+Table 2 Response parameters Parameter
Type
Description
+Description
Boolean
Specifies whether connection approval is required.
-- 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.
- 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 +111,7 @@String
Specifies the type of the VPC endpoint service.
-There are two types of VPC endpoint services: interface and gateway.- Gateway: VPC endpoint services of this type are configured by operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
There are two types of VPC endpoint services: interface and gateway.- 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.
Type
Description
+Description
Table 5 Error parameters Parameter
Type
+Type
Description
Request
- Parameter description
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 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.)
- 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.
- 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 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.)
tcp_proxy
@@ -116,9 +116,9 @@Mandatory
Type
+Type
Description
+Description
Response
- Parameter description
-
Table 4 Response parameters Parameter
+Table 4 Response parameters Parameter
Type
+Type
Description
+Description
Boolean
Specifies whether connection approval is required.
-- 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.
- 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
@@ -250,7 +250,7 @@String
Specifies the type of the VPC endpoint service.
-There are two types of VPC endpoint services: interface and gateway.- Gateway: VPC endpoint services of this type are configured by operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
There are two types of VPC endpoint services: interface and gateway.- 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.
Type
Description
+Description
Table 2 Query parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
Response
- Parameter description
-
Table 3 Response parameters Parameter
+@@ -300,7 +307,7 @@Table 3 Response parameters Parameter
Type
+Type
Description
+Description
Boolean
Specifies whether connection approval is required.
-- 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.
- 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
@@ -198,7 +198,7 @@String
Specifies the status of the VPC endpoint service.
-- 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.
- 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
@@ -206,7 +206,7 @@String
Specifies the type of the VPC endpoint service.
-There are two types of VPC endpoint services: interface and gateway.- Gateway: VPC endpoint services of this type are configured by operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
There are two types of VPC endpoint services: interface and gateway.- 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.
Specifies the ID of the cluster the VPC endpoint belongs to.
description
+String
+Supplementary information about the VPC endpoint service.
+Type
Description
+Description
Table 7 Error parameters Parameter
Type
+Type
Description
Table 5 Error parameters Parameter
Type
+Type
Description
Table 5 Error parameters Parameter
Type
+Type
Description
Querying Whitelist Records of a VPC Endpoint Service
Function
This API is used to query whitelist records of a VPC endpoint service.
-
Your domain ID is in the whitelist of your own VPC endpoint service by default.
+ Your account ID is in the whitelist of your own VPC endpoint service by default.
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions?permission={permission}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}
@@ -36,11 +36,11 @@Table 2 Query parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
String
Specifies the authorized domain ID. The format is the iam:domain::domain_id.
-domain_id indicates the domain ID, for example, iam:domain::6e9dfd51d1124e8d8498dce894923a0d
+Specifies the authorized account ID. The format is the iam:domain::domain_id.
+domain_id indicates the account ID, for example, iam:domain::6e9dfd51d1124e8d8498dce894923a0d
Fuzzy search is supported.
Response
- Parameter description
-
Table 3 Response parameters Parameter
+Table 3 Response parameters Parameter
Type
+Type
Description
+Description
Table 4 permissions parameters Parameter
Type
+Type
Description
+Description
Batch Adding or Deleting Whitelist Records
Function
This API is used to batch add or delete whitelist records of a VPC endpoint service.
- Your domain ID is in the whitelist of your own VPC endpoint service by default.
+ Your account ID is in the whitelist of your own VPC endpoint service by default.
URI
POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action
@@ -41,7 +41,7 @@Type
Description
+Description
Lists the whitelist records.
The record is in the iam:domain::domain_id format.
Fields are described as follows:
-- iam:domain:: is fixed.
- domain_id indicates the domain ID of the target user.
The value contains 1 to 64 characters, including letters, digits, and asterisks (*). If you enter an asterisk, this VPC endpoint service allows access from any VPC endpoints.
+- iam:domain:: is fixed.
- domain_id indicates the account ID of the target user.
The value contains 1 to 64 characters, including letters, digits, and asterisks (*). If you enter an asterisk, this VPC endpoint service allows access from any VPC endpoints.
Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd
Response
- Parameter description
-
Table 3 Response parameter Parameter
+Table 3 Response parameter Parameter
Type
+Type
Description
+Description
String
Specifies the type of the VPC endpoint service. The value can be:-- Gateway: VPC endpoint services of this type are configured by operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
- 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.
String
Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
-- Gateway: VPC endpoint services of this type are configured by operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
- 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.
Request
- Parameter description
+
Request
- Parameter description
Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
String
Specifies the ID of the VPC where the VPC endpoint is to be created.
-For details, see response field id in Querying VPC Details in the Virtual Private Cloud API Reference.
+For details, see response field id in Querying VPC Details in Virtual Private Cloud API Reference.
enable_dns
@@ -103,7 +103,7 @@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.
+NOTE:This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.
Specifies the name of the VPC endpoint specifications.
policy_statement
+No
+Array of PolicyStatement objects
+Specifies the policy of the gateway VPC endpoint.
+This parameter is available only when you create a gateway VPC endpoint.
+Array length: 0–10
+Default value:
+{ + "Action": [ + "obs:*:*" + ], + "Resource": [ + "obs:*:*:*:*/*", + "obs:*:*:*:*" + ], + "Effect": "Allow" +}+description
No
@@ -168,7 +190,7 @@ -- Example request
POST https://{endpoint}/v1/{project_id}/vpc-endpoints--{ -"subnet_id": "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de", -"vpc_id": "84758cf5-9c62-43ae-a778-3dbd8370c0a4", -"tags":[ - { - "key":"test1", - "value":"test1" - } - ], -"endpoint_service_id":"e0c748b7-d982-47df-ba06-b9c8c7650c1a", -"enable_dns":true -}+ +- +Table 4 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.
+- Example request
POST https://{endpoint}/v1/{project_id}/vpc-endpoints+Creating an interface VPC endpoint
+{ + "subnet_id": "61881173-3899-4981-a700-170253d469b6", + "endpoint_service_id": "2da0fe8f-5cb7-4d93-bb35-dc05334da1be", + "vpc_id": "d7b2bf07-1b4c-43fa-bd88-d80c6ebea140", + "tags": [ + { + "key": "test2", + "value": "test2" + } + ] +}+Creating a gateway VPC endpoint
+{ + "endpoint_service_id": "e4a21a61-f09e-41bc-b487-23d6204ae27b", + "vpc_id": "d7b2bf07-1b4c-43fa-bd88-d80c6ebea140", + "enable_dns": true, + "tags": [ + { + "key": "test1", + "value": "test1" + } + ], + "routetables": [ + "cd7fdf2b-d964-4a4a-a169-2af1112e7d02" + ] +}Response
- Parameter description
-
Table 4 Response parameters Parameter
+Response
- Parameter description
+-
Table 5 Response parameters Parameter
Type
+Type
Description
+Description
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 operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
- 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 view those VPC endpoint services that are configured by operations people and are visible and accessible to all users. For detailed steps, see Querying Public VPC Endpoint Services. Perform the operations in Creating a VPC Endpoint Service to create an interface VPC endpoint service.
Array of strings
Specifies the domain 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 domain is normal.
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
@@ -338,7 +414,7 @@Array of objects
Lists the resource tags. For details, see Table 5.
+Lists the resource tags. For details, see Table 6.
whitelist
@@ -356,7 +432,7 @@Boolean
Specifies whether access control is enabled.
-- true: Access control is enabled.
- false: Access control is disabled.
- true: Access control is enabled.
- false: Access control is disabled.
If you do not specify this parameter, the whitelist is not enabled.
NOTE:@@ -368,7 +444,7 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
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.
+NOTE:This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.
- enable: The endpoint will be enabled.
- disable: The endpoint will be disabled.
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" +}+endpoint_pool_id
String
@@ -405,7 +500,7 @@Table 5 Tags parameters Parameter
+ + +-
+Table 7 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.
+- Example response
{ - "id": "4189d3c2-8882-4871-a3c2-d380272eed83", - "status": "creating", - "service_type": "interface", - "marker_id": 322312312312, - "active_status":[ - "active" - ], - "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83", - "enable_dns": false, - "endpoint_service_name": "test123", - "endpoint_service_id": "test123", - "project_id": "6e9dfd51d1124e8d8498dce894923a0d", - "whitelist": [ - "127.0.0.1" - ], - "enable_whitelist": true, - "specification_name":"default", - "enable_status":"enable", - "endpoint_pool_id":"501f4a3b-6f96-4309-97d1-e291b8ca5b96", - "description":"demo", - "created_at": "2018-01-30T07:42:01Z", - "updated_at": "2018-01-30T07:42:01Z", - "tags": [ - { - "key": "test1", - "value": "test1" - } - ] +- Example response
An interface VPC endpoint has been created.
+{ + "id": "530d6f2f-d115-4df2-8c36-32d19f3c0bbc", + "status": "creating", + "tags": [ + { + "key": "test2", + "value": "test2" + } + ], + "whitelist": [], + "marker_id": 201515772, + "active_status": [ + "active" + ], + "vpc_id": "d7b2bf07-1b4c-43fa-bd88-d80c6ebea140", + "service_type": "interface", + "project_id": "0df25bbc*****62f88c00c2959df9a", + "subnet_id": "61881173-3899-4981-a700-170253d469b6", + "enable_dns": false, + "created_at": "2024-08-23T07:37:37Z", + "updated_at": "2024-08-23T07:37:37Z", + "endpoint_service_id": "2da0fe8f-5cb7-4d93-bb35-dc05334da1be", + "endpoint_service_name": "test123", + "enable_whitelist": false, + "specification_name": "default", + "enable_status": "enable", + "description": "", + "endpoint_pool_id": "0e796c11-6cf1-484a-9b8c-f837cb925287" +}+A gateway VPC endpoint has been created.
+{ + "id": "093998ea-ebaa-440d-8c75-935178e4dd93", + "status": "creating", + "tags": [ + { + "key": "test1", + "value": "test1" + } + ], + "marker_id": 201414431, + "active_status": [ + "active" + ], + "vpc_id": "d7b2bf07-1b4c-43fa-bd88-d80c6ebea140", + "service_type": "gateway", + "project_id": "0df25bbc87****8c00c2959df9a", + "routetables": [ + "cd7fdf2b-d964-4a4a-a169-2af1112e7d02" + ], + "created_at": "2024-08-23T07:23:22Z", + "updated_at": "2024-08-23T07:23:22Z", + "endpoint_service_id": "e4a21a61-f09e-41bc-b487-23d6204ae27b" + "endpoint_service_name": "test123", + "policy_statement": [ + { + "Action": [ + "obs:*:*" + ], + "Resource": [ + "obs:*:*:*:*/*", + "obs:*:*:*:*" + ], + "Effect": "Allow" + } + ], + "specification_name": "default", + "enable_status": "enable", + "description": "", + "endpoint_pool_id": "d86778c4-ad4b-4abd-988e-8c2572047fe4" }-
diff --git a/docs/vpcep/api-ref/vpcep_06_0304.html b/docs/vpcep/api-ref/vpcep_06_0304.html index 058e8216..712dca94 100644 --- a/docs/vpcep/api-ref/vpcep_06_0304.html +++ b/docs/vpcep/api-ref/vpcep_06_0304.html @@ -37,12 +37,12 @@Status Codes
See Status Codes.
- Example response
Response
- Parameter description
-
Table 2 Response parameters Parameter
+Response
- Parameter description
+-
Table 2 Response parameters Parameter
Type
Description
+Description
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 operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
- 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.
status
@@ -73,8 +73,8 @@Array of strings
Specifies the domain 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 domain is normal.
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
@@ -178,7 +178,7 @@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 4.
+This field is returned when the status of the VPC endpoint changes to failed. For details, see Table 5.
whitelist
@@ -196,7 +196,7 @@Boolean
Specifies whether access control is enabled.
-- true: Access control is enabled.
- false: Access control is disabled.
- true: Access control is enabled.
- false: Access control is disabled.
If you do not specify this parameter, the whitelist is not enabled.
NOTE:@@ -207,9 +207,26 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
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.
-If you do not specify this parameter, the route table ID of the VPC is returned in 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
@@ -271,26 +288,67 @@Table 4 Error parameters Parameter
++ +
+Table 4 PolicyStatement Parameter
Type
+Mandatory
Description
+Type
+Description
error_code
+Effect
String
+Yes
Specifies the error code.
+String
+Specifies the policy effect, which can be Allow or Deny.
error_message
+Action
String
+Yes
Specifies the error message.
+Array of strings
+Specifies OBS access permissions.
+Resource
+Yes
+Array of strings
+Specifies the OBS object.
+Table 5 Error parameters Parameter
+Type
+Description
+error_code
+String
+Specifies the error code.
+error_message
+String
+Specifies the error message.
- Example response
{ - "id": "4189d3c2-8882-4871-a3c2-d380272eed83", - "status": "accepted", - "service_type": "interface", - "marker_id": 322312312312, - "active_status":[ - "active" - ], - "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83", - "enable_dns": false, - "endpoint_service_name": "test123", - "endpoint_service_id": "test123", - "project_id": "6e9dfd51d1124e8d8498dce894923a0d", - "whitelist": [ - "127.0.0.1" - ], - "enable_whitelist": true, - "specification_name":"default", - "endpoint_pool_id":"501f4a3b-6f96-4309-97d1-e291b8ca5b96", - "description":"demo", - "created_at": "2018-01-30T07:42:01Z", - "updated_at": "2018-01-30T07:42:01Z", - "description" : "", - "tags": [ - { - "key": "test1", - "value": "test1" - } - ] +- Example response
Querying details of an interface VPC endpoint
+{ + "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, + "routetables": [], + "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" +}+Querying details of a gateway VPC endpoint
+{ + "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" }
Status Codes
See Status Codes.
diff --git a/docs/vpcep/api-ref/vpcep_06_0306.html b/docs/vpcep/api-ref/vpcep_06_0306.html index 7cc1199a..86a24163 100644 --- a/docs/vpcep/api-ref/vpcep_06_0306.html +++ b/docs/vpcep/api-ref/vpcep_06_0306.html @@ -27,11 +27,11 @@Table 2 Query parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
Response
- Parameter description
-
Table 3 Response parameters Parameter
+Table 3 Response parameters Parameter
Type
+Type
Description
+Description
-Table 4 endpoint parameters Parameter
Type
+Type
Description
+Description
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 operations people. 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 operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
- 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.
Array of strings
Specifies the domain 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 domain is normal.
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
@@ -280,7 +280,7 @@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 6.
+This field is returned when the status of the VPC endpoint changes to failed. For details, see Table 7.
whitelist
@@ -298,7 +298,7 @@Boolean
Specifies whether access control is enabled.
-- true: Access control is enabled.
- false: Access control is disabled.
- true: Access control is enabled.
- false: Access control is disabled.
If you do not specify this parameter, the whitelist is not enabled.
NOTE:@@ -310,10 +310,29 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
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.
+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
@@ -374,26 +393,67 @@Table 6 Error parameters Parameter
++ +
+Table 6 PolicyStatement Parameter
Type
+Mandatory
Description
+Type
+Description
error_code
+Effect
String
+Yes
Specifies the error code.
+String
+Specifies the policy effect, which can be Allow or Deny.
error_message
+Action
String
+Yes
Specifies the error message.
+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":"03184a04-95d5-4555-86c4-e767a371ff99", - "status":"accepted", - "ip":"192.168.0.232", - "marker_id":16777337, - "active_status":[ - "active" - ], - "vpc_id":"84758cf5-9c62-43ae-a778-3dbd8370c0a4", - "service_type":"interface", - "project_id":"295dacf46a4842fcbf7844dc2dc2489d", - "subnet_id":"68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de", - "enable_dns":"true", - "specification_name":"default", - "endpoint_pool_id":"501f4a3b-6f96-4309-97d1-e291b8ca5b96", - "dns_name":"test123", - "created_at":"2018-10-18T06:49:46Z", - "updated_at":"2018-10-18T06:49:50Z", - "endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78", - "endpoint_service_name":"test123", - "whitelist":["127.0.0.1"], - "enable_whitelist":true, - "description" : "", - "tags": - [ - { - "key":"test1", - "value":"test1" - } - ] - }, - { - "id":"43b0e3b0-eec9-49da-866b-6687b75f9fe5", - "status":"accepted", - "ip":"192.168.0.115", - "marker_id":16777322, - "active_status":[ - "active" - ], - "vpc_id":"e251b400-2963-4131-b38a-da81e32026ee", - "service_type":"interface", - "project_id":"295dacf46a4842fcbf7844dc2dc2489d", - "subnet_id":"65528a22-59a1-4972-ba64-88984b3207cd", - "enable_dns":"true", - "specification_name":"default", - "endpoint_pool_id":"ee38223b-aacb-46f0-ba7e-94fa62e35dde", - "dns_name":"test123", - "created_at":"2018-10-18T06:36:20Z", - "updated_at":"2018-10-18T06:36:24Z", - "endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78", - "endpoint_service_name":"test123", - "whitelist":["127.0.0.1"], - "enable_whitelist":true, - "description" : "", - "tags": - [ - { - "key":"test1", - "value":"test1" - } - ] - } +- Example response
{ + "endpoints": [ +{ + "id": "59a40a87-abe0-4c1f-8bf0-63700128cb39", + "status": "accepted", + "tags": [], + "marker_id": 201421455, + "active_status": [ + "active" ], - "total_count":2 + "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 }-
diff --git a/docs/vpcep/api-ref/vpcep_06_0500.html b/docs/vpcep/api-ref/vpcep_06_0500.html index c78b1651..ffa2013c 100644 --- a/docs/vpcep/api-ref/vpcep_06_0500.html +++ b/docs/vpcep/api-ref/vpcep_06_0500.html @@ -1,6 +1,6 @@ -Status Codes
See Status Codes.
Tag Function
+Tags
-
diff --git a/docs/vpcep/api-ref/vpcep_06_0501.html b/docs/vpcep/api-ref/vpcep_06_0501.html
index 88302c47..f2d4cb2a 100644
--- a/docs/vpcep/api-ref/vpcep_06_0501.html
+++ b/docs/vpcep/api-ref/vpcep_06_0501.html
@@ -414,7 +414,7 @@
diff --git a/docs/vpcep/api-ref/vpcep_06_0502.html b/docs/vpcep/api-ref/vpcep_06_0502.html index fa010506..82054472 100644 --- a/docs/vpcep/api-ref/vpcep_06_0502.html +++ b/docs/vpcep/api-ref/vpcep_06_0502.html @@ -153,7 +153,7 @@-Parent topic: Tag Function+Parent topic: Tagsdiff --git a/docs/vpcep/api-ref/vpcep_06_0503.html b/docs/vpcep/api-ref/vpcep_06_0503.html index 2743b481..14a1276d 100644 --- a/docs/vpcep/api-ref/vpcep_06_0503.html +++ b/docs/vpcep/api-ref/vpcep_06_0503.html @@ -117,7 +117,7 @@-Parent topic: Tag Function+Parent topic: Tagsdiff --git a/docs/vpcep/api-ref/vpcep_06_0504.html b/docs/vpcep/api-ref/vpcep_06_0504.html index 67000dbd..30f2a267 100644 --- a/docs/vpcep/api-ref/vpcep_06_0504.html +++ b/docs/vpcep/api-ref/vpcep_06_0504.html @@ -8,7 +8,7 @@-Parent topic: Tag Function+Parent topic: Tagsdiff --git a/docs/vpcep/api-ref/vpcep_08_0002.html b/docs/vpcep/api-ref/vpcep_08_0002.html index be36545b..b0886961 100644 --- a/docs/vpcep/api-ref/vpcep_08_0002.html +++ b/docs/vpcep/api-ref/vpcep_08_0002.html @@ -12,7 +12,6 @@ "error_msg": "Parameter error." }-Parent topic: Tag Function+Parent topic: Tags - Example response
Descriptions of Error Codes
An error code returned by an API does not correspond to an error message.
diff --git a/docs/vpcep/api-ref/vpcep_08_0003.html b/docs/vpcep/api-ref/vpcep_08_0003.html index 5536a459..2db31c96 100644 --- a/docs/vpcep/api-ref/vpcep_08_0003.html +++ b/docs/vpcep/api-ref/vpcep_08_0003.html @@ -1,11 +1,11 @@Obtaining a Project ID
-Scenarios
A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
+Scenarios
A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
Obtain the Project ID by Calling an API
You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
-The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints.
+The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints.
The following is an example response. The value of id is the project ID.
{ "projects": [ @@ -32,7 +32,7 @@ }Obtain a Project ID from the Console
A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:- Log in to the management console.
- Click the username and select My Credentials from the drop-down list.
On the My Credentials page, view project IDs in the project list.
-Figure 1 Viewing project IDs+
Figure 1 Viewing project IDs
In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.
- Example response
- Parameter description
+
- Parameter description
+
- Example request
- Parameter description