Obtaining an Endpoint Connection¶
Function¶
This API is used to obtain the VPCEP connection of a cluster.
URI¶
GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Parameter description: The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Default value: N/A |
cluster_id | Yes | String | Parameter description: ID of the cluster you want to query. Constraints: N/A Options: For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Default value: N/A |
Parameter | Mandatory | Type | Description |
---|---|---|---|
start | No | Integer | Parameter description: The start value of the query. The default value is 1, indicating that the query starts from the first task. Constraints: N/A Options: 1-1000 Default value: 1 |
limit | No | Integer | Parameter description: Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time. Constraints: N/A Options: 1-1000 Default value: 10 |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
connections | Array of connections objects | Parameter description: Connection information |
vpcServiceName | String | Parameter description: Endpoint service name. |
permissions | Array of permissions objects | Parameter description: Permissions list for the VPCEP connection whitelist. |
vpcepUpdateSwitch | Boolean | Parameter description: Whether to update endpoints. Options:
|
total_count | Integer | Parameter description: Number of endpoints. |
Parameter | Type | Description |
---|---|---|
id | String | Parameter description: VPC endpoint ID. |
status | String | Parameter description: Endpoint status. Options:
|
maxSession | String | Parameter description: Maximum number of connections. |
specificationName | String | Parameter description: Endpoint name. |
created_at | String | Parameter description: Creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss. |
update_at | String | Parameter description: Update time. The default value is null. |
domain_id | String | Parameter description: Account ID of the owner. |
vpcepIp | String | Parameter description: IPv4 address of the VPC endpoint. |
vpcepIpv6Address | String | Parameter description: IPv6 address of the VPC endpoint. |
vpcepDnsName | String | Parameter description: Private domain name for accessing the VPC endpoint. |
Parameter | Type | Description |
---|---|---|
id | String | Parameter description: ID. |
permission | String | Parameter description: Permission details for the VPCEP connection whitelist. |
permission_type | String | Parameter description: Permission type |
created_at | String | Parameter description: Creation time. |
Example Requests¶
Obtain the VPCEP connection of a cluster.
GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/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",
"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"
} ]
}
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.