All Products
Search
Document Center

Cloud Enterprise Network:ListCenInterRegionTrafficQosPolicies

Last Updated:Mar 25, 2024

Queries the information about quality of service (QoS) policies.

Operation description

When you call the ListCenInterRegionTrafficQosPolicies operation, take note of the following information:

  • If you do not set the TrafficQosPolicyId parameter, the system returns information about QoS policies based on the values of the TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName, and TrafficQosPolicyDescription parameters, but does not return information about the queues in the QoS policies. The TrafficQosQueues parameter is not included in the response.

  • If you specify a QoS policy ID in the TrafficMarkingPolicyId parameter, the system returns the information about the QoS policy and the queues. The TrafficQosQueues parameter is included in the response.

    If the TrafficQosQueues parameter contains an empty array, it indicates that the QoS policy contains only the default queue.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cen:ListCenInterRegionTrafficQosPoliciesList
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouterIdstringNo

The ID of the transit router.

tr-bp1rmwxnk221e3fas****
TransitRouterAttachmentIdstringNo

The ID of the inter-region connection.

tr-attach-r6g0m3epjehw57****
TrafficQosPolicyIdstringNo

The ID of the QoS policy.

qos-rnghap5gc8155x****
TrafficQosPolicyNamestringNo

The name of the QoS policy.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

nametest
TrafficQosPolicyDescriptionstringNo

The description of the QoS policy.

The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

desctest
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.

20
NextTokenstringNo

The token that determines the start point of the query. Valid values:

  • If this is your first query or no subsequent query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

ParameterTypeDescriptionExample
object

The response.

NextTokenstring

The token that determines the start point of the query.

  • If NextToken was not returned in the previous query, it indicates that no additional results exist.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The ID of the request.

113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCountinteger

The total number of entries returned.

1
MaxResultsinteger

The number of entries returned per page.

20
TrafficQosPoliciesobject []

A list of QoS policies.

TrafficQosPolicyNamestring

The name of the QoS policy.

nametest
TrafficQosPolicyStatusstring

The status of the QoS policy. Valid values:

  • Creating: The QoS policy is being created.
  • Active: The QoS policy is available.
  • Modifying: The QoS policy is being modified
  • Deleting: The QoS policy is being deleted.
  • Deleted: The QoS policy is deleted.
Creating
TrafficQosPolicyIdstring

The ID of the QoS policy.

qos-rnghap5gc8155x****
TrafficQosPolicyDescriptionstring

The description of the QoS policy.

desctest
TrafficQosQueuesobject []

A list of queues.

QosQueueNamestring

The name of the queue.

namtest
RemainBandwidthPercentinteger

The percentage of the inter-region bandwidth that can be used by the queue.

1
QosQueueIdstring

The ID of the queue.

qos-queue-njcrmr9fiu1jii****
QosQueueDescriptionstring

The description of the queue.

desctest
Dscpsarray

The differentiated services code point (DSCP) value used to match packets in the queue.

integer

The DSCP value used to match packets in the queue.

5
TransitRouterIdstring

The ID of the transit router.

tr-2ze4ta4v32umj0rb***
TransitRouterAttachmentIdstring

The ID of the network instance connection.

tr-attach-q7ct7c06jpw***

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficQosPolicies": [
    {
      "TrafficQosPolicyName": "nametest",
      "TrafficQosPolicyStatus": "Creating",
      "TrafficQosPolicyId": "qos-rnghap5gc8155x****",
      "TrafficQosPolicyDescription": "desctest",
      "TrafficQosQueues": [
        {
          "QosQueueName": "namtest",
          "RemainBandwidthPercent": 1,
          "QosQueueId": "qos-queue-njcrmr9fiu1jii****",
          "QosQueueDescription": "desctest",
          "Dscps": [
            5
          ]
        }
      ],
      "TransitRouterId": "tr-2ze4ta4v32umj0rb***",
      "TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParam.TransitRouterIdOrTrafficQosPolicyIdEither TransitRouterId or TrafficQosPolicyId must be specified. -
400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
400InvalidNameName is invalid.The error message returned because the specified name is invalid.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2021-11-26Add Operationsee changesets