获取表数据采样

获取表的随机采样数据。

请求地址：/openapi/v1/metadata/table/sampleData

请求方法：GET

请求参数

参数	类型	是否必选	说明	示例
datasourceId	String	是	数据源 ID。您可以调用获取数据源列表接口获取 datasourceId。	ds-d92qvqp8o1fw
databaseName	String	是	Database 名称。您可以调用获取 Database 列表接口获取 databaseName。	9zcloud
schemaName	String	否	Schema 名称。您可以调用获取 Schema 列表接口获取 schemaName。	public
tableName	String	是	Table 名称。您可以调用获取 Table 列表接口获取 tableName。	pgbench_accounts
count	Integer	否	需要采样的行数。默认值：10。为控制返回数据量，建议传入 1 ~ 100。	1

返回参数

参数	类型	说明	示例
success	Bool	接口调用是否成功。返回值：true、false。	true
requestId	String	请求 ID。	Gd3g8OGL-jpmmjRSnkqit5HAdjmb6IMV
data	Array	采样数据列表，包含采样数据的列名、列值等信息。	{ "vv": 108, "dt": "2023-12-19 15:07:55Z", "ii": 100, "id_gen_stored": 94, "v": "meidong", "id": 93, "col2": 1, "col0": 1, "dbl": 100.0, "col1": 10 }

数据详情

data 数组中每个对象的字段名称和数量由目标表结构决定。

参数	类型	说明	示例
[columnName1]	String	目标表中的列名称，作为对象的 key。	id
[columnValue1]	与列定义一致	对应列的值，作为对象的 value。	93
[columnName2]	String	目标表中的另一列名称。	name
[columnValue2]	与列定义一致	对应列的值。	"example"
...	—	其余列按相同规则返回。	—

调用成功示例

{
    "success": true,
    "requestId": "Gd3g8OGL-jpmmjRSnkqit5HAdjmb6IMV",
    "data": [{
        "vv": 108,
        "dt": "2023-12-19 15:07:55Z",
        "ii": 100,
        "id_gen_stored": 94,
        "v": "meidong",
        "id": 93,
        "col2": 1,
        "col0": 1,
        "dbl": 100.0,
        "col1": 10
    }]
}