You need to enable JavaScript to run this app.
文档中心
大数据研发治理套件

大数据研发治理套件

复制全文
下载 pdf
标签管理
ListEntityTags - 查询自定义标签
复制全文
下载 pdf
ListEntityTags - 查询自定义标签

查询已创建的自定义标签。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数
类型
是否必填
示例值
描述
Action
String
是

ListEntityTags

要执行的操作,取值:ListEntityTags。

Version
String
是

2026-03-01

API的版本,取值:2026-03-01。

Body

参数
类型
是否必填
示例值
描述
Query
String
否

"标签"

tag查询名称

PageSize
Integer
是

1

页面大小

PageNumber
Integer
是

10

查询页面

Creator
String
否

Account/21000xxxxx

创建人

OrderBy
String
是

timestamp

排序字段,目前只支持时间。值为timestamp

Order
String
是

ASC

排序方向,值为ASC,DESC

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Query
String

"标签"

查询Tag关键字

PageNumber
Integer

1

查询页码

PageSize
Integer

10

页码大小

Total
Integer

3

查询结果总条数

SearchDocuments
Array of Object

[
{
"Entity": {
"Creator": "DataLeapxxxx",
"QualifiedName": "Tag:///coral_tag_0629_48fe@102/default/default@21000xxxxx",
"TypeName": "Tag",
"NameCN": "coral_tag_0629_48fe",
"Timestamp": 1782702451362
}
}
]

实体查询列表

请求示例

POST /?Action=ListEntityTags&Version=2026-03-01 HTTP/1.1
Host: dataleap-qa.cn-beijing.volcengineapi.com
Content-Type: application/json
X-Date: 20260301T120000Z
Authorization: HMAC-SHA256 Credential=AK****/20260301/cn-beijing/dataleap_qa/request, SignedHeaders=host;x-date, Signature=***

{
  "Query": "",
  "PageNumber": 1,
  "PageSize": 20,
  "Creator": "Account/21000xxxxx",
  "OrderBy": "timeStamp",
  "Order": "ASC"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2026062918153689CC6348D8D05F847BAC",
    "Action": "ListEntityTags",
    "Version": "2026-03-01",
    "Service": "dataleap_qa",
    "Region": "cn-beijing"
  },
  "Result": {
    "ErrorCode": "01-200-C00000",
    "Code": 0,
    "Version": "v2",
    "Message": "success",
    "Data": {
      "Query": "",
      "PageNumber": 1,
      "PageSize": 20,
      "Total": 1,
      "SearchDocuments": [
        {
          "Entity": {
            "Creator": "DataLeapxxxx",
            "QualifiedName": "Tag:///coral_tag_0629_48fe@102/default/default@21000xxxxx",
            "TypeName": "Tag",
            "NameCN": "coral_tag_0629_48fe",
            "Timestamp": 1782702451362
          }
        }
      ]
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter

The specified parameter %s is invalid.

400
MissingParameter

The required parameter %s is missing.

404
NotFound

The requested resource does not exist.

500
InternalError

The request has failed due to an unknown error.

最近更新时间:2026.07.07 17:34:44
这个页面对您有帮助吗?
有用
有用
无用
无用