文档

ListEndpoints - 获取数据集加速端点列表

更新时间:

获取数据集加速槽挂载点的信息列表。

接口说明

请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
datasetacc:ListEndpointsRead
  • 全部资源
    acs:datasetacc:{#regionId}:{#accountId}:*

请求语法

GET /api/v1/endpoints

请求参数

名称类型必填描述示例值
EndpointIdsstring

数据集加速槽挂载点 ID 的列表,多个挂载点 ID,以半角逗号(,)分隔。

end-my1tk3jggooi5u****,end-n69468yvjz8d12****,end-tga4omjrepklkg****
SlotIdsstring

所属的数据集加速槽 ID。如何获取数据集加速槽 ID,请参见 ListSlots

slot-my1tk3jggooi5u****
Namestring

数据集加速槽挂载点名称,支持模糊匹配。

acc_instance_slot_mount_1
Typestring

挂载点的网络类型,根据网络类型不同,下列中需要传入的参数也有所不同。

  • VPC:挂载点处于 VPC 网络。
  • INNER:挂载点处于 PAI 内部网络中,用于 PAI 其他产品进行访问。
VPC
SortBystring

排序字段。

GmtCreateTime
Orderstring

排列顺序,取值如下:

  • Desc: 降序排列。
  • Asc: 升序排列。
Desc
PageNumberinteger

加速端点列表的页码。起始值为 1,默认为 1。

1
PageSizeinteger

分页查询时设置的每页显示的加速端点数量,默认为 10。

10
InstanceIdsstring

所属加速实例的 ID。

inst-ivrq92qhbyrg4jctih

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

A731A84D-55C9-44F7-99BB-E1CF0CF1****
Endpointsobject []

数据集加速端点列表。

UserIdstring

数据集加速端点的创建者的 Uid,在阿里云内为 RAM 用户 ID(阿里云账号创建则直接为阿里云账号 ID)。

27606534679741****
OwnerIdstring

数据集加速端点的资源拥有者的 Uid,在阿里云内为阿里云账号 ID。

155770209819****
GmtCreateTimestring

数据集加速端点创建的时间。格式使用 ISO8601(RFC3339)。

2014-10-02T15:01:23Z
GmtModifiedTimestring

数据集加速端点最后更新的时间。格式使用 ISO8601(RFC3339)。

2014-10-02T15:01:23Z
Uuidstring

挂载点的唯一标识符。

end-ivrq92qhbyrg4j****
Namestring

挂载点的名称。

endpoint-1
Typestring

挂载点的网络类型,可能值:

  • VPC:挂载点处于 VPC 网络。
  • INNER:挂载点处于 PAI 内部网络中,用于 PAI 其他产品进行访问。
VPC
VpcIdstring

挂载点使用的专有网络 VPC ID。

vpc-j6co2fcdsl1q0gnuc****
VswitchIdstring

挂载点使用的交换机 vSwitch ID。

vsw-j6cmr00qjyrft6jo2****
StatusEndpointStatus

数据集加速槽挂载点的状态。

InstanceIdstring

所属加速实例的 ID。

inst-ivrq92qhbyrg4jctih
TotalCountinteger

列表内元素数量总和。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "A731A84D-55C9-44F7-99BB-E1CF0CF1****",
  "Endpoints": [
    {
      "UserId": "27606534679741****",
      "OwnerId": "155770209819****",
      "GmtCreateTime": "2014-10-02T15:01:23Z",
      "GmtModifiedTime": "2014-10-02T15:01:23Z",
      "Uuid": "end-ivrq92qhbyrg4j****",
      "Name": "endpoint-1",
      "Type": "VPC",
      "VpcId": "vpc-j6co2fcdsl1q0gnuc****",
      "VswitchId": "vsw-j6cmr00qjyrft6jo2****",
      "Status": {
        "Phase": "Ready",
        "Code": "200",
        "Message": "Init Succeed",
        "Detail": {
          "IpPortMapping": {
            "key": {
              "Ip": "10.0.0.5",
              "Port": "3306"
            }
          }
        }
      },
      "InstanceId": "inst-ivrq92qhbyrg4jctih"
    }
  ],
  "TotalCount": 100
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-22OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceIds
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈