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

文档中心

立即注册

导航

DescribeVpcEndpointServicePermissions

最近更新时间：2024.04.22 16:36:16首次发布时间：2023.03.17 21:09:37

调用DescribeVpcEndpointServicePermissions接口，查询指定终端节点服务已授权的白名单账号。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcEndpointServicePermissions	要执行的操作，取值为DescribeVpcEndpointServicePermissions。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ServiceId	String	是	epsvc-2fe630gurkl37k5gfuy33****	终端节点服务的ID。您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。
PermitAccountId	String	否	2100000000	服务白名单的账号ID。您可以调用本接口查询终端节点所属账号的ID。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数。最大值为100，默认值为10。

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	2	符合条件的已授权白名单账号总数。
Permissions	Array of Struct	-	已授权白名单账号的详细信息。具体请参见下表“Permissions”。

Permissions

名称	类型	示例值	描述
PermitAccountId	String	2100000000	已授权的白名单账号ID。

请求示例

GET /?Action=DescribeVpcEndpointServicePermissions&Version=2020-04-01&ServiceId=epsvc-2fe630gurkl37k5gfuy33**** HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointServicePermissions",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 2,
        "Permissions": [
            {
                "PermitAccountId": "2100000000"
            },
            {
                "PermitAccountId": "2100000001"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。说明其中，XXX表示缺少的参数名称。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
404	InvalidEndpointService.NotFound	The specified EndpointService does not exist.	指定的终端节点服务不存在。