Querying Tables of a Primary HTAP Instance
Function
This API is used to query data tables of a primary HTAP instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/{instance_id}/htap/tables
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
instance_id |
Yes |
String |
Definition Standard HTAP instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of in17. Only letters and digits are allowed. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
String |
Definition Number of records to be queried. Constraints N/A Range N/A Default Value 100 |
offset |
No |
String |
Definition Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number. Constraints N/A Range N/A Default Value 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type. Constraints N/A Range application/json Default Value N/A |
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range
Default Value en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
database_tables |
No |
Array of DatabaseTablesInfo objects |
Definition Names of databases and tables to be queried. Constraints N/A Range N/A Default Value N/A |
source_instance_id |
No |
String |
Definition ID of the source instance whose database is to be queried. The value is compliant with the UUID format. Constraints The value contains 36 characters. Only letters and digits are allowed. Range N/A Default Value N/A |
selected_tables |
No |
Array of DatabaseTablesInfo objects |
Definition Names of selected databases and tables. Constraints N/A Range N/A Default Value N/A |
filter_type |
No |
String |
Definition Table blacklist or whitelist. include_tables: whitelist; exclude_tables: blacklist. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
database |
No |
String |
Definition Name of a database to be queried. Constraints Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A Default Value N/A |
tables |
No |
Array of strings |
Definition Names of the data tables to be queried. Constraints Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
tables |
Array of strings |
Definition Table names. Default Value N/A |
total_count |
Integer |
Definition Number of databases. Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Example Request
Querying the first 10 data tables of the instance whose ID is 1f6305e9ac4443b8a79f1bfd3a523002in07
GET https://{localhost}/v3/{project_id}/instances/{instance_id}/htap/databases?limit=10&offset=1 { "tables" : [ ], "source_instance_id" : "1f6305e9ac4443b8a79f1bfd3a523002in07" }
Example Response
Status code: 200
Success.
{ "tables" : [ "test_table1", "test_table2", "test_table3", "test_table4", "test_table5", "test_table6" ], "total_count" : 6 }
Status code: 400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "Instance not found." }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot