文档

GetStructSyncJobDetail - 获取结构同步任务详情

更新时间:

调用GetStructSyncJobDetail获取结构同步的任务详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetStructSyncJobDetailRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
OrderIdlong

工单号。

4324321
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

48602B78-0DDF-414C-8688-70CAB6070115
Successboolean

请求是否成功。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
StructSyncJobDetailobject

结构同步任务详情。

JobStatusstring

任务状态,取值和说明如下:

  • NEW:新创建。
  • COMPARING:正在对比结构。
  • COMPARE_BREAK:对比手动中断。
  • COMPARE_FINISH:对比完成。
  • NOT_SCRIPTS:对比完成, 没有可执行脚本。
  • SUBMITED_DBTASK:已提交 DBTask。
  • DBTASK_SUCCESS:DBTask 执行成功。
  • SUBMITED_WORKFLOW:提交审批。
  • WORKFLOW_SUCCESS:审批结束。
DBTASK_SUCCESS
Messagestring

任务描述信息。

test
TableAnalyzedlong

已经分析的表。

2
TableCountlong

表的总数。

2
SqlCountlong

SQL 总数。

1
ExecuteCountlong

已执行的 SQL 数量。

1
SecurityRulestring

安全规则描述,取值:

  • CANNOT_SYNC:不允许同步。
  • WITH_APPROVE:需通过审批后进行同步,可调用 SubmitStructSyncOrderApproval 接口发起审批流程。
  • WITHOUT_APPROVE:不需要审批即可进行同步。
WITHOUT_APPROVE
DBTaskGroupIdlong

SQL 任务分组 ID。

12345

示例

正常返回示例

JSON格式

{
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobDetail": {
    "JobStatus": "DBTASK_SUCCESS",
    "Message": "test",
    "TableAnalyzed": 2,
    "TableCount": 2,
    "SqlCount": 1,
    "ExecuteCount": 1,
    "SecurityRule": "WITHOUT_APPROVE",
    "DBTaskGroupId": 12345
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈