最近更新时间:2024.04.23 17:45:10
首次发布时间:2023.07.07 09:56:29
调用DescribeVpcEndpointServicesByEndUser接口,查询当前账号下满足指定条件的终端节点服务列表。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVpcEndpointServicesByEndUser | 要执行的操作,取值为DescribeVpcEndpointServicesByEndUser。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为2020-04-01。 |
PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页的行数。最大值为100,默认值为10。 |
ServiceName | String | 否 | com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33**** | 终端节点服务的名称。格式为:com.volces.privatelink.<地域ID>.<终端节点服务ID>。 |
ServiceId | String | 否 | epsvc-2fe630gurkl37k5gfuy33**** | 终端节点服务的ID。您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 0ED8D006-F706-4D23-88ED-E11ED28D**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的终端节点服务总数。 |
PageNumber | Integer | 1 | 当前页码。 |
PageSize | Integer | 10 | 当前分页的行数。 |
VpcEndpointServices | Array of Struct | - | 终端节点服务的详细信息。具体请参见下表“VpcEndpointServices”。 |
VpcEndpointServices
名称 | 类型 | 示例值 | 说明 |
---|---|---|---|
ServiceId | String | epsvc-2fe630gurkl37k5gfuy33**** | 终端节点服务的ID。 |
ServiceName | String | com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33**** | 终端节点服务的名称。 |
ServiceDomain | String | epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com | 终端节点服务的服务域名。 |
ServiceType | String | Interface | 终端节点服务的类型。
|
ServiceResourceType | String | CLB | 服务资源的类型。
|
ZoneIds | List of String | ["cn-guangzhou-a", "cn-guangzhou-b"] | 服务资源所属的可用区。 说明 RDS类型的服务资源,该参数返回空值。 |
Description | String | endpoint service | 终端节点服务的描述信息。 |
ProjectName | String | default | 终端节点所属项目的名称。 |
Tags | Array of Struct | - | 终端节点的标签信息。具体请参见下表“Tags”。 |
Tags
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | k1 | 终端节点标签的标签键。 |
Value | String | v1 | 终端节点标签的标签值。 |
GET /?Action=DescribeVpcEndpointServicesByEndUser&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Service: privatelink Region: cn-guangzhou
{ "ResponseMetadata": { "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****", "Action": "DescribeVpcEndpointServicesByEndUser", "Version": "2020-04-01", "Service": "privatelink", "Region": "cn-guangzhou" }, "Result": { "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****", "PageNumber": 1, "PageSize": 10, "TotalCount": 2, "VpcEndpointServices": [ { "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****", "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****", "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com", "ServiceType": "Interface", "ServiceResourceType": "CLB", "ZoneIds": [ "cn-guangzhou-a", "cn-guangzhou-b" ], "Description": "", "ProjectName": "default", "Tags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "v2" } ] }, { "ServiceId": "epsvc-2fe630gurkl58k5gfuy26****", "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl58k5gfuy26****", "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com", "ServiceType": "Interface", "ServiceResourceType": "CLB", "ZoneIds": [ "cn-guangzhou-c" ], "Description": "", "ProjectName": "default", "Tags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "v2" } ] } ] } }
此处仅展示当前API的错误码,更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
400 | InvalidName.Malformed | The specified Name is malformed. | 指定的参数Name格式不合法。 |