You can call the SetupTable operation to perform a full table scan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetupTable

Required parameter. Value: SetupTable.
AllowFullTableScan String Yes true

Specifies whether to enable full table scan.
DbName String Yes test

The name of the database in which the table resides.
DrdsInstanceId String Yes drds************

The ID of the DRDS instance.
TableName.N RepeatList Yes test

The name of the associated table.
RegionId String No cn-hangzhou

The ID of the region where the streaming domain resides.

Response parameters

Parameter Type Example Description
Data Boolean true

Specifies whether to use a full table scan.
RequestId String A3140FC7-B78B-4D8E-B0C8-926D28******

The ID of the request.
Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests

http(s)://drds.aliyuncs.com/? Action=SetupTable
&AllowFullTableScan=true
&DbName=test
&DrdsInstanceId=drds************
&TableName.1=test
&<Common request parameters>

Sample success responses

XML format 

<RequestId>A3140FC7-B78B-4D8E-B0C8-926D28******</RequestId>
<Data>true</Data>
<Success>true</Success>

JSON format 

{
    "RequestId":"A3140FC7-B78B-4D8E-B0C8-926D28******",
    "Data":"true",
    "Success":true
}

Error codes

For a list of error codes, visit the API Error Center.