Querying SMN Subscriptions of a Task
Function
This API is used to query SMN subscriptions of a task.
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
GET /v5/{project_id}/jobs/{job_id}/smn-subscription-detail
| 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | 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 N/A Range
Default Value en-us |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| topic_name | String | Definition SMN topic name. Constraints N/A Range N/A |
| topic_urn | String | Definition Unique resource identifier of the SMN topic. Constraints N/A Range N/A |
| delay_time | Integer | Definition Delay time, in seconds. Constraints N/A Range N/A |
| rpo_delay | Integer | Definition RPO delay time, in seconds. Constraints N/A Range N/A |
| rto_delay | Integer | Definition RTO delay time, in seconds. Constraints N/A Range N/A |
| is_alarm_user | Boolean | Definition Whether to send alarms to subscribers. Constraints N/A Range
|
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code returned when an error occurs during task execution. Constraints
Range The format is DRS.XXXXXX. |
| error_msg | String | Definition Detailed error description returned when a task fails to be executed. Constraints
Range N/A |
Example Request
Querying SMN subscriptions of a task
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/9d3fd3d7-c4f0-4327-9de2-0d824ecjb201/smn-subscription-detail Example Response
Status code: 200
{
"topic_name" : "xxx",
"is_alarm_user" : true,
"topic_urn" : "urn:smn:cn-southwest-244:5237e10fe9aa4ad5b16b6a5245248314:xxx",
"delay_time" : 0,
"rto_delay" : 0,
"rpo_delay" : 0
} Status code: 400
Bad Request
{
"error_code" : "DRS.M00261",
"error_msg" : "Invalid project ID."
} Error Code
For details, see Error Code.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot