SearchPipeline - 搜尋管道 -

通過管道狀態搜尋管道。

介面說明

本介面通過管道狀態搜尋管道，如果不指定管道狀態則預設搜尋全部管道。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mts:SearchPipeline

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageSize	integer	否	分頁查詢時設定的每頁行數大小。上限值：100。預設值：10。	10
PageNumber	integer	否	當前頁號。預設值：1。	1
State	string	否	需要搜尋的管道狀態。如果為空白則預設搜尋所有管道。 All：全部管道。 Active：管道開啟。 Paused：管道暫停。預設值：All。	Paused

返回參數

名稱	類型	描述	樣本值
	object	返回參數。
TotalCount	integer	總條數。	1
PageSize	integer	每頁行數大小。	10
RequestId	string	請求 ID。	338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
PageNumber	integer	當前頁碼。	1
PipelineList	object
Pipeline	array<object>	管道列表。
	array<object>	管道詳細資料。
Speed	string	管道類型。預設值：Standard（標準管道）。可取值： Boost：倍速轉碼管道。 Standard：標準管道。 NarrowBandHDV2：窄帶高清 2.0 管道。 AIVideoCover：智能截圖管道。 AIVideoFPShot：視頻 DNA 管道。 AIVideoCensor：智能審核管道。 AIVideoMCU：智能標籤管道。 AIVideoSummary：視頻摘要管道。 AIVideoPorn：視頻鑒黃管道。 AIAudioKWS：音頻關鍵字識別管道。 AIAudioASR：語音轉文字管道。	Standard
State	string	管道狀態。可取值： Active：管道開啟。 Paused：管道暫停。	Paused
SpeedLevel	integer	管道層級。	1
NotifyConfig	object	MNS 通知配置。
MqTopic	string	接收到的訊息佇列。	example1,example2
QueueName	string	阿里雲輕量訊息佇列（原 MNS）中建立的隊列。	example-queue-****
MqTag	string	標籤。	mts-test
Topic	string	阿里雲輕量訊息佇列（原 MNS）中建立的主題。	example-topic-****
Role	string	當前 RAM 使用者關聯的角色。	AliyunMTSDefaultRole
Name	string	管道名稱。	example-pipeline-****
Id	string	管道 ID。	d1ce4d3efcb549419193f50f1fcd****
QuotaAllocate	integer	管道配額分配。	10
CreationTime	string	管道建立時間。	2021-03-04T06:44:43Z

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
  "PageNumber": 1,
  "PipelineList": {
    "Pipeline": [
      {
        "Speed": "Standard",
        "State": "Paused",
        "SpeedLevel": 1,
        "NotifyConfig": {
          "MqTopic": "example1,example2",
          "QueueName": "example-queue-****",
          "MqTag": "mts-test",
          "Topic": "example-topic-****"
        },
        "Role": "AliyunMTSDefaultRole",
        "Name": "example-pipeline-****",
        "Id": "d1ce4d3efcb549419193f50f1fcd****",
        "QuotaAllocate": 10,
        "CreationTime": " 2021-03-04T06:44:43Z"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。