调用ListEndpoints接口,获取在ES Serverless平台创建的VPC终端节点列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
es-serverless:ListEndpoint |
|
| 无 |
请求语法
GET /openapi/es-serverless/endpoints
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
type | string | 是 | 节点类型, 默认 VPC。 | VPC |
pageNumber | integer | 否 | 页码,默认值:1。 | 1 |
pageSize | integer | 否 | 每页记录数,默认值:10。 | 10 |
vpcId | string | 否 | VPC 网络 ID。 | vpc-bp1212sb7cj2j4e6x**** |
resourceId | string | 否 | 资源 ID,VPC 类型资源 ID 对应为 privatelink 实例 ID。 | ep-bp1id41dd116e52e**** |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "D6030CE6-9FEB-5B2F-84AC-3ADE3CBA89E5",
"result": [
{
"endpointId": "essep-2f46b743f60****",
"resourceId": "ep-bp1id41dd116e52e****\n",
"vpcId": "vpc-uf6gykvwcirp886ef****",
"status": "Active",
"connectionStatus": "Pending",
"type": "VPC",
"created": 1701259721,
"updated": 1701259721,
"name": "test",
"endpointZones": [
{
"zoneId": "cn-hangzhou-k",
"vSwitchId": "vsw-bp194pz9iez****"
}
],
"securityGroupIds": [
"sg-bp1278950t9ykn2s****"
],
"domain": "ep-bp1i522d****a3.epsrv-bp1f****gei.cn-hangzhou.privatelink.aliyuncs.com"
}
],
"totalCount": 10
}
错误码
访问错误中心查看更多错误码。