文档

ListEntitiesByTags

更新时间:

根据标签列出实体,目前只支持 maxcompute-table 类型的实体。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListEntitiesByTags

系统规定参数。取值:ListEntitiesByTags

EntityType String maxcompute-table

实体的类型。

Tags Array of UserEntityTag

标签列表。

NextToken String 12345

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

PageSize Integer 10

每页显示的条数,默认为 10 条、最大 100 条。

返回数据

名称

类型

示例值

描述

Data Object

返回数据。

NextToken String 12345

分页信息,指定下一页读取的起始点。

EntityList Array of Entity

实体列表。

RequestId String 0000-ABCD-E****

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

Success Boolean true

请求是否成功:

true: 成功;
false: 失败。

ErrorCode String 101011005

错误码。

ErrorMessage String Invalid.Entity.EntityTypeNotSupported

错误信息。

HttpStatusCode Integer 200

HTTP 状态码。

示例

请求示例

http(s)://[Endpoint]/?Action=ListEntitiesByTags
&EntityType=maxcompute-table
&Tags=[{"TagKey":"priority","TagValue":"p1"}]
&NextToken=12345
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListEntitiesByTagsResponse>
    <Data>
        <NextToken>12345</NextToken>
        <EntityList>
            <QualifiedName>maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23</QualifiedName>
            <TenantId>12345</TenantId>
        </EntityList>
    </Data>
    <RequestId>0000-ABCD-E****</RequestId>
    <Success>true</Success>
    <ErrorCode>101011005</ErrorCode>
    <ErrorMessage>Invalid.Entity.EntityTypeNotSupported</ErrorMessage>
    <HttpStatusCode>200</HttpStatusCode>
</ListEntitiesByTagsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "NextToken" : "12345",
    "EntityList" : [ {
      "QualifiedName" : "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
      "TenantId" : 12345
    } ]
  },
  "RequestId" : "0000-ABCD-E****",
  "Success" : true,
  "ErrorCode" : "101011005",
  "ErrorMessage" : "Invalid.Entity.EntityTypeNotSupported",
  "HttpStatusCode" : 200
}

错误码

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

  • 本页导读 (1)
文档反馈