Creates a schema synchronization ticket.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dms:CreateStructSyncOrder | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Comment | string | Yes | The remarks of the ticket. | test |
RelatedUserList | array | No | The IDs of the stakeholders. | |
long | No | The ID of a stakeholder. | 432435 | |
Param | object | Yes | The parameters of the ticket. | |
Source | object | Yes | The information about the base database. | |
DbId | long | Yes | The ID of the database. You can call the SearchDatabases operation to query the ID of the database. | 4324532 |
DbSearchName | string | Yes | The name that is used to search for the database. You can call the SearchDatabases operation to query the name of the database. | test |
Logic | boolean | No | Specifies whether the database is a logical database. Valid values:
| false |
VersionId | string | No | The version number of the schema. The default value is the latest schema version number. For more information, see Manage schema versions. | e179bbb8163dcdcfacda24858bedb4d8006ae2b8 |
Target | object | Yes | The information about the database to which you want to synchronize the schema of a table. | |
DbId | long | Yes | The ID of the database. You can call the SearchDatabases operation to query the ID of the database. | 432432 |
DbSearchName | string | Yes | The name that is used to search for the database. You can call the SearchDatabases operation to query the name of the database. | test |
Logic | boolean | No | Specifies whether the database is a logical database. Valid values:
| false |
VersionId | string | No | The version number. By default, this parameter is left empty. Note
If you specify the schema version number of the destination database, Data Management (DMS) only compares the schemas of the two databases.
| e179bbb8163dcdcfacda24858bedb4d8006ae2b8 |
IgnoreError | boolean | No | Specifies whether to skip an error that occurs in executing an SQL statement. Valid values:
| false |
TableInfoList | array<object> | No | The information about the table of which you want to synchronize the schema. | |
object | No | The table of which you want to synchronize the schema. | ||
SourceTableName | string | No | The name of the source table. | test_tbl |
TargetTableName | string | No | The name of the destination table. | test_tbl |
AttachmentKey | string | No | The key of an attachment that is returned after the attachment is uploaded. You can call the GetUserUploadFileJob operation to query the key of the attachment. | upload_3c7edea3-e4c3-4403-857d-737043036f69_test.sql |
Tid | long | No | The ID of the tenant. Note
To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see Manage DMS tenants.
| 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"CreateOrderResult": [
4325353
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|