This API is used to query basic information about a target VPC endpoint service. You can use this API to query the target VPC endpoint service to be accessed. This API can also be used by other users to query basic information about your VPC endpoint service, without exposing your server information.
GET /v1/{project_id}/vpc-endpoint-services/describe?endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}
Parameter |
Mandatory |
Description |
|---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
endpoint_service_name |
No NOTE:
Either this parameter or the id parameter must be selected. |
String |
Specifies the name of the VPC endpoint service. |
id |
No NOTE:
Either this parameter or the endpoint_service_name parameter must be selected. |
String |
Specifies the unique ID of the VPC endpoint service. |
Parameter |
Type |
Description |
|---|---|---|
id |
String |
Specifies the unique ID of the VPC endpoint service. |
service_name |
String |
Specifies the name of the VPC endpoint service. |
service_type |
String |
Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.
You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types. |
created_at |
String |
Specifies the creation time of the VPC endpoint service. The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ. |
is_charge |
Boolean |
Specifies whether the associated VPC endpoint carries a charge.
|
{
"id": "9d4c1028-1336-4556-9881-b5d807c1b8a8",
"service_name": "test123",
"service_type": "interface",
"created_at": "2018-09-17T07:28:31Z",
"is_charge": "true"
}
See Status Codes.