パイプライン ID を指定してパイプラインをクエリします。
操作説明
1 回のリクエストで最大 10 個のパイプラインをクエリできます。
戻り値が
"Code": "InvalidIdentity.ServiceDisabled", "Message": "The request identity was not allowed to operate.", "Recommend"の場合、MPS の権限設定が正しく構成されているか確認してください(AliyunMTSDefaultRole ロールが付与されていることを確認)および、アカウントに支払い遅延がないか確認してください。
QPS 制限
この API の QPS 制限は、ユーザーあたり 1 秒あたり 100 回のリクエストです。この制限を超えるとレート制限が適用され、ビジネスに影響を与える可能性があります。必要に応じてのみこの API を呼び出してください。詳細については、「QPS 制限」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
mts:QueryPipelineList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PipelineIds |
string |
必須 |
クエリ対象のパイプライン ID をカンマ区切りで指定します。これらの ID は、MPS コンソール > グローバル設定 > パイプライン から確認できます。最大 10 個まで指定でき、各 ID はカンマ (,) で区切ります。 |
d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
1C538EAA-ACAF-5AD8-B091-A72C63007149 |
| PipelineList |
object |
||
| Pipeline |
array<object> |
パイプラインの一覧。 |
|
|
array<object> |
応答パラメーター。 |
||
| Speed |
string |
パイプラインの種類。デフォルト値: Standard。有効な値:
|
Standard |
| State |
string |
パイプラインのステータス。
|
Paused |
| SpeedLevel |
integer |
パイプラインのレベル。 |
2 |
| NotifyConfig |
object |
Alibaba Cloud Simple Message Queue(旧称:MNS)による通知構成。 |
|
| MqTopic |
string |
メッセージを受信するメッセージキュー。 |
example1,example2 |
| QueueName |
string |
Alibaba Cloud Simple Message Queue(旧称:MNS)で作成したキュー名。 |
example-queue-**** |
| MqTag |
string |
タグ。 |
mts-test |
| Topic |
string |
Alibaba Cloud Simple Message Queue(旧称:MNS)で作成したトピック名。 |
example-topic-**** |
| Role |
string |
現在の RAM ユーザーに関連付けられたロール。 |
AliyunMTSDefaultRole |
| Name |
string |
パイプライン名。 |
example-pipeline-**** |
| Id |
string |
パイプライン ID。 |
d1ce4d3efcb549419193f50f1fcd**** |
| QuotaAllocate |
integer |
パイプラインのクォータ割り当て量。 |
10 |
| ExtendConfig |
object |
||
| IsBoostNew |
boolean |
||
| MaxMultiSpeed |
integer |
||
| MultiSpeedDowngradePolicy |
string |
||
| NonExistPids |
object |
||
| String |
array |
存在しないパイプライン ID のリスト。 |
|
|
string |
存在しないパイプライン ID のリスト。該当する ID が存在しない場合は、このパラメーターは返されません。 説明
正しいパイプライン ID を指定しているにもかかわらず、このパラメーターが返された場合は、リクエスト内の UID がパイプライン所有者の UID と一致しているか確認してください。 |
72dfa5e679ab4be9a3ed9974c736**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "1C538EAA-ACAF-5AD8-B091-A72C63007149",
"PipelineList": {
"Pipeline": [
{
"Speed": "Standard",
"State": "Paused",
"SpeedLevel": 2,
"NotifyConfig": {
"MqTopic": "example1,example2",
"QueueName": "example-queue-****",
"MqTag": "mts-test",
"Topic": "example-topic-****"
},
"Role": "AliyunMTSDefaultRole",
"Name": "example-pipeline-****",
"Id": "d1ce4d3efcb549419193f50f1fcd****",
"QuotaAllocate": 10,
"ExtendConfig": {
"IsBoostNew": false,
"MaxMultiSpeed": 0,
"MultiSpeedDowngradePolicy": ""
}
}
]
},
"NonExistPids": {
"String": [
"72dfa5e679ab4be9a3ed9974c736****"
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。