接口请求域名: omics.intl.tencentcloudapi.com 。
查询表格。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTables。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-28。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, ap-singapore, eu-frankfurt 。 |
| ProjectId | 是 | String | 项目ID。 |
| Limit | 否 | Integer | 返回数量,默认为10,最大值为100。 |
| Offset | 否 | Integer | 偏移量,默认为0。 |
| Filters.N | 否 | Array of Filter | 过滤器,支持过滤字段: - Name:表格名称 - TableId:表格ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 结果总数。 |
| Tables | Array of Table | 表格列表。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
查询表格。
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTables
<公共请求参数>
{
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"Filters": [
{
"Name": "TableId",
"Values": [
"tab-cold-purple-barnacle-251091"
]
}
]
}
{
"Response": {
"RequestId": "8baa213d-e5c5-4e38-a3a4-562e71b5210b",
"Tables": [
{
"Columns": [
{
"DataType": "String",
"Header": "runId"
},
{
"DataType": "File",
"Header": "fileName"
}
],
"CreateTime": "2023-03-16 16:44:24",
"Creator": "100029430413",
"Description": "cloudapi_test",
"Name": "cloudapi_test_1",
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"TableId": "tab-cold-purple-barnacle-251091"
}
],
"TotalCount": 1
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ProjectNotExist | 项目不存在 |
文档反馈