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

文档中心

立即注册

导航

DescribeVpcGatewayEndpointAttributes

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

调用DescribeVpcGatewayEndpointAttributes接口，查询满足指定条件的网关终端节点的详细信息。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcGatewayEndpointAttributes	要执行的操作，取值为DescribeVpcGatewayEndpointAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
EndpointId	String	是	gwep-273yuq6q7bgn47fap8squ****	网关终端节点的ID。您可以调用DescribeVpcGatewayEndpoints接口获取网关终端节点的ID。

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
EndpointId	String	gwep-273yuq6q7bgn47fap8squ****	网关终端节点的ID。
EndpointName	String	endpoint-01	网关终端节点的名称。
Status	String	Available	网关终端节点的状态。 Creating：创建中。 Pending：配置修改中。 Available：可用。 Deleting：删除中。
Description	String	endpoint service	网关终端节点的描述信息。
ServiceId	String	gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的ID。
ServiceName	String	com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的名称。
VpcId	String	vpc-bp15zkdt37pq72zv****	网关终端节点所属VPC的ID。
CreationTime	String	2021-07-20T03:32:32+08:00	网关终端节点的创建时间。
UpdateTime	String	2021-07-20T03:32:32+08:00	网关终端节点的最近操作时间。
ProjectName	String	default	网关终端节点所属项目的名称。
VpcPolicy	String	{ "Statement": [ { "Effect": "Allow", "Principal": "", "Action": "", "Resource": "*" } ] }	网关终端节点的访问策略。访问策略中各字段的详细说明请参见存储桶策略参数说明。
Tags	Array of Struct	-	终端节点的标签信息。具体请参见下表“Tags”。

Tags

名称	类型	示例值	描述
Key	String	k1	终端节点标签的标签键。
Value	String	v1	终端节点标签的标签值。

请求示例

GET /?Action=DescribeVpcGatewayEndpointAttributes&Version=2020-04-01&EndpointId=gwep-273yuq6q7bgn47fap8squ**** HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcGatewayEndpointAttributes",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "EndpointId": "gwep-273yuq6q7bgn47fap8squ****",
        "EndpointName": "endpoint-01",
        "Status": "Available",
        "Description": "This is used for test.",
        "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",
        "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****",
        "VpcId": "vpc-bp15zkdt37pq72zv****",
        "CreationTime": "2021-07-20T03:32:32+08:00",
        "UpdateTime": "2021-07-20T03:32:32+08:00",
        "ProjectName": "default",
        "VpcPolicy": {
            "Statement": [
                {
                    "Effect": "Allow",
                    "Principal": "*",
                    "Action": "*",
                    "Resource": "*"
                }
            ]
        },
        "Tags": [
            {
                "Key": "k1",
                "Value": "v1"
            },
            {
                "Key": "k2",
                "Value": "v2"
            }
        ]
    }
}

错误码

此处仅展示当前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表示缺少的参数名称。
404	InvalidGatewayEp.NotFound	The specified GatewayEndpoint does not exist.	指定的网关终端节点不存在。