- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
-
VPC Endpoint Services
- VPC Endpoint Service Overview
- Creating a VPC Endpoint Service
- Viewing a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Managing Connections of a VPC Endpoint Service
- Managing Whitelist Records of a VPC Endpoint Service
- Managing Port Mappings of a VPC Endpoint Service
- Managing Tags of a VPC Endpoint Service
- VPC Endpoints
- Accessing OBS
- Using Cloud Eye to Monitor VPC Endpoints
- Using CTS to Audit VPC Endpoints
- Permissions Management
- Quotas
-
VPC Endpoint Services
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Version Management
-
VPC Endpoint Services
- Creating a VPC Endpoint Service
- Querying VPC Endpoint Services
- Querying Details of a VPC Endpoint Service
- Modifying a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Querying Connections to a VPC Endpoint Service
- Accepting or Rejecting a VPC Endpoint
- Querying Whitelist Records of a VPC Endpoint Service
- Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service
- Querying Public VPC Endpoint Services
- Querying Basic Information About a VPC Endpoint Service
- Changing the Name of a VPC Endpoint Service
- Updating Descriptions of VPC Endpoint Connections
- Batch Adding Whitelist Records of a VPC Endpoint Service
- Batch Deleting Whitelist Records of a VPC Endpoint Service
- Updating the Description of a Whitelist Record of a VPC Endpoint Service
- VPC Endpoints
- Resource Quotas
- Tags
- Application Examples
- Appendix
- SDK Reference
- FAQs
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
-
VPC Endpoint Services
- VPC Endpoint Service Overview
- Creating a VPC Endpoint Service
- Viewing Summary of a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Managing Connections of a VPC Endpoint Service
- Managing Whitelist Records of a VPC Endpoint Service
- Viewing Port Mappings of a VPC Endpoint Service
- Managing Tags of a VPC Endpoint Service
- VPC Endpoints
- Permission Management
- FAQs
- Change History
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
- Version Management
-
APIs for Managing VPC Endpoint Services
- Creating a VPC Endpoint Service
- Querying Details of a VPC Endpoint Service
- Modifying a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Querying VPC Endpoint Services
- Querying Connections of a VPC Endpoint Service
- Accepting or Rejecting a VPC Endpoint
- Querying the Whitelist Records of a VPC Endpoint Service
- Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service
- APIs for Managing VPC Endpoints
- Resource Quota
- Tag Function
- Application Examples
- Appendix
- Change History
-
User Guide (Paris Region)
- Service Overview
-
Getting Started
- Operation Guide
- Configuring a VPC Endpoint for Communications Across VPCs of the Same Domain
- Configuring a VPC Endpoint for Communications Across VPCs of Different Domains
- Configuring a VPC Endpoint for Accessing the Private IP Address of OBS over Private Networks
- Configuring a VPC Endpoint for Accessing the Public IP Address of OBS over Public Networks
-
VPC Endpoint Services
- VPC Endpoint Service Overview
- Creating a VPC Endpoint Service
- Viewing the Summary of a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Managing Connections of a VPC Endpoint Service
- Managing Whitelist Records of a VPC Endpoint Service
- Viewing Port Mappings of a VPC Endpoint Service
- Managing Tags of a VPC Endpoint Service
- VPC Endpoints
- Permissions Management
- Quotas
- FAQ
- Change History
-
API Reference (Paris Region)
- Before You Start
- API Overview
- Calling APIs
-
APIs
- Version Management
-
APIs for Managing VPC Endpoint Services
- Creating a VPC Endpoint Service
- Querying Details About a VPC Endpoint Service
- Modifying a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Querying VPC Endpoint Services
- Querying Connections of a VPC Endpoint Service
- Accepting or Rejecting a VPC Endpoint
- Querying Whitelist Records of a VPC Endpoint Service
- Batch Adding or Deleting Whitelist Records
- Querying Public VPC Endpoint Services
- Querying Basic Information About a VPC Endpoint Service
- APIs for Managing VPC Endpoints
- Resource Quota
- Tag Function
- Application Examples
- Appendix
- Change History
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Getting Started
-
VPC Endpoint Services
- VPC Endpoint Service Overview
- Creating a VPC Endpoint Service
- Viewing the Summary of a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Managing Connections of a VPC Endpoint Service
- Managing Whitelist Records of a VPC Endpoint Service
- Viewing Port Mappings of a VPC Endpoint Service
- Managing Tags of a VPC Endpoint Service
- VPC Endpoints
- Quotas
- FAQ
- Change History
-
API Reference (Kuala Lumpur Region)
- Before You Start
- API Overview
- Calling APIs
-
APIs
- Version Management
-
APIs for Managing VPC Endpoint Services
- Creating a VPC Endpoint Service
- Querying Details of a VPC Endpoint Service
- Modifying a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Querying VPC Endpoint Services
- Querying Connections of a VPC Endpoint Service
- Accepting or Rejecting a VPC Endpoint
- Querying the Whitelist Records of a VPC Endpoint Service
- Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service
- APIs for Managing VPC Endpoints
- Resource Quota
- Tag Function
- Application Examples
- Appendix
- Change History
- User Guide (Ankara Region)
-
API Reference (Ankara Region)
- Before You Start
- API Overview
- Calling APIs
-
APIs
- Version Management
-
APIs for Managing VPC Endpoint Services
- Creating a VPC Endpoint Service
- Querying Details About a VPC Endpoint Service
- Modifying a VPC Endpoint Service
- Deleting a VPC Endpoint Service
- Querying VPC Endpoint Services
- Querying Connections of a VPC Endpoint Service
- Accepting or Rejecting a VPC Endpoint
- Querying Whitelist Records of a VPC Endpoint Service
- Batch Adding or Deleting Whitelist Records
- Querying Public VPC Endpoint Services
- Querying Basic Information About a VPC Endpoint Service
- APIs for Managing VPC Endpoints
- Resource Quota
- Application Examples
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Querying Basic Information About a VPC Endpoint Service
Function
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.
URI
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 Either this parameter or the id parameter must be selected. |
String |
Specifies the name of the VPC endpoint service. |
id |
No Either this parameter or the endpoint_service_name parameter must be selected. |
String |
Specifies the unique ID of the VPC endpoint service. |
Request
Response
- Parameter description
Table 3 Response parameters 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.
- Gateway: VPC endpoint services of this type are configured by O&M personnel. You can use them directly without the need to create one by yourselves.
- Interface: VPC endpoint services of this type include cloud services configured by O&M personnel and private services created by yourselves. You cannot configure these cloud services, but can use them.
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.
- true: indicates that the associated VPC endpoint carries a charge.
- false: indicates that the associated VPC endpoint does not a charge.
- Example response
{ "id": "9d4c1028-1336-4556-9881-b5d807c1b8a8", "service_name": "test123", "service_type": "interface", "created_at": "2018-09-17T07:28:31Z", "is_charge": "true" }
Status Codes
See Status 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