GetQosAttribute - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the attributes of a quality of service (QoS) policy.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the QoS policy is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
QosId	string	Yes	The ID of the QoS policy.	qos-1iqifund3gcno5****

Response parameters

Parameter	Type	Description	Example
	object
QosPolicies	object []	List of QoS policies based on 5-tuple.
EndTime	long	The end time of the valid time of the 5-tuple. The time must be in UTC+8.	2021-07-29T00:00:00+0800
StartTime	long	The start time of the valid time of the 5-tuple.	2021-06-21T00:00:00+0800
DestCidr	string	The range of the destination CIDR block.	0.0.0.0/0
DestPortRange	string	The range of destination ports. Valid values: 1 to 65535 and -1. Examples of the format of the destination port range: 1/200: a port range from 1 to 200. 80/80: port 80. -1/-1: all ports.	-1/-1
IpProtocol	string	The type of the protocol that is applied to the 5-tuple rule.	ALL
Priority	integer	The priority of the traffic throttling rule that is applied to the 5-tuple.rule. A smaller value indicates a higher priority.	1
QosPolicieDescription	string	The description of the 5-tuple.	test
SourceCidr	string	The range of the source CIDR block.	0.0.0.0/0
QosPolicieName	string	The name of the 5-tuple.	test
SourcePortRange	string	The range of source ports. Valid values: 1 to 65535 and -1. Examples of the format of the source port range: 1/200: a port range from 1 to 200. 80/80: port 80. -1/-1: all ports.	-1/-1
QosCars	object []	The traffic throttling rule applied to the QoS policies that have exceptional configurations.
MaxBandwidthAbs	integer	The maximum bandwidth. Unit: Mbit/s.	2
QosCarName	string	The name of the traffic throttling rule.	test
PercentSourceType	string	Bandwidth type when traffic is throttled to a percentage of the total bandwidth of the network. CcnBandwidth: Cloud Connect Network (CCN) bandwidth. InternetUpBandwidth: Internet upstream bandwidth.	InternetUpBandwidth
MinBandwidthAbs	integer	The minimum bandwidth. Unit: Mbit/s.	1
MaxBandwidthPercent	integer	The maximum bandwidth percentage that the traffic is throttled to.	20
QosCarDescription	string	The description of the traffic throttling rule.	test
LimitType	string	The type of traffic throttling. Valid values: Absolute: throttles traffic based on a specific range of bandwidth. Percent: throttles traffic based on a specific range of bandwidth percentage.	Absolute
Priority	integer	The priority of the traffic throttling rule. Valid values are from 1 to 3. A smaller value indicates a higher priority.	1
MinBandwidthPercent	integer	The minimum bandwidth percentage.	10
QosCarId	string	The ID of the traffic throttling rule.	qoscar-xir1apa8ayjp56ei****
RequestId	string	The ID of the request.	91058E01-1806-45D5-B305-19E4D0A5CE04
ErrorConfigSmartAGCount	integer	The number of Smart Access Gateway (SAG) instances that have exceptional configurations.	1
QosName	string	The name of the QoS policy.	test
QosDescription	string	The description of the QoS policy.	test

Examples

Sample success responses

JSONformat

{
  "QosPolicies": [
    {
      "EndTime": 0,
      "StartTime": 0,
      "DestCidr": "0.0.0.0/0",
      "DestPortRange": "-1/-1",
      "IpProtocol": "ALL",
      "Priority": 1,
      "QosPolicieDescription": "test",
      "SourceCidr": "0.0.0.0/0",
      "QosPolicieName": "test",
      "SourcePortRange": "-1/-1"
    }
  ],
  "QosCars": [
    {
      "MaxBandwidthAbs": 2,
      "QosCarName": "test",
      "PercentSourceType": "InternetUpBandwidth",
      "MinBandwidthAbs": 1,
      "MaxBandwidthPercent": 20,
      "QosCarDescription": "test",
      "LimitType": "Absolute",
      "Priority": 1,
      "MinBandwidthPercent": 10,
      "QosCarId": "qoscar-xir1apa8ayjp56ei****"
    }
  ],
  "RequestId": "91058E01-1806-45D5-B305-19E4D0A5CE04",
  "ErrorConfigSmartAGCount": 1,
  "QosName": "test",
  "QosDescription": "test"
}

Error codes

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