Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ VPC Endpoint/ API Reference/ APIs/ APIs for Managing VPC Endpoint Services/ Querying Connections of a VPC Endpoint Service

Querying Connections of a VPC Endpoint Service

Updated on 2022-12-06 GMT+08:00

Function

This API is used to query connections of a VPC endpoint service. The marker ID is the unique ID of each connection.

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections?id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}

Table 1 describes the required parameters.
Table 1 Parameters

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

vpc_endpoint_service_id

Yes

Specifies the ID of the VPC endpoint service.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

id

No

String

Specifies the unique ID of the VPC endpoint.

marker_id

No

String

Specifies the packet ID of the VPC endpoint.

status

No

String

Specifies the connection status of the VPC endpoint.

  • pendingAcceptance: The VPC endpoint is pending acceptance.
  • accepted: The VPC endpoint has been accepted.
  • rejected: The VPC endpoint has been rejected.
  • failed: The VPC endpoint service failed to be created.

sort_key

No

String

Specifies the sorting field of the VPC endpoint list, which can be:

  • created_at: VPC endpoints are sorted by creation time.
  • updated_at: VPC endpoints are sorted by update time.

The default field is created_at.

sort_dir

No

String

Specifies the sorting method of the VPC endpoint list, which can be:

  • desc: indicates that VPC endpoints are sorted in the descending order.
  • asc: indicates that VPC endpoints are sorted in ascending order.

The default method is desc.

limit

No

Integer

Specifies the maximum number of connections displayed on each page.

The number ranges from 0 to 1000 and is generally 10, 20, or 50. The default value is 10.

offset

No

Integer

Specifies the offset.

All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

Request

  • Parameter description

    None

  • Example request
    This request is to query connections of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections

Response

  • Parameter description
    Table 3 Response parameters

    Parameter

    Type

    Description

    connections

    Array of objects

    Lists the connections. For details, see Table 4.

    total_count

    Integer

    Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by the limit or offset.

    Table 4 Connection parameters

    Parameter

    Type

    Description

    id

    String

    Specifies the unique ID of the VPC endpoint.

    marker_id

    Integer

    Specifies the packet ID of the VPC endpoint.

    created_at

    String

    Specifies the creation time of the VPC endpoint.

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    updated_at

    String

    Specifies the update time of the VPC endpoint.

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    domain_id

    String

    Specifies the user's domain ID.

    status

    String

    Specifies the connection status of the VPC endpoint.

    • pendingAcceptance: The VPC endpoint is pending acceptance.
    • creating: The VPC endpoint is being created.
    • accepted: The VPC endpoint has been accepted.
    • rejected: The VPC endpoint has been rejected.
    • failed: The VPC endpoint service failed to be created.
    • deleting: The VPC endpoint is being deleted.

    error

    Array of objects

    Specifies the error message.

    This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 5.

    Table 5 Error parameters

    Parameter

    Type

    Description

    error_code

    String

    Specifies the error code.

    error_message

    String

    Specifies the error message.

  • Example response
    {
      "connections": [
        {
          "id": "adb7b229-bb11-4072-bcc0-3327cd784263",
          "status": "accepted",
          "marker_id": 16777510,
          "domain_id": "5fc973eea581490997e82ea11a1df31f",
          "created_at": "2018-09-17T11:10:11Z",
          "updated_at": "2018-09-17T11:10:12Z"
        },
        {
          "id": "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea",
          "status": "accepted",
          "marker_id": 16777513,
          "domain_id": "5fc973eea581490997e82ea11a1df31f",
          "created_at": "2018-09-17T07:28:56Z",
          "updated_at": "2018-09-17T07:28:58Z"
        }
      ],
      "total_count":2
    }

Status Code

For details about status codes, see Status Code.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback