DescribeFlowMetric - 查询流入带宽和流出带宽

更新时间:
复制 MD 格式

查询云电脑的流入带宽和流出带宽,或是公网精品带宽的公网访问流入带宽和流出带宽监控数据。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:DescribeFlowMetric

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou

InstanceId

string

实例 ID,可以是云电脑 ID 或者公网精品带宽 ID。

ecd-fwq23f13****或者np-6inxqsvcyv6z8****

Period

integer

监控数据的统计周期。单位:秒。

枚举值:

  • 60 :

    60 秒

  • 300 :

    300 秒

  • 900 :

    900 秒

  • 3600 :

    3600 秒

60

StartTime

string

开始时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

  • Format 格式:YYYY-MM-DDThh:mm:ssZ。

1651817220643

EndTime

string

结束时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

  • Format 格式:YYYY-MM-DDThh:mm:ssZ。

1664714703743

MetricType

string

监控信息类型。支持云电脑的流入与流出带宽,以及公网精品带宽的公网流入与流出带宽监控数据。

枚举值:

  • intranetInRate :

    云电脑的流入带宽

  • net_tx.rate :

    公网精品带宽的流出带宽

  • intranetOutRate :

    云电脑的流出带宽

  • net_rx.rate :

    公网精品带宽的流入带宽

intranetOutRate

InstanceType

string

实例类型。可以选择云电脑类型或公网精品带宽类型。如果选择云电脑类型,则InstanceIdMetricType需对应填写云电脑 ID 与云电脑的流量类型,公网精品带宽同理。

枚举值:

  • desktop :

    云电脑类型

  • network_package :

    公网精品带宽类型

desktop

返回参数

名称

类型

描述

示例值

object

返回信息集合。

Data

string

指标数据。

{'instanceId': 'np-4wrye3ishxi47****', 'requestId': '4F0CD5B6-70D6-5115-A2F7-7EAC3981****', 'dataPoints': [{'timeStamp': 1636510320000, 'Average': 293752.0}]}

RequestId

string

请求 ID。

6857EDCB-631F-5405-BE95-45CBB4C3****

示例

正常返回示例

JSON格式

{
  "Data": "{'instanceId': 'np-4wrye3ishxi47****', 'requestId': '4F0CD5B6-70D6-5115-A2F7-7EAC3981****', 'dataPoints': [{'timeStamp': 1636510320000, 'Average': 293752.0}]}",
  "RequestId": "6857EDCB-631F-5405-BE95-45CBB4C3****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidMetricType.NotFound The metric type is invalid. 指定的监控指标类型无效
400 InvalidParam The input param is not invalid, please check. 输入参数无效,请检查
500 InternalError The request processing has failed due to some unknown error, exception or failure. 服务内部异常,请稍候重试。

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

变更历史

更多信息,参考变更详情