2023-04-26
diff --git a/docs/vpcep/api-ref/vpcep_06_0201.html b/docs/vpcep/api-ref/vpcep_06_0201.html index 70c6bcd2f..87995f437 100644 --- a/docs/vpcep/api-ref/vpcep_06_0201.html +++ b/docs/vpcep/api-ref/vpcep_06_0201.html @@ -30,11 +30,11 @@Request
- Parameter description
Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
Mandatory
Type
+Type
Description
+Description
Table 4 Tags parameters Parameter
Mandatory
+Mandatory
Type
Response
- Parameter description
Table 5 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
@@ -407,7 +407,7 @@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
@@ -191,7 +191,7 @@Type
Description
+Description
Table 5 Error parameters Parameter
Type
+Type
Description
Request
- Parameter description
Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
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
@@ -322,7 +322,7 @@Type
Description
+Description
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
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
@@ -307,7 +307,7 @@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 account 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 account ID. The format is the iam:domain::domain_id.
-domain_id indicates the account 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
Specifies the description of a whitelist record of a VPC endpoint service. The description can contain a maximum of 128 characters and cannot contain left angle brackets (<) or right angle brackets (>).
permission_type
+String
+Specifies the whitelist type of the VPC endpoint service.
+Only domainId is supported, which indicates the whitelisted IDs of accounts that can create VPC endpoints to connect to the VPC endpoint service.
+created_at
String
@@ -181,6 +189,7 @@ "id":"f2659906-c622-480a-83e9-ef42bdb67b90", "permission":"*", "description":"demo", + "permission_type": "domainId", "created_at":"2018-10-18T13:26:40Z" } ], diff --git a/docs/vpcep/api-ref/vpcep_06_0209.html b/docs/vpcep/api-ref/vpcep_06_0209.html index 45b4906eb..394b4f1b1 100644 --- a/docs/vpcep/api-ref/vpcep_06_0209.html +++ b/docs/vpcep/api-ref/vpcep_06_0209.html @@ -2,7 +2,7 @@Batch Adding or Deleting Whitelist Records
Function
This API is used to batch add or delete whitelist records of a VPC endpoint service.
- Your account 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 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.
+- 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
Request
- Parameter description
Table 2 Request parameters Parameter
Mandatory
+Mandatory
Type
Description
+Description
Table 4 PolicyStatement Parameter
+Table 4 PolicyStatement Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Response
- Parameter description
-
Table 5 Response parameters Parameter
+-Table 5 Response parameters Parameter
Type
+Type
Description
+Description
Array of strings
Specifies the account status.
+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.
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.
- The API for creating a VPC endpoint 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. You can view the creation result by performing operations in Querying Details About a VPC Endpoint Service.
subnet_id
String
@@ -432,7 +423,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:@@ -526,13 +517,13 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
Table 7 PolicyStatement Parameter
+Table 7 PolicyStatement Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Response
- Parameter description
-
Table 2 Response parameters Parameter
+-Table 2 Response parameters Parameter
Type
Description
+Description
Array of strings
Specifies the account status.
+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.
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:@@ -288,13 +288,13 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
Table 4 PolicyStatement Parameter
+Table 4 PolicyStatement Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Table 5 Error parameters Parameter
Type
+Type
Description
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
Array of strings
Specifies the account status.
+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.
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.
+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.
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:@@ -393,13 +393,13 @@This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
Table 6 PolicyStatement Parameter
+Table 6 PolicyStatement Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
Table 7 Error parameters Parameter
Type
+Type
Description
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.
+You can call the API (GET https://{Endpoint}/v3/projects) to obtain a project ID. {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": [
- Parameter description
-
- Parameter description
- Parameter description
-
- Parameter description