You need to enable JavaScript to run this app.
导航
DescribeVpcEndpointServiceAttributes
最近更新时间:2024.07.26 10:24:05首次发布时间:2023.03.17 21:09:36

调用DescribeVpcEndpointServiceAttributes接口,查询终端节点服务的详细信息。

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeVpcEndpointServiceAttributes要执行的操作,取值为DescribeVpcEndpointServiceAttributes。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。
ServiceIdStringepsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
ServiceIdStringepsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。
ServiceNameStringcom.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****终端节点服务的名称。
ServiceDomainStringepsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com终端节点服务的服务域名。

AutoAcceptEnabled

Boolean

false

是否自动接受终端节点连接。

  • true:终端节点服务自动接受终端节点连接。
  • false:终端节点服务不会自动接受终端节点连接,需要调用EnableVpcEndpointConnection接口手动接受。

ServiceType

String

Interface

终端节点服务的类型。

  • Interface:接口终端节点服务。

Payer

String

Endpoint

私网连接的付费账号。

  • Endpoint:终端节点账号。
  • EndpointService:终端节点服务账号。

BillingType

Integer

0

终端节点服务的计费类型。

  • 0:不计费。
  • 3:按量计费。

BusinessStatus

String

Normal

终端节点服务是否被锁定。

  • Normal:正常。
  • FinancialLocked:被锁定。

说明

该参数返回为空时,表示终端节点服务未锁定。

IpAddressVersions

List of String

["ipv4", "ipv6"]

终端节点服务的IP协议类型。

  • 返回值中仅包含“ipv4”时,说明该终端节点服务为IPv4类型,仅支持提供IPv4服务。
  • 返回值中同时包含“ipv4”和“ipv6”时,说明该终端节点服务为双栈类型,支持同时提供IPv4和IPv6服务。

ServiceResourceType

String

CLB

服务资源的类型。

  • CLB:负载均衡CLB。
  • RDSMySQL:云数据库 MySQL版。

ZoneIds

List of String

["cn-guangzhou-a", "cn-guangzhou-b"]

终端节点服务提供服务的可用区。

说明

参数ServiceResourceType返回值为“RDSMySQL”时,该参数返回空值。

DescriptionStringendpoint service终端节点服务的描述信息。

PrivateDNSEnabled

Boolean

false

终端节点服务是否启用私有DNS名称。

  • false:未启用。
  • true:已启用。

PrivateDNSType

String

public

私有DNS名称的域名类型。

  • public:公网。
  • private:私网。

说明

未开通自定义私网域名功能时,不返回该参数。

PrivateDNSName

String

www.example.com

终端节点服务的私有DNS名称。
参数PrivateDNSEnabled返回值为“false”时,该参数返回空。

PrivateDNSNameConfiguration

Array of Struct

--

终端节点服务私有DNS名称的配置信息。具体请参见下表“PrivateDNSNameConfiguration”。

说明

PrivateDNSType为“private”时,不返回该参数。

CreationTimeString2021-07-20T03:32:32+08:00终端节点服务的创建时间。
UpdateTimeString2021-07-20T03:32:32+08:00终端节点服务的最近操作时间。

Status

String

Available

终端节点服务的状态。

  • Creating:创建中。
  • Pending:配置修改中。
  • Available:可用。
  • Deleting:删除中。
  • Inactive:不可用。
ProjectNameStringdefault终端节点所属项目的名称。
TagsArray of Struct--终端节点服务的标签信息。具体请参见下表“Tags”。

Tags

名称类型示例值描述
KeyStringk1终端节点服务标签的标签键。
ValueStringv1终端节点服务标签的标签值。

PrivateDNSNameConfiguration

名称类型示例值描述
NameString_2fe6iz2tou9s059gp68um****域验证名称。

Status

String

PendingVerification

域验证状态。

  • PendingVerification:待验证
  • Verifying:验证中
  • Verified:验证通过
  • Failed:验证失败

Type

String

TXT

域验证类型。

  • TXT:TXT记录。
ValueStringepsvc:2fe6iz4spybr459gp67fb****域验证值。

请求示例

GET /?Action=DescribeVpcEndpointServiceAttributes&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": "DescribeVpcEndpointServiceAttributes",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",
        "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****",
        "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com",
        "AutoAcceptEnabled": false,
        "ServiceType": "Interface",
        "IpAddressVersions": [
            "ipv4",
            "ipv6"
        ],
        "ServiceResourceType": "CLB",
        "Payer": "Endpoint",
        "BillingType": 0,
        "BusinessStatus": "Normal",
        "ZoneIds": [
            "cn-guangzhou-a",
            "cn-guangzhou-b"
        ],
        "Description": "",
        "PrivateDNSEnabled": true,
        "PrivateDNSName": "www.example.com",
        "PrivateDNSNameConfiguration": [
            {
                "Name": "_2fe6iz2tou9s059gp68um****",
                "Status": "Verified",
                "Type": "TXT",
                "Value": "epsvc:2fe6iz4spybr459gp67fb****"
            }
        ],
        "CreationTime": "2021-07-20T03:32:32+08:00",
        "UpdateTime": "2021-07-20T03:32:32+08:00",
        "Status": "Available", 
        "ProjectName": "default",
        "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表示缺少的参数名称。

404InvalidEndpointService.NotFoundThe specified EndpointService does not exist.指定的终端节点服务不存在。