DescribeTables
最后更新时间：2024-11-26 16:47:34
1. API Description
Domain name for API request: omics.intl.tencentcloudapi.com.
This API is used to query the table.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeTables. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId | Yes | String | Project ID |
| Limit | No | Integer | Quantity of returns. It is 10 by default, and the maximum value is 100. |
| Offset | No | Integer | Offset, which defaults to 0 |
| Filters.N | No | Array of Filter | Filter, which supports filtering fields: - Name: Table name - TableId: Table ID |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of results |
| Tables | Array of Table | Table list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the Table
This example shows you how to query the table.
Input Example
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTables
<Common request parameters>
{
"ProjectId": "prj-aggressive-lime-porcupine-752427",
"Filters": [
{
"Name": "Name",
"Values": [
"test"
]
},
{
"Name": "TableId",
"Values": [
"tab-cold-purple-barnacle-251091"
]
}
]
}
Output Example
{
"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
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| OperationDenied | Operation rejected. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.ProjectNotExist | The project does not exist. |
是
否
本页内容是否解决了您的问题？