Prioritize Traffic by Creating QoS Policies via CreateQos API - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:CreateQos

create

*Qos

acs:smartag:{#regionId}:{#accountId}:qos/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the QoS policy instance.	cn-shanghai
QosName	string	Yes	The name of the QoS policy instance. The name must be 2 to 100 characters in length and must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	doctest
QosDescription	string	No	The description of the QoS policy instance. The description must be 1 to 512 characters in length and must start with a letter or a Chinese character. It can contain digits, underscores (_), and hyphens (-).	testdesc

Response elements

Element	Type	Description	Example
	object	The QoS policy instance information.
RequestId	string	The request ID.	AACF5140-783D-48F0-9E4F-E59D716F7D08
QosId	string	The instance ID of the QoS policy.	rg-acfm2iu4fnc****
ResourceGroupId	string	The ID of the resource group to which the QoS policy instance belongs.	qos-oek3r2cmvk7m8q****

Examples

Success response

JSON format

{
  "RequestId": "AACF5140-783D-48F0-9E4F-E59D716F7D08",
  "QosId": "rg-acfm2iu4fnc****",
  "ResourceGroupId": "qos-oek3r2cmvk7m8q****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	QosAmountLimit	No more QoS can be created. You can submit a ticket to increase the quota of QoSes.	The number of QoS policies has reached the upper limit. You can submit a ticket to request a quota increase.
400	MissParameter.RegionId	You must specify RegionId.	You must set the RegionId parameter.
400	MissParameter.Name	You must specify Name.	You must set the Name parameter.
400	InvalidParameter.Name	The specified Name is invalid.	The Name parameter is set to an invalid value.
400	InvalidParameter.Description	The specified Description is invalid.	The Description parameter is set to an invalid value.
403	InternalError	An internal server error occurred.	An internal server error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.