Accepting or Rejecting a VPC Endpoint
Function
This API is used to accept or reject a VPC endpoint for a VPC endpoint service.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 1 Maximum: 64 |
vpc_endpoint_service_id |
Yes |
String |
Specifies the ID of the VPC endpoint service. Minimum: 1 Maximum: 64 |
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. Default: application/json |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
String |
Specifies whether to accept or reject a VPC endpoint for a VPC endpoint service. ● receive: The connection is allowed. ● reject: The connection is rejected. |
endpoints |
Yes |
Array of strings |
Specifies VPC endpoint IDs. Each request accepts or rejects only one VPC endpoint. Array Length: 1 - 1 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
connections |
Array of ConnectionEndpoints objects |
Specifies the connection list. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the unique ID of the VPC endpoint. Minimum: 1 Maximum: 64 |
marker_id |
Integer |
Specifies the packet ID of the VPC endpoint. |
created_at |
String |
Specifies the creation time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ. |
updated_at |
String |
Specifies the update time of the VPC endpoint. The applied UTC time format is YYYY-MMDDTHH:MM:SSZ. |
domain_id |
String |
Domain ID of a user. Minimum: 1 Maximum: 64 |
error |
Array of QueryError objects |
Specifies the error message. This field is returned when the VPC endpoint is abnormal, that is, the value of status is failed. |
status |
String |
Specifies the connection status of the VPC endpoint. ● pendingAcceptance: The VPC endpoint connection is to be accepted. ● creating: The VPC endpoint connection is being created. ● accepted: The VPC endpoint connection has been accepted. ● rejected: The VPC endpoint connection has been rejected. ● failed: The VPC endpoint connection failed. ● deleting: The VPC endpoint connection is being deleted. |
description |
String |
Specifies the description of a VPC endpoint connection. Minimum: 0 Maximum: 512 |
Example Requests
Accepting a connection from a VPC endpoint
POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88/connections/action { "endpoints" : [ "705290f3-0d00-41f2-aedc-71f09844e879" ], "action" : "receive" }
Example Responses
Status code: 200
The server has successfully processed the request.
{ "connections" : [ { "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "status" : "accepted", "marker_id" : 422321321312321321, "domain_id" : "6e9dfd51d1124e8d8498dce894923a0d", "created_at" : "2022-04-14T09:35:47Z", "updated_at" : "2022-04-14T09:36:47Z" } ] }
SDK Sample Code
The SDK sample code is as follows.
Accepting a connection from a VPC endpoint
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 |
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 AcceptOrRejectEndpointSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); VpcepClient client = VpcepClient.newBuilder() .withCredential(auth) .withRegion(VpcepRegion.valueOf("<YOUR REGION>")) .build(); AcceptOrRejectEndpointRequest request = new AcceptOrRejectEndpointRequest(); AcceptOrRejectEndpointRequestBody body = new AcceptOrRejectEndpointRequestBody(); List<String> listbodyEndpoints = new ArrayList<>(); listbodyEndpoints.add("705290f3-0d00-41f2-aedc-71f09844e879"); body.withEndpoints(listbodyEndpoints); body.withAction(AcceptOrRejectEndpointRequestBody.ActionEnum.fromValue("receive")); request.withBody(body); try { AcceptOrRejectEndpointResponse response = client.acceptOrRejectEndpoint(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()); } } } |
Accepting a connection from a VPC endpoint
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = VpcepClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcepRegion.value_of("<YOUR REGION>")) \ .build() try: request = AcceptOrRejectEndpointRequest() listEndpointsbody = [ "705290f3-0d00-41f2-aedc-71f09844e879" ] request.body = AcceptOrRejectEndpointRequestBody( endpoints=listEndpointsbody, action="receive" ) response = client.accept_or_reject_endpoint(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Accepting a connection from a VPC endpoint
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := vpcep.NewVpcepClient( vpcep.VpcepClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AcceptOrRejectEndpointRequest{} var listEndpointsbody = []string{ "705290f3-0d00-41f2-aedc-71f09844e879", } request.Body = &model.AcceptOrRejectEndpointRequestBody{ Endpoints: listEndpointsbody, Action: model.GetAcceptOrRejectEndpointRequestBodyActionEnum().RECEIVE, } response, err := client.AcceptOrRejectEndpoint(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