Updated on 2026-09-07 GMT+08:00

Associating an SMN Topic

Function

This API is used to associate an SMN topic.

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, no identity policy-based permissions are required for calling this API.

URI

POST /v5/{project_id}/jobs/{job_id}/associate-smn-topic

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
job_id	Yes	String	Definition Task ID, which uniquely identifies a data replication task and serves as the identifier for operations such as query, modification, and deletion. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. Constraints N/A Range application/json Default Value application/json
X-Auth-Token	Yes	String	Definition User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints Specify the request language type based on the supported languages. Range en-us: English zh-cn: Chinese es-us: Spanish pt-br: Portuguese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
topic_urn	Yes	String	Definition Topic resource ID. Constraints You can obtain the topic name from the Simple Message Notification (SMN) service. Range N/A Default Value N/A
increment_delay_threshold	No	Long	Definition Incremental delay threshold, in seconds. Constraints N/A Range N/A Default Value N/A
rto_delay_threshold	No	Long	Definition RTO delay threshold, in seconds. This parameter can be configured in DR scenarios. Constraints N/A Range N/A Default Value N/A
rpo_delay_threshold	No	Long	Definition RPO delay threshold, in seconds. This parameter can be configured in DR scenarios. Constraints N/A Range N/A Default Value N/A
is_alarm_to_user	Yes	Boolean	Definition Whether to notify users of alarms. Constraints N/A Range true: Users are notified of alarms. false: Users are not notified of alarms. Default Value true

Response Parameters

Status code: 200

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code returned when an error occurs during task execution. Constraints Minimum length: 12 characters Maximum length: 12 characters Range The format is DRS.XXXXXX.
error_msg	String	Definition Detailed error description returned when a task fails to be executed. Constraints Minimum length: 1 character Maximum length: 512 characters Range N/A

Example Request

Request body for associating an SMN topic

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/associate-smn-topic 
 
{ 
  "topic_urn" : "urn:smn:cn-southwest-244:5237e10fe9aa4ad5b16b6a5245248314:test001", 
  "increment_delay_threshold" : 500, 
  "is_alarm_to_user" : true 
}

Example Response

Status code: 200

""

Status code: 400

{ 
  "error_code" : "DRS.M05047", 
  "error_msg" : "Topic subscription not confirmed." 
}

Status Code

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Task Operations