请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	TableUsageGuide	要执行的操作，取值：TableUsageGuide。
Version	String	是	2024-02-01	API的版本，取值：2024-02-01。

Body

参数	类型	是否必填	示例值	描述
TypeName	String	是	LasFormationTable	数据表元数据类型；使用唯一属性定位时必填。
Guid	String	否	25c696c2-1208-4bbb-8d53-da7ec1d8282a	数据表实体 GUID；与 TypeName + UniqueAttributes 二选一。
UniqueAttributes	Object	否	{"qualifiedName": "LasFormationTable:///hive/zbc_test_db_07_21/test_table_001@102/default/default@2100052957"}	数据表唯一属性对象；业务 Map 内的键保持小驼峰。

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	[ { "Name": "字段说明", "ContentType": "markdown", "Url": null, "Content": "字段口径与使用注意事项" }, { "Name": "表说明", "ContentType": "doc", "Url": "https://bytedance.sg.larkoffice.com/docx/MgordIJoJohgJSxY1Z1lWIg8g3e", "Content": null } ]	使用说明数组，保持产品配置顺序。

请求示例

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

{
  "TypeName": "LasFormationTable",
  "UniqueAttributes": {
    "qualifiedName": "LasFormationTable:///hive/zbc_test_db_07_21/test_table_001@102/default/default@2100052957"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260301120000000000000000000003",
    "Action": "TableUsageGuide",
    "Version": "2024-02-01",
    "Service": "dataleap",
    "Region": "cn-beijing"
  },
  "Result": {
    "ErrorCode": "01-200-C00000",
    "Code": 0,
    "Version": "v2",
    "Message": "success",
    "Data": [
      {
        "Name": "字段说明",
        "ContentType": "markdown",
        "Url": null,
        "Content": "字段口径与使用注意事项"
      },
      {
        "Name": "表说明",
        "ContentType": "doc",
        "Url": "https://bytedance.sg.larkoffice.com/docx/MgordIJoJohgJSxY1Z1lWIg8g3e",
        "Content": null
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	BadRequest	The request body or entity identifier is invalid.	请求体缺失、无法解析，或实体定位参数不完整。
401	Unauthorized	The request is not authorized.	签名、账号或接口权限校验失败。
500	InternalError	The request has failed due to an internal error.	查询关系、卡片转换或依赖服务异常。

最近更新时间：2026.09.28 15:21:48

这个页面对您有帮助吗？

有用

无用

大数据研发治理套件

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码