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

请求参数

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

Query

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const queryData = [
  {
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"ListEntityTags"} />,
    Description: <RenderMd content={"要执行的操作，取值：ListEntityTags。"} />,
    children: [
    ]
  },
  {
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2026-03-01"} />,
    Description: <RenderMd content={"API的版本，取值：2026-03-01。"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={queryData}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

Body

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const bodyData = [
  {
    rowKey: '->Query',
    Name: 'Query',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"\"标签\""} />,
    Description: <RenderMd content={"tag查询名称"} />,
    children: [
    ]
  },
  {
    rowKey: '->PageSize',
    Name: 'PageSize',
    DataType: 'Integer',
    IsRequired: '是',
    Example: <RenderMd content={"1"} />,
    Description: <RenderMd content={"页面大小"} />,
    children: [
    ]
  },
  {
    rowKey: '->PageNumber',
    Name: 'PageNumber',
    DataType: 'Integer',
    IsRequired: '是',
    Example: <RenderMd content={"10"} />,
    Description: <RenderMd content={"查询页面"} />,
    children: [
    ]
  },
  {
    rowKey: '->Creator',
    Name: 'Creator',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"Account/21000xxxxx"} />,
    Description: <RenderMd content={"创建人"} />,
    children: [
    ]
  },
  {
    rowKey: '->OrderBy',
    Name: 'OrderBy',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"timestamp"} />,
    Description: <RenderMd content={"排序字段，目前只支持时间。值为timestamp"} />,
    children: [
    ]
  },
  {
    rowKey: '->Order',
    Name: 'Order',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"ASC"} />,
    Description: <RenderMd content={"排序方向，值为ASC，DESC"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={bodyData}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

返回参数

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

const columns = [
  {
    width: '25%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name',
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: '25%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: "->Query",
    Name: "Query",
    DataType: "String",
    Example: <RenderMd content={"\"标签\""} />,
    Description: <RenderMd content={"查询Tag关键字"} />,
    children: [
    ]
  },
  {
    rowKey: "->PageNumber",
    Name: "PageNumber",
    DataType: "Integer",
    Example: <RenderMd content={"1"} />,
    Description: <RenderMd content={"查询页码"} />,
    children: [
    ]
  },
  {
    rowKey: "->PageSize",
    Name: "PageSize",
    DataType: "Integer",
    Example: <RenderMd content={"10"} />,
    Description: <RenderMd content={"页码大小"} />,
    children: [
    ]
  },
  {
    rowKey: "->Total",
    Name: "Total",
    DataType: "Integer",
    Example: <RenderMd content={"3"} />,
    Description: <RenderMd content={"查询结果总条数"} />,
    children: [
    ]
  },
  {
    rowKey: "->SearchDocuments",
    Name: "SearchDocuments",
    DataType: "Array of Object",
    Example: <RenderMd content={"[\n        {\n          \"Entity\": {\n            \"Creator\": \"DataLeapxxxx\",\n            \"QualifiedName\": \"Tag:///coral_tag_0629_48fe@102/default/default@21000xxxxx\",\n            \"TypeName\": \"Tag\",\n            \"NameCN\": \"coral_tag_0629_48fe\",\n            \"Timestamp\": 1782702451362\n          }\n        }\n      ]"} />,
    Description: <RenderMd content={"实体查询列表 "} />,
    children: [
        {
          rowKey: "->SearchDocuments->Creator",
          Name: "Creator",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"标签创建人"} />,
          children: [
          ]
        },
        {
          rowKey: "->SearchDocuments->NameCN",
          Name: "NameCN",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"标签名称"} />,
          children: [
          ]
        },
        {
          rowKey: "->SearchDocuments->QualifiedName",
          Name: "QualifiedName",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"标签唯一标识"} />,
          children: [
          ]
        },
        {
          rowKey: "->SearchDocuments->TypeName",
          Name: "TypeName",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"标签实体类型"} />,
          children: [
          ]
        },
        {
          rowKey: "->SearchDocuments->Timestamp",
          Name: "Timestamp",
          DataType: "Long",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"创建时间"} />,
          children: [
          ]
        },
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

请求示例

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
          }
        }
      ]
    }
  }
}

错误码

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

const columns = [
  {
    title: '状态码',
    dataIndex: 'HttpCode',
    width: '12%',
    className: 'openapi-doc-errorcode-table-httpcode'
  },
  {
    title: '错误码',
    dataIndex: 'ErrorCode',
    width: '22%',
    className: 'openapi-doc-errorcode-table-errorcode'
  },
  {
    title: '错误信息',
    dataIndex: 'ErrorMessage',
    width: '33%',
    className: 'openapi-doc-errorcode-table-errormessage'
  },
  {
    title: '说明',
    dataIndex: 'Description',
    width: '33%',
    className: 'openapi-doc-errorcode-table-description'
  },
];

const data = [
  {
    HttpCode: 400,
    ErrorCode: 'InvalidParameter',
    ErrorMessage: <RenderMd content={"The specified parameter %s is invalid."} />,
    Description: <RenderMd content={""} />,
  },
  {
    HttpCode: 400,
    ErrorCode: 'MissingParameter',
    ErrorMessage: <RenderMd content={"The required parameter %s is missing."} />,
    Description: <RenderMd content={""} />,
  },
  {
    HttpCode: 404,
    ErrorCode: 'NotFound',
    ErrorMessage: <RenderMd content={"The requested resource does not exist."} />,
    Description: <RenderMd content={""} />,
  },
  {
    HttpCode: 500,
    ErrorCode: 'InternalError',
    ErrorMessage: <RenderMd content={"The request has failed due to an unknown error."} />,
    Description: <RenderMd content={""} />,
  },
];

return (<Table
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);