Querying Subscription Errors

Function

This API is used to query subscription errors of a DB instance.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:update	write	-	-	rds:instance:modify	-

URI

URI format
GET

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A
instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range N/A Default Value N/A
subscription_id	No	Definition Subscription ID. If this parameter is left blank, all errors of the instance when it is used as a distributor are queried. If this parameter is not left blank, all errors of the subscription are queried. Constraints N/A Range N/A Default Value N/A
offset	No	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range The value must be a non-negative number. Default Value 0: The query starts from the first data record.
limit	No	Definition Number of records returned by a query. Constraints N/A Range 1–100 Default Value 10

Request Parameters

None

Example Request

Query subscription errors of a DB instance.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/72ee4cc4607347049df9ad50f615bbd8in04/replication/errors

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
errors	Array of Object	Definition Error list. For details, see Table 3.
total_count	Integer	Definition Total number of errors. Range N/A

**Table 3** errors field description
Parameter	Type	Description
occur_time	String	Definition Error occurrence time. Range N/A
source_type_id	String	Definition Error source type ID. Range N/A
source_name	String	Definition Error source name. Range N/A
error_code	String	Definition Error code. Range N/A
error_text	String	Definition Error message. Range N/A

Example normal response

{
"occur_time":"2023-01-05T08:00:00",
"source_type_id":"0",
"source_name":"MSSQL_ENG",
"error_code":"8102",
"error_text":"Cannot update identity column id."
}