文档

CreatePublishGroupTask - 执行结构设计工单

执行结构设计工单。

接口说明

仅管控模式为安全协同的数据库实例可调用此 API。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

租户 ID。

说明 鼠标移动到界面右上角的头像处,查看租户 ID。具体操作,请参见查看租户信息
10****
OrderIdlong

工单 ID,可通过调用接口 ListOrders 获取该参数的值。

34****
DbIdinteger

数据库 ID,可通过调用接口 ListDatabases 获取物理库 ID 的值,调用接口 ListLogicDatabases 获取逻辑库 ID 的值。

说明 DatabaseId 的值即为 DbId 的值。
1860****
Logicboolean

是否为逻辑库。

false
PublishStrategystring

执行策略。

枚举值:
  • IMMEDIATELY立即执行
  • REGULARLY定时执行
IMMEDIATELY
PlanTimestring

任务计划开始时间。

2023-10-09 15:24:11

返回参数

名称类型描述示例值
object
TaskIdlong

任务 ID。

522***
RequestIdstring

请求 ID。

28A1B16E-8CC7-51C3-A298-B8FC79AEB0A0
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

调用失败时,返回的错误信息。

UnknownError
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "TaskId": 0,
  "RequestId": "28A1B16E-8CC7-51C3-A298-B8FC79AEB0A0",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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

变更历史

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