调用GetClientRatioStatistic查询客户端比率统计_云安全中心(Security Center)-阿里云帮助中心

查询统计客户端的在线率、安装率。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:GetClientRatioStatistic	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
TimeStart	long	是	统计起始时间戳。单位：毫秒。	1671382800000
TimeEnd	long	是	统计结束时间戳。单位：毫秒。	1686412799999
StatisticTypes	array	否	统计类型列表。
	string	否	统计类型。 INSTALL：安装率 ONLINE：在线率	INSTALL
ResourceDirectoryAccountId	long	否	资源目录成员账号主账号 ID。说明调用 DescribeMonitorAccounts 接口可以获取该参数。	127608589417****

返回参数

名称	类型	描述	示例值
	object	请求返回参数。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
ClientInstallRatio	object	客户端安装率统计数据。
HistoryItems	object []	历史客户端安装率统计数据列表。
Vendor	long	云资产厂商。取值： 0：阿里云资产 1：云外资产 2：IDC 资产 3、4、5、7：其它云资产 8：轻量应用服务器	3
Items	object []	客户端安装率统计数据列表。
CalculateTime	long	计算时间戳。单位：毫秒。	1687759630045
AssetTotalCount	integer	资产总数。	100
InstallRatio	double	安装比率。单位：%。	80.00
InstalledAssetCount	integer	已安装客户端资产数。	80
CurrentItems	object []	当前客户端安装率统计数据列表。
Vendor	long	服务器厂商。取值： 0：阿里云资产 1：云外资产 2：IDC 资产 3、4、5、7：其它云资产 8：轻量级资产	0
Items	object []	厂商客户端安装率统计数据列表。
CalculateTime	long	计算时间戳。单位：毫秒。	1687759630045
AssetTotalCount	integer	资产总数。	100
InstallRatio	double	安装比率。单位：%。	70.00
InstalledAssetCount	integer	已安装客户端资产数。	70
ClientOnlineRatio	object	客户端在线率统计数据。
HistoryItems	object []	历史客户端在线率统计数据列表。
Vendor	long	服务器厂商。取值： 0：阿里云资产 1：云外资产 2：IDC 资产 3、4、5、7：其它云资产 8：轻量级资产	7
Items	object []	厂商历史客户端在线率统计列表。
CalculateTime	long	计算时间戳。单位：毫秒。	1687759630045
AssetInstallCount	integer	已安装客户端资产数。	50
OnlineRatio	double	在线比率。单位：%。	40.00
OnlineAssetCount	integer	在线资产数。	20
CurrentItems	object []	当前客户端在线率统计数据列表。
Vendor	long	云资产厂商。取值： 0：阿里云资产 1：云外资产 2：IDC 资产 3、4、5、7：其它云资产 8：轻量应用服务器	3
Items	object []	厂商当前客户端在线率统计列表。
CalculateTime	long	计算时间戳。单位：毫秒。	1687759630045
AssetInstallCount	integer	已安装客户端资产数。	50
OnlineRatio	double	在线比率。单位：%。	20.00
OnlineAssetCount	integer	在线资产数。	10
Dates	array	统计时间列表。
	long	统计时间。单位：毫秒。	1687104000000

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "ClientInstallRatio": {
    "HistoryItems": [
      {
        "Vendor": 3,
        "Items": [
          {
            "CalculateTime": 1687759630045,
            "AssetTotalCount": 100,
            "InstallRatio": 80,
            "InstalledAssetCount": 80
          }
        ]
      }
    ],
    "CurrentItems": [
      {
        "Vendor": 0,
        "Items": [
          {
            "CalculateTime": 1687759630045,
            "AssetTotalCount": 100,
            "InstallRatio": 70,
            "InstalledAssetCount": 70
          }
        ]
      }
    ]
  },
  "ClientOnlineRatio": {
    "HistoryItems": [
      {
        "Vendor": 7,
        "Items": [
          {
            "CalculateTime": 1687759630045,
            "AssetInstallCount": 50,
            "OnlineRatio": 40,
            "OnlineAssetCount": 20
          }
        ]
      }
    ],
    "CurrentItems": [
      {
        "Vendor": 3,
        "Items": [
          {
            "CalculateTime": 1687759630045,
            "AssetInstallCount": 50,
            "OnlineRatio": 20,
            "OnlineAssetCount": 10
          }
        ]
      }
    ]
  },
  "Dates": [
    1687104000000
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	RdCheckNoPermission	Resource directory account verification has no permission.	资源目录账号校验无权限。
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	RdCheckInnerError	Resource directory account service internal error.	资源目录账号服务内部错误。
500	ServerError	ServerError	服务故障，请稍后重试！

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

变更历史

变更时间

变更内容概要

操作

2023-07-20

OpenAPI 错误码发生变更、OpenAPI 入参发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：400
	新增错误码：500
入参	OpenAPI 入参发生变更。
	新增入参：ResourceDirectoryAccountId