Call the ListVpcEndpoints operation to view the status of the endpoints in the VPC of the service account.
Debugging
Request headers
This operation does not have operation-specific request headers and uses only common request headers. For more information, see the "Common request parameters" section of the Common parameters topic.
Syntax
GET /openapi/instances/{InstanceId}/vpc-endpoints HTTP/1.1
Request parameters
Element |
Type |
Position |
Required |
Example |
Description |
InstanceId | String | Path | Yes | es-cn-2r429tctl000d**** | The instance ID. |
size | Integer | Query | No | 10 | The number of entries to return on each page. Default value: 20. |
page | Integer | Query | No | 1 | The page number. Pages start from page 1. Default value: 1. |
Response parameters
Element |
Type |
Sample value |
Description |
RequestId | String | F99407AB-2FA9-489E-A259-40CF6DCC47D9 | The request ID. |
Result | Array of Result | The details of the endpoints. |
|
endpointBusinessStatus | String | Normal | The business status of the endpoint. Valid values:
|
serviceId | String | epsrv-bp1w0p3jdirbfmt6**** | The ID of the endpoint service with which the endpoint is associated. |
endpointName | String | test | The name of the endpoint. |
endpointId | String | ep-bp1tah7zbrwmkjef**** | The endpoint ID. |
serviceName | String | com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6**** | The name of the endpoint service that is associated with the endpoint. |
createTime | String | 2021-07-22T01:19:24Z | The time when the endpoint was created. |
connectionStatus | String | Disconnected | The status of the endpoint connection. Valid values:
|
endpointDomain | String | ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com | The domain name of the endpoint. The domain name is used for connection configuration. |
endpointStatus | String | Active | The status of the endpoint. Valid values:
|
Examples
Sample requests
GET /openapi/instances/es-cn-2r429tctl000d****/vpc-endpoints HTTP/1.1
Sample success responses
JSON format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : [ {
"endpointId" : "ep-bp18s6wy9420wdi4****",
"serviceId" : "epsrv-bp1bz3efowa4kc03****",
"zoneId" : "cn-hangzhou-i",
"securityGroupId" : "sg-bp1emvef6hl69pqs****",
"createTime" : "2021-07-22T01:19:24Z",
"endpointStatus" : "Active",
"endpointBusinessStatus" : "Normal",
"endpointDomain" : "ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com",
"connectionStatus" : "Disconnected",
"serviceName" : "com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1bz3efowa4kc03****"
}, {
"endpointId" : "ep-bp1tah7zbrwmkjef****",
"serviceId" : "epsrv-bp1w0p3jdirbfmt6****",
"zoneId" : "cn-hangzhou-i",
"securityGroupId" : "sg-bp1emvef6hl69pqs****",
"createTime" : "2021-07-22T01:12:28Z",
"endpointStatus" : "Active",
"endpointBusinessStatus" : "Normal",
"endpointDomain" : "ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com",
"connectionStatus" : "Connected",
"serviceName" : "com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****"
} ],
"RequestId" : "AD080217-B2C1-4F36-904F-BE4E4A0B4536"
}
Error codes
For a list of error codes, see Service error codes.