Batch Deleting Whitelist Records of a VPC Endpoint Service
Function
This API is used to batch delete whitelist records of a VPC endpoint service.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vpcep:endpointServices:deletePermissions
Permission_management
endpointServices *
-
- vpcep:permissions:update
-
URI
POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/batch-delete
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Specifies the project ID. |
|
vpc_endpoint_service_id |
Yes |
String |
Specifies the ID of the VPC endpoint service. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. |
|
Content-Type |
No |
String |
Specifies the MIME type of the request body. Default value application/json is recommended. For APIs used to upload objects or images, the MIME type varies depending on the flow type. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
permissions |
Yes |
Array of EpsRemovePermissionRequest objects |
Specifies the whitelist of the VPC endpoint service. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
permissions |
Array of EpsPermission objects |
Specifies the whitelist of the VPC endpoint service. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Specifies primary key IDs of whitelist records of a VPC endpoint service. |
|
permission |
String |
The permission format is iam:domain::domain_id or organizations:orgPath::org_path.
domain_id can contain only letters and digits. org_path can contain only letters, digits, forward slashes (/), and hyphens (-). You can also enter an asterisk () for domain_id or org_path, which indicates that this VPC endpoint service allows accesses from any VPC endpoint. Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd or organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/ |
|
permission_type |
String |
Specifies the whitelist type of the VPC endpoint service.
|
|
description |
String |
Specifies the description of a whitelist record of a VPC endpoint service. |
|
created_at |
String |
Specifies the time when a whitelist record is created. |
Example Requests
Batch deleting whitelist records of a VPC endpoint service
POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/permissions/batch-delete
{
"permissions" : [ {
"id" : "b9b6f264-3562-4f62-ba84-c128da20d18d"
}, {
"id" : "c07132bf-4071-439a-9ff3-2068eb45092f"
} ]
}
Example Responses
Status code: 200
The server has successfully processed the request.
{
"permissions" : [ ]
}
SDK Sample Code
The SDK sample code is as follows.
Batch deleting whitelist records of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion; import com.huaweicloud.sdk.vpcep.v1.*; import com.huaweicloud.sdk.vpcep.v1.model.*; import java.util.List; import java.util.ArrayList; public class BatchRemoveEndpointServicePermissionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcepClient client = VpcepClient.newBuilder() .withCredential(auth) .withRegion(VpcepRegion.valueOf("<YOUR REGION>")) .build(); BatchRemoveEndpointServicePermissionsRequest request = new BatchRemoveEndpointServicePermissionsRequest(); request.withVpcEndpointServiceId("{vpc_endpoint_service_id}"); BatchRemoveEndpointServicePermissionsRequestBody body = new BatchRemoveEndpointServicePermissionsRequestBody(); List<EpsRemovePermissionRequest> listbodyPermissions = new ArrayList<>(); listbodyPermissions.add( new EpsRemovePermissionRequest() .withId("b9b6f264-3562-4f62-ba84-c128da20d18d") ); listbodyPermissions.add( new EpsRemovePermissionRequest() .withId("c07132bf-4071-439a-9ff3-2068eb45092f") ); body.withPermissions(listbodyPermissions); request.withBody(body); try { BatchRemoveEndpointServicePermissionsResponse response = client.batchRemoveEndpointServicePermissions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Batch deleting whitelist records of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpcep.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcepClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcepRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchRemoveEndpointServicePermissionsRequest() request.vpc_endpoint_service_id = "{vpc_endpoint_service_id}" listPermissionsbody = [ EpsRemovePermissionRequest( id="b9b6f264-3562-4f62-ba84-c128da20d18d" ), EpsRemovePermissionRequest( id="c07132bf-4071-439a-9ff3-2068eb45092f" ) ] request.body = BatchRemoveEndpointServicePermissionsRequestBody( permissions=listPermissionsbody ) response = client.batch_remove_endpoint_service_permissions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Batch deleting whitelist records of a VPC endpoint service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpcep.NewVpcepClient( vpcep.VpcepClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchRemoveEndpointServicePermissionsRequest{} request.VpcEndpointServiceId = "{vpc_endpoint_service_id}" var listPermissionsbody = []model.EpsRemovePermissionRequest{ { Id: "b9b6f264-3562-4f62-ba84-c128da20d18d", }, { Id: "c07132bf-4071-439a-9ff3-2068eb45092f", }, } request.Body = &model.BatchRemoveEndpointServicePermissionsRequestBody{ Permissions: listPermissionsbody, } response, err := client.BatchRemoveEndpointServicePermissions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The server has successfully processed the request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot