测试数据源SQL是否可用 - StartCheckDatasourceSql
功能介绍
测试数据源SQL是否可用。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/test-sql
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目的ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
instance_id | 是 | String | 实例ID。 |
datasource_id | 是 | String | 数据源ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
sql | 否 | String | 需要检测的SQL。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
columns | Array of ColumnInfo objects | 需要检测的SQL。 |
参数 | 参数类型 | 描述 |
|---|---|---|
field_name | String | 字段名称。 |
field_type | String | 字段类型。 |
field_length | String | 字段长度。 |
null_able | String | 是否允许为空。 |
is_partition | Boolean | 是否是分区字段。 |
primary | String | 是否是主键字段。 |
unique | String | 是否是唯一键字段。 |
decimal_digits | String | 小数部分位数，非数字类型返回null。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
detail | String | 描述详情。 |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
无
响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Error response |
404 | Not Found |
错误码
请参见错误码。
