全部产品
Search

搜索本产品

    智能接入网关：CreateQosPolicy - 创建QoS五元组规则

    文档中心

    智能接入网关：CreateQosPolicy - 创建QoS五元组规则

    更新时间：Mar 29, 2024

    调用CreateQosPolicy接口创建QoS策略流分类规则。

    接口说明

    在您创建 QoS 策略五元组规则前，请确保您已经创建了 QoS 策略限速规则。具体操作，请参见 CreateQosCar 。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    smartag:CreateQosPolicyWrite
    • Qos
      acs:smartag:{#regionId}:{#accountId}:qos/{#QosId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    Descriptionstring否

    QoS 策略流分类规则的描述信息。

    描述长度为 1~512 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。

    		desctest
    RegionIdstring是

    QoS 策略实例所在的地域 ID。

    		cn-shanghai
    QosIdstring是

    QoS 策略的实例 ID。

    		qos-xitd8690ucu8ro****
    Priorityinteger是

    QoS 策略流分类规则所属的限速规则优先级。

    优先级范围：1~3。数值越小，优先级越高。

    		3
    SourceCidrstring是

    源网段。

    源网段格式为 CIDR 格式。示例：192.168.1.0/24。

    		10.10.10.0/24
    DestCidrstring是

    目的网段。

    目的网段格式为 CIDR 格式。示例：192.168.10.0/24。

    		10.10.20.0/24
    IpProtocolstring是

    QoS 策略流分类规则应用的协议类型。

    QoS 策略流分类规则支持的协议类型，请以控制台为准。

    		TCP
    SourcePortRangestring是

    源端口范围。

    取值范围：-1或 1~65535。

    源端口范围格式示例：

    • 1/200，表示端口范围 1~200。
    • 80/80，表示端口 80。
    • -1/-1，表示不限制端口。
    		80/80
    DestPortRangestring是

    目的端口范围。

    取值范围：-1或 1~65535。

    目的端口范围格式示例：

    • 1/200，表示端口范围 1~200。
    • 80/80，表示端口 80。
    • -1/-1，表示不限制端口。
    		80/80
    StartTimestring否

    QoS 策略流分类规则开始生效时间。

    时间按照 ISO8601 标准表示，并使用 UTC 时间+8 小时。格式为：YYYY-MM-DDThh:mm:ss+0800。

    		2022-07-14T16:41:33+0800
    EndTimestring否

    QoS 策略流分类规则生效结束时间。

    时间按照 ISO8601 标准表示，并使用 UTC 时间+8 小时。格式为：YYYY-MM-DDThh:mm:ss+0800。

    		2022-09-14T16:41:33+0800
    Namestring否

    QoS 策略流分类规则名称。

    名称长度为 2~100 个字符，以大小写字母或中文开头，可包含数字、短划线（-）和下划线（_）。

    		nametest
    DpiSignatureIdsarray否

    应用 ID 列表。

    string否

    应用 ID。

    系统支持一次最多输入 100 个应用 ID。

    您可以通过 ListDpiSignatures 查询应用 ID 及其对应的应用信息。

    		1
    DpiGroupIdsarray否

    应用组 ID 列表。

    string否

    应用组 ID。

    系统支持一次最多输入 100 个应用组 ID。

    您可以通过 ListDpiGroups 查询应用组 ID 及其包含的应用信息。

    		20

    返回参数

    名称类型描述示例值
    object

    返回结果。

    Descriptionstring

    QoS 策略流分类规则的描述。

    		desctest
    EndTimestring

    QoS 策略流分类规则生效结束时间。

    		2022-09-14T16:41:33+0800
    RequestIdstring

    请求 ID。

    		97862812-2C7E-4D25-B0D5-B26DAC7FA293
    QosPolicyIdstring

    QoS 策略流分类规则的实例 ID。

    		qospy-xhwhyuo43l********
    SourcePortRangestring

    源端口范围。

    		80/80
    SourceCidrstring

    源网段。

    		10.10.10.0/24
    Priorityinteger

    QoS 策略流分类规则所属的限速规则优先级。

    		3
    StartTimestring

    QoS 策略流分类规则生效开始时间。

    		2022-07-14T16:41:33+0800
    DestPortRangestring

    目的端口范围。

    		80/80
    DpiGroupIdsarray

    应用组信息。

    string

    应用组 ID 列表。

    		20
    Namestring

    QoS 策略流分类规则名称。

    		nametest
    DestCidrstring

    目的网段。

    		10.10.10.0/24
    DpiSignatureIdsarray

    应用信息。

    string

    应用 ID 列表。

    		1
    QosIdstring

    QoS 策略的实例 ID。

    		qos-xitd8690ucu8ro****
    IpProtocolstring

    QoS 策略流分类规则应用的协议类型。

    		TCP

    示例

    正常返回示例

    JSON格式

    {
  "Description": "desctest",
  "EndTime": "2022-09-14T16:41:33+0800",
  "RequestId": "97862812-2C7E-4D25-B0D5-B26DAC7FA293",
  "QosPolicyId": "qospy-xhwhyuo43l********",
  "SourcePortRange": "80/80",
  "SourceCidr": "10.10.10.0/24",
  "Priority": 3,
  "StartTime": "2022-07-14T16:41:33+0800",
  "DestPortRange": "80/80",
  "DpiGroupIds": {
    "DpiGroupId": [
      "20"
    ]
  },
  "Name": "nametest",
  "DestCidr": "10.10.10.0/24",
  "DpiSignatureIds": {
    "DpiSignatureId": [
      "1"
    ]
  },
  "QosId": "qos-xitd8690ucu8ro****",
  "IpProtocol": "TCP"
}

    错误码

    HTTP status code错误码错误信息描述
    400NotSupportedProtocolThe specified protocol of the QoS policy is not supported.QoS策略规则不支持该协议。
    400InvalidId.QosThe specified QosId is invalid.您输入的参数QosId不合法。
    400QosPolicyPerQosAmountLimitThe maximum number of policies in a QoS is exceeded. You can submit a ticket to increase the quota.单个QoS策略中的QosPolicy达到上限，您可以提交工单申请提高配额。
    400MissParameter.RegionIdYou must specify RegionId.您的输入中缺少必填参数RegionId。
    400MissParameter.QosIdYou must specify QosId.您的输入中缺少必填参数QosId。
    400MissParameter.QosPolicyIdYou must specify QosPolicyId.您的输入中缺少必填参数QosPolicyId。
    400InvalidParameter.PriorityThe specified Priority is invalid.您输入的参数Priority不合法。
    400MissParameter.SourceCidrYou must specify SourceCidr.您的输入中缺少必填参数SourceCidr。
    400MissParameter.SourcePortRangeYou must specify SourcePortRange.您的输入中缺少必填参数SourcePortRange。
    400MissParameter.DestCidrYou must specify DestCidr.您的输入中缺少必填参数DestCidr。
    400MissParameter.DestPortRangeYou must specify DestPortRange.您的输入中缺少必填参数DestPortRange。
    400MissParameter.IpProtocolYou must specify IpProtocol.您的输入中缺少必填参数IpProtocol。
    400InvalidParameter.DescriptionThe specified Description is invalid.您输入的参数Description不合法。
    400InvalidParameter.DestCidrThe specified DestCidr is invalid.您输入的参数DestCidr不合法。
    400InvalidParameter.DestPortRangeThe specified DestPortRange is invalid.您输入的参数DestPortRange不合法。
    400InvalidParameter.SourceCidrThe specified SourceCidr is invalid.您输入的参数SourceCidr不合法。
    400InvalidParameter.SourcePortRangeThe specified SourcePortRange is invalid.您输入的参数SourcePortRange不合法。
    400InvalidParameter.StartTimeThe specified StartTime is invalid.您输入的参数StartTime不合法。
    400InvalidParameter.EndTimeThe specified EndTime is invalid.您输入的参数EndTime不合法。
    400InvalidTimeRangeCompareThe specified end time is earlier than the start time. Please check your input.您输入的参数中结束时间小于开始时间，请检查您的输入。
    400InvalidParameter.NameThe specified Name is invalid.您输入的参数Name不合法。
    403InternalErrorAn internal server error occurred.内部服务错误。
    403InvalidPortRangeThe specified port range is invalid.您输入的端口范围不合法。

    访问错误中心查看更多错误码。