码表逆向结果查询 - CheckDesignCodeTableStatus
功能介绍
码表管理接口码表逆向结果查询
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/code-tables/database
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参见项目ID和账号ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| directory_id | 是 | String | 需要查询的某次导入的处理结果 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 接口返回的数据。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 批量审批ID,ID字符串。 |
| tenant_id | String | 项目ID。 |
| group_id | String | 组ID,ID字符串。 |
| biz_name | String | 业务名。 |
| biz_id | String | 业务ID,ID字符串。 |
| operation_status | String | 操作结果类型枚举。RUNNING(运行中)、SUCCESS(操作成功)、FAILED(操作失败)。 枚举值: |
| operation_type | String | 批量操作类型。 枚举值: |
| biz_info | String | 业务详情。 |
| create_by | String | 创建人。 |
| remark | String | remark信息。 |
| total | Integer | 总数。 |
| success | Integer | 操作成功个数。 |
| failed | Integer | 操作失败个数。 |
| rate | String | 当前进度。 |
| logs | String | 日志。 |
| groups | Array of BatchOperationVO objects | 分组信息。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,如DS.6000,请求处理失败。 |
| error_msg | String | 错误信息。 |
| data | Object | 返回的数据信息。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,如DS.6000,请求处理失败。 |
| error_msg | String | 错误信息。 |
| data | Object | 返回的数据信息。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,如DS.6000,请求处理失败。 |
| error_msg | String | 错误信息。 |
| data | Object | 返回的数据信息。 |
请求示例
触发逆向任务后,根据目录ID,查询码表逆向结果。
GET https://{endpoint}/v1/{project_id}/code-tables/database?directory_id=1046095008471683072 响应示例
状态码:200
Success,返回data数据是 ddl
{
"data" : {
"value" : {
"id" : "1396947579547328513",
"tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70",
"group_id" : "1396947579547328512",
"biz_name" : null,
"biz_id" : null,
"operation_status" : "RUNNING",
"operation_type" : "CODETABLE_REVERSE_DB",
"biz_info" : null,
"create_by" : "test_user",
"remark" : null,
"total" : 0,
"success" : 0,
"failed" : 0,
"rate" : null,
"logs" : null,
"groups" : [ ]
}
}
} 状态码:400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
} 状态码:401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
} 状态码:403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success,返回data数据是 ddl |
| 400 | BadRequest |
| 401 | Unauthorized |
| 403 | Forbidden |