Gunakan ListCenInterRegionTrafficQosPolicies untuk menanyakan kebijakan QoS - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Anda dapat memanggil operasi ListCenInterRegionTrafficQosPolicies untuk mengkueri Kebijakan Quality of Service (QoS).

Deskripsi operasi

Take note of the following items when you call the ListCenInterRegionTrafficQosPolicies operation:

You must specify at least one of the TransitRouterId and TrafficQosPolicyId parameters.
If you do not specify the TrafficQosPolicyId parameter, the operation returns information about the QoS policy based on the values of the TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName, and TrafficQosPolicyDescription parameters. In this case, information about the queues in the policy is not returned, and the TrafficQosQueues field is not included in the response.
If you specify the TrafficQosPolicyId parameter, the operation returns information about the QoS policy and its queues. The TrafficQosQueues field is included in the response. If the TrafficQosQueues field is an empty array, only the default queue exists in the QoS policy.
Make sure that you enter valid parameter values. If you enter an invalid parameter, the system returns a RequestId but does not return information about the QoS policy.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

cen:ListCenInterRegionTrafficQosPolicies

list

*All Resource

*

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 memiliki panjang 1 hingga 128 karakter. Nama tidak boleh dimulai dengan http:// atau https://.	nametest
TrafficQosPolicyDescription	string	No	Deskripsi Kebijakan QoS. Deskripsi dapat kosong atau memiliki panjang 1 hingga 256 karakter. Deskripsi tidak boleh dimulai dengan http:// atau https://.	desctest
MaxResults	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid: 1 hingga 100. Nilai default: 20.	20
NextToken	string	No	Token untuk halaman hasil berikutnya. Nilai valid: Jika ini adalah kueri pertama Anda atau tidak ada halaman berikutnya, jangan tentukan parameter ini. Jika halaman berikutnya ada, atur nilainya ke nilai NextToken yang dikembalikan dari panggilan sebelumnya.	FFmyTO70tTpLG6I3FmYAXGKPd****

Elemen respons

Element	Type	Description	Example
	object	The response that is returned.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCount	integer	The number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
TrafficQosPolicies	array<object>	The list of QoS policies.
	array<object>	The information about the QoS policy.
TrafficQosPolicyName	string	The name of the QoS policy.	nametest
TrafficQosPolicyStatus	string	The status of the QoS policy. Creating: The policy is being created. Active: The policy is active. Modifying: The policy is being modified. Deleting: The policy is being deleted.	Creating
TrafficQosPolicyId	string	The ID of the QoS policy.	qos-rnghap5gc8155x****
TrafficQosPolicyDescription	string	The description of the QoS policy.	desctest
BandwidthGuaranteeMode	string	The bandwidth guarantee type. byBandwidth: The QoS queues are configured based on an absolute bandwidth value. byBandwidthPercent: The QoS queues are configured based on a bandwidth percentage.	byBandwidthPercent
TrafficQosQueues	array<object>	The list of queues.
	object	The information about the queue.
QosQueueName	string	The name of the queue.	namtest
RemainBandwidthPercent	integer	The percentage of the inter-region connection bandwidth that is used by the queue. This parameter is returned when the bandwidth guarantee type is byBandwidthPercent.	1
Bandwidth	string	The bandwidth value allocated to the queue of the inter-region connection. This parameter is returned when the bandwidth guarantee type is byBandwidth.	1
QosQueueId	string	The ID of the queue.	qos-queue-njcrmr9fiu1jii****
QosQueueDescription	string	The description of the queue.	desctest
Dscps	array	The Differentiated Services Code Point (DSCP) values of the traffic messages that are matched by the queue.
	integer	The DSCP value of a traffic message that is matched by the queue.	5
EffectiveBandwidth	string	The actual bandwidth of the queue.	1.35
TransitRouterId	string	The ID of the TransitRouter instance.	tr-2ze4ta4v32umj0rb***
TransitRouterAttachmentId	string	The ID of the network instance connection.	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.