ListMetaCollectionEntities - 查询集合中的实体

更新时间:
复制 MD 格式

该接口用于查询集合中的实体。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

CollectionQualifiedName

string

是

集合唯一标识。

album.12345

EntityType

string

否

实体类型。示例:maxcompute-table 表示 MaxCompute 表类型。

maxcompute-table

Keyword

string

否

搜索关键词。

test

NextToken

string

否

分页信息,指定本次读取的起始点。

12222

PageSize

integer

否

分页大小。

10

返回参数

名称

类型

描述

示例值

object

OpenApiMetaResultModel

Data

object

返回结构体。

NextToken

string

下一页的 Token。

123344

EntityList

array

实体数组。

Entity

实体信息。

RequestId

string

请求的 ID。用于定位日志,排查问题。

E25887B7-579C-54A5-9C4F-83A0DE367DD

Success

boolean

调用是否成功。取值如下:

true:调用成功。

false:调用失败。

true

ErrorCode

string

错误码。

Invalid.Collection.NotExists

ErrorMessage

string

错误信息。

The specified parameters are invalid.

HttpStatusCode

integer

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "Data": {
    "NextToken": "123344",
    "EntityList": [
      {
        "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
        "TenantId": 12345,
        "EntityContent": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  },
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DD",
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

错误码

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

变更历史

更多信息,参考变更详情。