查询终端节点列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
privatelink:ListVpcEndpoints | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 要查询的终端节点所属的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 | cn-huhehaote |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| caeba0bbb2be03f84eb48b699f0a4883 |
MaxResults | integer | 否 | 分页大小。取值范围:1~50。默认值:50。 | 50 |
EndpointId | string | 否 | 要查询的终端节点ID。 | ep-hp33b2e43fays7s8**** |
ServiceName | string | 否 | 要查询的终端节点关联的终端节点服务名称。 | com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i**** |
VpcId | string | 否 | 终端节点所属的专有网络。 | vpc-fdjkf789dfdfdfde**** |
EndpointName | string | 否 | 终端节点名称。 | test |
EndpointType | string | 否 | 终端节点类型。 仅取值: Interface,表示接口终端节点,您可以添加应用型负载均衡ALB(Application Load Balancer)、传统型负载均衡CLB(Classic Load Balancer)和网络型负载均衡NLB(Network Load Balancer )的服务资源类型。 | Interface |
EndpointStatus | string | 否 | 终端节点状态,取值:
| Active |
ConnectionStatus | string | 否 | 终端节点连接状态,取值:
| Disconnected |
Tag | object [] | 否 | 标签列表。 | |
Key | string | 否 | 实例的标签键。最多支持20个标签键。一旦传入该值,则不允许为空字符串。 最多支持64个字符,不能以 | FinanceDept |
Value | string | 否 | 实例的标签值。最多支持20个标签值。一旦传入该值,可以为空字符串。 最多支持128个字符,不能以 | FinanceJoshua |
ResourceGroupId | string | 否 | 资源实例组ID。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"Endpoints": [
{
"VpcId": "vpc-hp356stwkxg3fn2xe****",
"EndpointName": "test",
"EndpointType": "Interface",
"CreateTime": "2021-09-24T18:00:07Z",
"ServiceId": "epsrv-hp3vpx8yqxblby3i****",
"ZoneAffinityEnabled": true,
"EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
"EndpointStatus": "Active",
"RegionId": "cn-huhehaote",
"ResourceOwner": true,
"Bandwidth": 1024,
"ConnectionStatus": "Disconnected",
"EndpointDescription": "This is my Endpoint.",
"EndpointId": "ep-hp33b2e43fays7s8****",
"EndpointBusinessStatus": "Normal",
"ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
],
"ResourceGroupId": "1",
"PolicyDocument": ""
}
],
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
"MaxResults": 50,
"TotalCount": 12
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-19 | OpenAPI 入参发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-09-05 | OpenAPI 入参发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-03-02 | OpenAPI 描述信息更新,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-07-26 | OpenAPI 入参发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2021-03-17 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|