Obtaining an Endpoint Connection
Function
The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. The VPC endpoint address can be an IPv4 address (automatically allocated when the VPC endpoint service is enabled), an IPv6 address (allocated when a professional VPC endpoint is created and dual-stack networking is enabled), or an internal domain name (allocated when DNS is enabled). This API is used to obtain the VPCEP connection of a cluster.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A |
cluster_id |
Yes |
String |
Definition: ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Definition: Start value for querying VPC endpoint connections. Constraints: N/A Value range: 0-1000 Default value: 0 |
limit |
No |
Integer |
Definition: The number of VPC endpoint connections to be queried. Constraints: N/A Value range: 1-1000 Default value: The default value is 10, indicating that 10 tasks are queried at a time. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
connections |
Array of connections objects |
Definition: Cluster VPC endpoint connection information. Value range: N/A |
vpcServiceName |
String |
Definition: Name of the VPC endpoint service. Value range: N/A |
permissions |
Array of permissions objects |
Definition: Permissions of the cluster VPC endpoint whitelist. Value range: N/A |
vpcepUpdateSwitch |
Boolean |
Definition: Whether to enable VPC endpoint. Value range:
|
total_count |
Integer |
Definition: Number of cluster VPC endpoints. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Cluster VPC endpoint ID. Value range: N/A |
status |
String |
Definition: Cluster VPC endpoint status. Value range:
|
maxSession |
String |
Definition: Maximum number of connections to a VPC endpoint. Value range: N/A |
specificationName |
String |
Definition: Cluster VPC endpoint name. Value range: N/A |
created_at |
String |
Definition: Creation time. Value range The format is CCYY-MM-DDThh:mm:ss (ISO 8601). |
update_at |
String |
Definition: Update time. The default value is null. Value range The format is CCYY-MM-DDThh:mm:ss (ISO 8601). |
domain_id |
String |
Definition: Account ID of the owner. Value range: N/A |
vpcepIp |
String |
Definition: IPv4 address of a cluster VPC endpoint. Value range: N/A |
vpcepIpv6Address |
String |
Definition: IPv6 address of a cluster VPC endpoint. Value range: N/A |
vpcepDnsName |
String |
Definition: Private domain name of a cluster VPC endpoint. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Unique ID of the permission. Value range: N/A |
permission |
String |
Definition: Permission details for the VPCEP connection whitelist. Value range: N/A |
permission_type |
String |
Definition: VPC endpoint permission type. Value range: domainId: user account ID. |
created_at |
String |
Definition: Specifies when the VPC endpoint was created. Value range: The format is CCYY-MM-DDThh:mm:ss (ISO 8601). |
Example Requests
Obtain the VPCEP connection of a cluster.
GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/vpcepservice/connections
Example Responses
Status code: 200
Request succeeded.
{ "connections" : [ { "id" : "54b7f739-31a1-40d0-862b-ac85b83ab2da", "status" : "accepted", "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.122", "created_at" : "2024-06-11T09:36:24Z", "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c" }, { "id" : "e88ad0bc-c2c7-419c-bd9b-a961111f0a42", "status" : "accepted", "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.133", "created_at" : "2023-10-12T07:33:16Z", "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c" } ], "vpcepUpdateSwitch" : false, "total_count" : 2, "vpcServiceName" : "cn-north-4.css-op-no-delete.cf072729-b076-49db-83d3-020dc9f589bd", "permissions" : [ { "id" : "432a6429-f377-4168-8b24-feb5885af08c", "permission" : "iam:domain::db9b76a0d9ae431f8e85e89da2ca867c", "permission_type" : "domainId", "created_at" : "2023-10-12T07:33:11Z" } ] }
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class ShowVpcepConnectionSolution { 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); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); ShowVpcepConnectionRequest request = new ShowVpcepConnectionRequest(); request.withClusterId("{cluster_id}"); try { ShowVpcepConnectionResponse response = client.showVpcepConnection(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()); } } } |
Python
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.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 = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowVpcepConnectionRequest() request.cluster_id = "{cluster_id}" response = client.show_vpcep_connection(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/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 := css.NewCssClient( css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowVpcepConnectionRequest{} request.ClusterId = "{cluster_id}" response, err := client.ShowVpcepConnection(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
Request succeeded. |
400 |
Invalid request. Modify the request before retry. |
409 |
The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict. |
412 |
The server did not meet one of the preconditions contained in 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