SyncInstanceMeta - Data Management - Alibaba Cloud Documentation Center

Synchronizes the metadata of all databases in a database instance.

Operation description

You can call this operation only for database instances whose control mode is Security Collaboration.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:SyncInstanceMeta	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the Manage DMS tenants topic.	3***
InstanceId	string	Yes	The ID of the instance.	12***
IgnoreTable	boolean	No	Specifies whether to skip synchronization for the metadata of table dictionaries. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	A99CD576-1E18-4E86-931E-C3CCE56DC030
ErrorCode	string	Details about the topology of the data table.	UnknownError
ErrorMessage	string	The error code returned.	UnknownError
Success	boolean	Indicates whether the request is successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "A99CD576-1E18-4E86-931E-C3CCE56DC030",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history