All Products
Search

This Product

    Virtual Private Cloud:DescribeExpressConnectTrafficQosRule

    Document Center

    Virtual Private Cloud:DescribeExpressConnectTrafficQosRule

    Last Updated:Dec 20, 2024

    Queries quality of service (QoS) rules. Paging parameters are not supported.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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
    vpc:DescribeExpressConnectTrafficQosRulelist
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the QoS policy.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-shanghai
    ClientTokenstringYes

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

    Note If you do not set this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
    		123e4567-e89b-12d3-a456-426655440000
    RuleIdListarrayNo

    The list of QoS rule IDs.

    stringNo

    The ID of the QoS rule.

    		qos-rule-iugg0l9x27f2nocouj
    RuleNameListarrayNo

    The list of QoS rule names.

    stringNo

    The name of the QoS rule.

    		qos-rule-test
    QosIdstringNo

    The ID of the QoS policy.

    		qos-2giu0a6vd5x0mv4700
    QueueIdstringNo

    The ID of the QoS queue.

    		qos-queue-9nyx2u7n71s2rcy4n5

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB
    RuleListarray<object>

    The list of QoS rules.

    ruleListobject

    The information about the QoS rules.

    QosIdstring

    The ID of the QoS policy.

    		qos-pksbqfmotl5hzqmhf8
    QueueIdstring

    The ID of the QoS queue.

    		qos-queue-9nyx2u7n71s2rcy4n5
    Priorityinteger

    The priority of the QoS rule. Valid values: 1 to 9000. A larger value indicates a higher priority. The priority of each QoS rule must be unique in the same QoS policy.

    		1
    Protocolstring

    The protocol of the QoS rule. Valid values:

    • ALL
    • ICMP(IPv4)
    • ICMPv6(IPv6)
    • TCP
    • UDP
    • GRE
    • SSH
    • Telnet
    • HTTP
    • HTTPS
    • MS SQL
    • Oracle
    • MySql
    • RDP
    • PostgreSQL
    • Redis
    		ALL
    SrcCidrstring

    The source IPv4 CIDR block that matches the QoS rule traffic.

    Note When this parameter is unavailable, specify SrcIPv6Cidr or DstIPv6Cidr.
    		1.1.1.0/24
    DstCidrstring

    The destination IPv4 CIDR block that matches the QoS rule traffic.

    Note When this parameter is unavailable, specify SrcIPv6Cidr or DstIPv6Cidr.
    		1.1.1.0/24
    SrcIPv6Cidrstring

    The source IPv6 CIDR block that matches the QoS rule traffic.

    Note When this parameter is unavailable, specify SrcCidr or DstCidr.
    		2001:0db8:1234:5678::/64
    DstIPv6Cidrstring

    The destination IPv6 CIDR block that matches the QoS rule traffic.

    Note When this parameter is unavailable, specify SrcCidr or DstCidr.
    		2001:0db8:1234:5678::/64
    SrcPortRangestring

    The range of source ports that match the QoS rule traffic. Valid values: 0 to 65535. If the traffic does not match, the value is -1. You can specify only one port. The start port number must be the same as the end port number.

    		-1/-1
    DstPortRangestring

    The range of destination ports that match the QoS rule traffic. Valid values: 0 to 65535. If the traffic does not match, the value is -1. You can specify only one port. The start port number must be the same as the end port number. Different protocols correspond to different ports. Valid values:

    • ALL (uneditable): -1/-1.
    • ICMP(IPv4) (uneditable): -1/-1.
    • ICMPv6(IPv6) (uneditable): -1/-1.
    • TCP (editable): -1/-1.
    • UDP (editable): -1/-1.
    • GRE (uneditable): -1/-1.
    • SSH (uneditable): 22/22.
    • Telnet (uneditable): 23/23.
    • HTTP (uneditable): 80/80.
    • HTTPS (uneditable): 443/443.
    • MS SQL (uneditable): 1443/1443.
    • Oracle (uneditable): 1521/1521.
    • MySql (uneditable): 3306/3306.
    • RDP (uneditable): 3389/3389.
    • PostgreSQL (uneditable): 5432/5432.
    • Redis (uneditable): 6379/6379.
    		-1/-1
    MatchDscpinteger

    The DSCP value that matches the QoS rule traffic. Valid values: 0 to 63. If no value is matched, the value is -1.

    		1
    RemarkingDscpinteger

    The new DSCP value. Valid values: 0 to 63. If you do not change the value, set the value to -1.

    		1
    RuleNamestring

    The name of the QoS rule.

    The name must be 0 to 128 characters in length and cannot start with http:// or https://.

    		qos-rule-test
    RuleDescriptionstring

    The description of the QoS rule.

    The description must be 0 to 256 characters in length and cannot start with http:// or https://.

    		qos-rule-test
    RuleIdstring

    The ID of the QoS rule.

    		qos-rule-iugg0l9x27f2nocouj
    Statusstring

    The status of the QoS rule. Valid values:

    • Normal
    • Configuring
    • Deleting
    		Normal

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "9C7FA9D6-72E0-48A9-A9C3-2DA8569CD5EB",
  "RuleList": [
    {
      "QosId": "qos-pksbqfmotl5hzqmhf8",
      "QueueId": "qos-queue-9nyx2u7n71s2rcy4n5\n",
      "Priority": 1,
      "Protocol": "ALL",
      "SrcCidr": "1.1.1.0/24\n",
      "DstCidr": "1.1.1.0/24\n",
      "SrcIPv6Cidr": "2001:0db8:1234:5678::/64\n",
      "DstIPv6Cidr": "2001:0db8:1234:5678::/64\n",
      "SrcPortRange": "-1/-1\n",
      "DstPortRange": "-1/-1\n",
      "MatchDscp": 1,
      "RemarkingDscp": 1,
      "RuleName": "qos-rule-test\n",
      "RuleDescription": "qos-rule-test\n",
      "RuleId": "qos-rule-iugg0l9x27f2nocouj\n",
      "Status": "Normal"
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.%sThe param of %s is illegal.The parameter is invalid.

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

    Change history

    Change timeSummary of changesOperation
    No change history