文档

DescribeQoses - 查询QoS策略

更新时间:

调用DescribeQoses接口查询指定地域下QoS策略实例信息。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-shanghai
QosIdsstring

QoS策略实例ID。

  • 如果要同时查询多个QoS策略实例,多个实例ID之间以半角逗号(,)分隔开。
  • 如果不填写该项,则默认查询该地域下所有QoS策略实例信息。
qos-oek3r2cmvk7m8q****
QosNamestring

QoS策略实例名称。

名称长度为2~100个字符,以大小写字母或中文开头,可包含数字、下划线(_)、半角句号(.)和短划线(-)。

zxtest
PageSizeinteger

分页查询时,每页包含的条目数。默认值为10,最大值为50

10
PageNumberinteger

查询页码。默认值为1

1

返回参数

名称类型描述示例值
object

查询结果。

TotalCountinteger

总条目数。

1
PageSizeinteger

分页查询时,每页包含的条目数。

10
RequestIdstring

请求ID。

2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2
PageNumberinteger

查询页码。

1
Qosesobject []

QoS策略实例信息列表。

QosDescriptionstring

QoS策略实例的描述信息。

description
SagCountstring

QoS策略实例关联的智能接入网关实例数量。

0
SmartAGIdsstring

QoS策略实例关联的智能接入网关实例列表。

sag-x34wj76fe0vhw*****,sag-jp04l844chg16*****
QosIdstring

QoS策略实例ID。

qos-oek3r2cmvk7m8q****
QosNamestring

QoS策略实例的名称。

zxtest
ResourceGroupIdstring

QoS策略实例所属的资源组ID。

rg-acfm2iu4fnc****

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "2B5F35DD-0D66-41FC-AA99-BAE473E1A7A2",
  "PageNumber": 1,
  "Qoses": {
    "Qos": [
      {
        "QosDescription": "description",
        "SagCount": "0",
        "SmartAGIds": "sag-x34wj76fe0vhw*****,sag-jp04l844chg16*****",
        "QosId": "qos-oek3r2cmvk7m8q****",
        "QosName": "zxtest",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403InvalidParameterThe specified parameter is invalid.非法参数。
403MissingParameterThe input parameter is missing, please check your input.输入参数缺失,请检查您的输入。
403InternalErrorAn internal server error occurred.内部服务错误。

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

  • 本页导读 (1)
文档反馈