Anda dapat memanggil operasi ListCenInterRegionTrafficQosPolicies untuk mengkueri Kebijakan Quality of Service (QoS).
Deskripsi operasi
Perhatikan hal-hal berikut saat memanggil operasi ListCenInterRegionTrafficQosPolicies:
-
Anda harus menentukan setidaknya salah satu parameter TransitRouterId atau TrafficQosPolicyId.
-
Jika Anda tidak menentukan parameter TrafficQosPolicyId, operasi akan mengembalikan informasi kebijakan QoS berdasarkan nilai parameter TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName, dan TrafficQosPolicyDescription. Dalam kasus ini, informasi mengenai antrian dalam kebijakan tersebut tidak dikembalikan, dan bidang TrafficQosQueues tidak disertakan dalam respons.
-
Jika Anda menentukan parameter TrafficQosPolicyId, operasi akan mengembalikan informasi kebijakan QoS beserta antriannya. Bidang TrafficQosQueues disertakan dalam respons. Jika bidang TrafficQosQueues berupa array kosong, hanya antrian default yang terdapat dalam kebijakan QoS tersebut.
-
Pastikan Anda memasukkan nilai parameter yang valid. Jika parameter yang dimasukkan tidak valid, sistem akan mengembalikan RequestId tetapi tidak mengembalikan informasi mengenai kebijakan QoS.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
cen:ListCenInterRegionTrafficQosPolicies |
list |
*All Resource
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| TransitRouterId |
string |
No |
ID instans TransitRouter. |
tr-bp1rmwxnk221e3fas**** |
| TransitRouterAttachmentId |
string |
No |
ID koneksi antar-wilayah. |
tr-attach-r6g0m3epjehw57**** |
| TrafficQosPolicyId |
string |
No |
ID kebijakan QoS. |
qos-rnghap5gc8155x**** |
| TrafficQosPolicyName |
string |
No |
Nama kebijakan QoS. Nama dapat kosong atau terdiri dari 1 hingga 128 karakter. Nama tidak boleh diawali dengan http:// atau https://. |
nametest |
| TrafficQosPolicyDescription |
string |
No |
Deskripsi kebijakan QoS. Deskripsi dapat kosong atau terdiri dari 1 hingga 256 karakter. Deskripsi tidak boleh diawali dengan http:// atau https://. |
desctest |
| MaxResults |
integer |
No |
Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 100. Nilai default: 20. |
20 |
| NextToken |
string |
No |
Token untuk halaman hasil berikutnya. Nilai yang valid:
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Respons yang dikembalikan. |
||
| NextToken |
string |
Token paginasi. Token ini dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru.
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| RequestId |
string |
ID permintaan. |
113BFD47-63DF-5D9D-972C-033FB9C360CD |
| TotalCount |
integer |
Jumlah entri yang dikembalikan. |
1 |
| MaxResults |
integer |
Jumlah entri yang dikembalikan per halaman. |
20 |
| TrafficQosPolicies |
array<object> |
Daftar kebijakan QoS. |
|
|
array<object> |
Informasi tentang kebijakan QoS. |
||
| TrafficQosPolicyName |
string |
Nama kebijakan QoS. |
nametest |
| TrafficQosPolicyStatus |
string |
Status kebijakan QoS.
|
Creating |
| TrafficQosPolicyId |
string |
ID kebijakan QoS. |
qos-rnghap5gc8155x**** |
| TrafficQosPolicyDescription |
string |
Deskripsi kebijakan QoS. |
desctest |
| BandwidthGuaranteeMode |
string |
Jenis jaminan bandwidth.
|
byBandwidthPercent |
| TrafficQosQueues |
array<object> |
Daftar antrian. |
|
|
object |
Informasi tentang antrian. |
||
| QosQueueName |
string |
Nama antrian. |
namtest |
| RemainBandwidthPercent |
integer |
Persentase bandwidth koneksi antar-wilayah yang digunakan oleh antrian. Parameter ini dikembalikan ketika jenis jaminan bandwidth adalah byBandwidthPercent. |
1 |
| Bandwidth |
string |
Nilai bandwidth yang dialokasikan ke antrian koneksi antar-wilayah. Parameter ini dikembalikan ketika jenis jaminan bandwidth adalah byBandwidth. |
1 |
| QosQueueId |
string |
ID antrian. |
qos-queue-njcrmr9fiu1jii**** |
| QosQueueDescription |
string |
Deskripsi antrian. |
desctest |
| Dscps |
array |
Nilai Differentiated Services Code Point (DSCP) dari paket traffic yang cocok dengan antrian. |
|
|
integer |
Nilai DSCP dari paket traffic yang cocok dengan antrian. |
5 |
|
| EffectiveBandwidth |
string |
Bandwidth aktual dari antrian. |
1.35 |
| TransitRouterId |
string |
ID instans TransitRouter. |
tr-2ze4ta4v32umj0rb*** |
| TransitRouterAttachmentId |
string |
ID koneksi instans jaringan. |
tr-attach-q7ct7c06jpw*** |
Contoh
Respons sukses
JSONformat
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
"TotalCount": 1,
"MaxResults": 20,
"TrafficQosPolicies": [
{
"TrafficQosPolicyName": "nametest",
"TrafficQosPolicyStatus": "Creating",
"TrafficQosPolicyId": "qos-rnghap5gc8155x****",
"TrafficQosPolicyDescription": "desctest",
"BandwidthGuaranteeMode": "byBandwidthPercent",
"TrafficQosQueues": [
{
"QosQueueName": "namtest",
"RemainBandwidthPercent": 1,
"Bandwidth": "1",
"QosQueueId": "qos-queue-njcrmr9fiu1jii****",
"QosQueueDescription": "desctest",
"Dscps": [
5
],
"EffectiveBandwidth": "1.35"
}
],
"TransitRouterId": "tr-2ze4ta4v32umj0rb***",
"TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
}
]
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParam.TransitRouterIdOrTrafficQosPolicyId | Either TransitRouterId or TrafficQosPolicyId must be specified. | |
| 400 | InvalidDescription | Description is invalid. | The error message returned because the description is invalid. |
| 400 | InvalidName | Name is invalid. | The error message returned because the specified name is invalid. |
| 400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.