The UpdatePipeline API updates an MPS queue. You can modify the name and notification settings and change the status of an MPS queue.
Request parameters
Parameters | Type | Required or not | Description |
---|---|---|---|
Action | String | Yes | API of the action, system required parameter. Value: UpdatePipeline |
PipelineId | String | Yes | MPS queue ID. |
Name | String | Yes | MPS queue name.
Up to 128 characters. |
State | String | Yes | MPS queue status, which can be Active and Paused.
|
NotifyConfig | String | No | Message Service configuration.
Example: |
Role | String | No | Roles |
Response parameters
Parameter | Type | Description |
---|---|---|
Pipeline | String | MPS queue |
Examples
Request example
http://mts.cn-hangzhou.aliyuncs.com/?PipelineId=5efb0fa33836432e9488ed56eb0075c8&Name=example-watermark&State=Paused&Action=UpdatePipeline&NotifyConfig=%7b"%3btopic"%3b%3a"%3bmts-topic-1"%3b%2c+"%3brole"%3b%3a"%3brole1"%3b%7d<Public parameter>
Response example
XML
<UpdatePipelineResponse>
<RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
<Pipeline>
<Id>31fa3c9ca8134f9cec2b4b0b0f787830</Id>
<Name>qupai-pipeline</Name>
<State>Active</State>
<Speed>Standard</Speed>
<NotifyConfig>
<Topic>mts-topic-1</Topic>
</NotifyConfig>
<Role>AliyunMTSDefaultRole</Role>
</Pipeline>
</UpdatePipelineResponse>
JSON
{
"RequestId":"25818875-5F78-4A13-BEF6-D7393642CA58",
"Pipeline":{
"Id":"31fa3c9ca8134f9cec2b4b0b0f787830",
"Name":"qupai-pipeline",
"State":"Active",
"Speed":"Standard",
"NotifyConfig":{
"Topic":"mts-topic-1"
},
"Role":"AliyunMTSDefaultRole"
}
}