更新管道接口,可修改指定管道的名称、状态及通知设定。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | UpdatePipeline |
操作接口名,系统规定参数,取值:UpdatePipeline |
Name | String | 是 | test-pipeline |
管道名称。 最大长度128字节。 |
PipelineId | String | 是 | 93932a*****ba337432ec12 |
管道ID。 |
State | String | 是 | Paused |
管道状态,分为Active、Paused。
|
NotifyConfig | String | 否 | {"Topic":"mts-topic-1"} |
MNS通知配置。 |
Role | String | 否 | AliyunMTSDefaultRole |
角色。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2774ABF9-34AD*****5F53BE4EFFB9 |
请求ID。 |
Pipeline | Struct |
转码管道。 |
|
Id | String | 93932a*****ba337432ec12 |
管道ID。 |
Name | String | test-pipeline |
管道名称。 |
State | String | Paused |
管道状态。 |
Speed | String | Standard |
管道类型。 |
Role | String | AliyunMTSDefaultRole |
角色。 |
NotifyConfig | Struct |
MNS通知配置。 |
|
Topic | String | mts-topic-1 |
主题名称。 |
QueueName | String | mts-queue-1 |
队列名称。 |
示例
请求示例
http(s)://[Endpoint]/?Action=UpdatePipeline
&Name=test-pipeline
&PipelineId=93932a*****ba337432ec12
&State=Paused
&<公共请求参数>
正常返回示例
XML
格式
<UpdatePipelineResponse>
<pipeline>
<id>93932a*****ba337432ec12</id>
<name>test-pipeline</name>
<notifyConfig>
<Topic>mts-topic-1</Topic>
</notifyConfig>
<role>AliyunMTSDefaultRole</role>
<speed>Standard</speed>
<state>Paused</state>
</pipeline>
<requestId>2774ABF9-34AD*****5F53BE4EFFB9</requestId>
</UpdatePipelineResponse>
JSON
格式
{"pipeline":{"id":"93932a*****ba337432ec12","name":"test-pipeline","notifyConfig":{"Topic":"mts-topic-1"},"role":"AliyunMTSDefaultRole","speed":"Standard","state":"Paused"},"requestId":"2774ABF9-34AD*****5F53BE4EFFB9"}
错误码
访问错误中心查看更多错误码。