获取终端节点连接
功能介绍
该接口用于获取集群的终端节点连接。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 获取方法请参见获取项目ID和名称。 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 指定待查询的集群ID。 约束限制: 不涉及 取值范围: 获取方法请参见获取集群ID。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start |
否 |
Integer |
参数解释: 指定查询起始值,默认值为1,即从第1个任务开始查询。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 1 |
limit |
否 |
Integer |
参数解释: 指定查询个数,默认值为10,即一次查询10个任务信息。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 10 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
connections |
Array of connections objects |
参数解释: 连接信息 |
vpcServiceName |
String |
参数解释: 终端节点服务名称 |
permissions |
Array of permissions objects |
参数解释: 终端节点连接白名单列表权限列表。 |
vpcepUpdateSwitch |
Boolean |
参数解释: 终端节点更新开关。 取值范围:
|
total_count |
Integer |
参数解释: 终端节点数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 终端节点ID。 |
status |
String |
参数解释: 终端节点状态。 取值范围:
|
maxSession |
String |
参数解释: 最大连接数。 |
specificationName |
String |
参数解释: 终端节点名称。 |
created_at |
String |
参数解释: 创建时间,格式为ISO8601:CCYY-MM-DDThh:mm:ss。 |
update_at |
String |
参数解释: 更新时间。默认为null。 |
domain_id |
String |
参数解释: 拥有者的账号ID。 |
vpcepIp |
String |
参数解释: 终端节点IPv4。 |
vpcepIpv6Address |
String |
参数解释: 终端节点IPv6。 |
vpcepDnsName |
String |
参数解释: 终端节点内网域名。 |
请求示例
获取集群的终端节点连接。
GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
响应示例
状态码: 200
请求已成功。
{ "connections" : [ { "id" : "54b7f739-31a1-40d0-862b-ac85b83ab2da", "status" : "accepted", "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.122", "vpcepIpv6Address" : null, "vpcepDnsName" : null, "created_at" : "2024-06-11T09:36:24Z", "update_at" : null, "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c" }, { "id" : "e88ad0bc-c2c7-419c-bd9b-a961111f0a42", "status" : "accepted", "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.133", "vpcepIpv6Address" : null, "vpcepDnsName" : null, "created_at" : "2023-10-12T07:33:16Z", "update_at" : null, "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代码示例
SDK代码示例如下。
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()); } } } |
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) |
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功。 |
400 |
非法请求。 建议直接修改该请求,不要重试该请求。 |
409 |
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
412 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。