DescribeVpcGatewayEndpointServices--私网连接-火山引擎

文档中心

立即注册

导航

DescribeVpcGatewayEndpointServices

最近更新时间：2024.11.08 16:30:40首次发布时间：2023.07.07 09:56:29

调用DescribeVpcGatewayEndpointServices接口，查询满足指定条件的网关终端节点服务列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcGatewayEndpointServices	要执行的操作，取值为DescribeVpcGatewayEndpointServices。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数。最大值为100，默认值为10。
ProjectName	String	否	default	网关终端节点服务所属项目的名称。

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	2	符合条件的网关终端节点服务总数。
VpcGatewayEndpointServices	Array of Struct	-	网关终端节点服务的详细信息。具体请参见下表“VpcGatewayEndpointServices”。

VpcGatewayEndpointServices

名称	类型	示例值	说明
ServiceId	String	gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的ID。
ServiceName	String	com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的名称。
Description	String	endpoint service	网关终端节点服务的描述信息。
CreationTime	String	2021-07-20T03:32:32+08:00	网关终端节点服务的创建时间。
UpdateTime	String	2021-07-20T03:32:32+08:00	网关终端节点服务的最近操作时间。
Status	String	Available	网关终端节点服务的状态。 Creating：创建中。 Pending：配置修改中。 Available：可用。 Deleting：删除中。

请求示例

GET /?Action=DescribeVpcGatewayEndpointServices&Version=2020-04-01&ProjectName=default HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcGatewayEndpointServices",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 2,  
        "VpcGatewayEndpointServices": [
            {
                "ServiceId": "gwepsvc-2fe630gurkl37k5gfuy33****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****",
                "Description": "",
                "CreationTime": "2021-07-20T03:32:32+08:00",
                "UpdateTime": "2021-07-20T03:32:32+08:00",
                "Status": "Available"
            },
            {
                "ServiceId": "gwepsvc-2fe630gurkl58k5gfuy26****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl58k5gfuy26****",
                "Description": "",
                "CreationTime": "2021-10-20T03:32:32+08:00",
                "UpdateTime": "2021-10-20T03:32:32+08:00",
                "Status": "Available"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidName.Malformed	The specified Name is malformed.	指定的Name参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。