文档

ListInstancesTrafficPackages - 获取指定服务器的流量包使用情况

更新时间:

查询一个或多个实例的流量包详情信息。

接口说明

您可以查询一个或多个实例的流量包的详情信息,包括当月周期内的总流量、剩余流量、已使用的流量、超额流量等信息。

轻量应用服务器的套餐配置中提供了固定流量配额,固定流量配额内的流量费用已包含在套餐内。如果实际使用流量超出固定流量配额,阿里云将对超额的部分收取额外的流量费用。您需要注意:

  • 仅服务器的出网流量属于使用流量(包括每月固定的流量配额和超出流量配额后的流量),服务器的入网流量不计费。
  • 轻量应用服务器与其他阿里云服务之间通过公网产生的出网流量优先消耗服务器的固定流量配额,固定流量配额使用完毕后按超额流量计费。
  • 同一局域网(即同一 VPC 内网)的轻量应用服务器之间的流量免费。

更多信息,请参见流量配额与计费

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

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

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

请求参数

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

地域 ID。您可以调用 ListRegions 查询可用地域。

cn-hangzhou
InstanceIdsstring

轻量应用服务器实例 ID。取值可以由一个或多个实例 ID 组成一个 JSON 数组,最多支持 100 个实例 ID,实例 ID 之间用半角逗号(,)隔开。

["2ad1ae67295445f598017499dc******","2ad1ae67295445f598017499dc******"]

返回参数

名称类型描述示例值
object
InstanceTrafficPackageUsagesobject []

实例流量包详情信息。

InstanceIdstring

轻量应用服务器实例 ID。

ccscqwqwqqqw****
TrafficUsedlong

流量包当月周期内已使用流量。单位:Byte。

10000
TrafficPackageTotallong

流量包当月周期内的总流量。单位:Byte。

说明 流量包当月周期内的总流量=流量包当月周期内已使用流量+流量包当月周期内的剩余流量
20000
TrafficPackageRemaininglong

流量包当月周期内的剩余流量。单位:Byte。

10000
TrafficOverflowlong

流量包当月周期内超出流量包额度的流量。单位:Byte。

0
RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F****

示例

正常返回示例

JSON格式

{
  "InstanceTrafficPackageUsages": [
    {
      "InstanceId": "ccscqwqwqqqw****",
      "TrafficUsed": 10000,
      "TrafficPackageTotal": 20000,
      "TrafficPackageRemaining": 10000,
      "TrafficOverflow": 0
    }
  ],
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****"
}

错误码

HTTP status code错误码错误信息描述
400RegionIdNotMatchHostThe parameter regionId does not match the endpoint host.传入的regionId和请求的地址不匹配。
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

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

变更历史

变更时间变更内容概要操作
2023-09-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:AcsProduct
2023-09-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:AcsProduct
2021-10-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
  • 本页导读 (1)