Mengkueri pipeline berdasarkan ID pipeline.
Deskripsi operasi
-
You can query up to 10 pipelines in a single request.
-
If the return value is
"Code": "InvalidIdentity.ServiceDisabled", "Message": "The request identity was not allowed to operate.", "Recommend", verify that your MPS permissions are configured correctly (ensure the AliyunMTSDefaultRole role is granted) and confirm that your account has no overdue payments.
QPS limit
The QPS limit for this API is 100 requests per second per user. Exceeding this limit triggers rate limiting and may affect your business. Call this API only as needed. For more information, see QPS limit.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mts:QueryPipelineList |
get |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| PipelineIds |
string |
Yes |
Daftar ID pipeline yang dipisahkan koma untuk dikueri. Temukan ID ini di Konsol MPS > Pengaturan Global > Pipeline. Tentukan hingga 10 ID, dipisahkan koma (,). |
d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Response parameters. |
||
| RequestId |
string |
The request ID. |
1C538EAA-ACAF-5AD8-B091-A72C63007149 |
| PipelineList |
object |
||
| Pipeline |
array<object> |
The list of pipelines. |
|
|
array<object> |
Response parameters. |
||
| Speed |
string |
The type of the MPS queue. Default value: Standard. Valid values:
|
Standard |
| State |
string |
The state of the MPS queue. Valid values:
|
Paused |
| SpeedLevel |
integer |
The level of the MPS queue. |
2 |
| NotifyConfig |
object |
The Message Service (MNS) configuration. |
|
| MqTopic |
string |
The queue of messages that are received. |
example1,example2 |
| QueueName |
string |
The name of the queue that is created in MNS. |
example-queue-**** |
| MqTag |
string |
The tag string. |
mts-test |
| Topic |
string |
The name of the topic that is created in MNS. |
example-topic-**** |
| Role |
string |
The role that is assigned to the current RAM user. |
AliyunMTSDefaultRole |
| Name |
string |
The name of the MPS queue. |
example-pipeline-**** |
| Id |
string |
The ID of the MPS queue. |
d1ce4d3efcb549419193f50f1fcd**** |
| QuotaAllocate |
integer |
The quota that is allocated to the MPS queue. |
10 |
| ExtendConfig |
object |
||
| IsBoostNew |
boolean |
||
| MaxMultiSpeed |
integer |
||
| MultiSpeedDowngradePolicy |
string |
||
| NonExistPids |
object |
||
| String |
array |
The list of non-existent pipeline IDs. |
|
|
string |
The list of non-existent pipeline IDs. This parameter is not returned if no such IDs exist. Catatan
If this parameter appears despite correct pipeline IDs, verify the UID in your request matches the pipeline owner's UID. |
72dfa5e679ab4be9a3ed9974c736**** |
Contoh
Respons sukses
JSONformat
{
"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****"
]
}
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.