All Products
Search
Document Center

Security Center:GetClientRatioStatistic

Last Updated:Feb 20, 2024

Queries the installation rate and online rate of the agent.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:GetClientRatioStatisticRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TimeStartlongYes

The timestamp that specifies the beginning of the time range to collect statistics. Unit: milliseconds.

1671382800000
TimeEndlongYes

The timestamp that specifies the end of the time range to collect statistics. Unit: milliseconds.

1686412799999
StatisticTypesarrayNo

An array that consists of the details of a statistical type.

stringNo

The type of the statistics.

  • INSTALL: installation rate
  • ONLINE: online rate
INSTALL
ResourceDirectoryAccountIdlongNo

The ID of the primary account of the Resource Directory member account.

Note call the DescribeMonitorAccounts interface to obtain this parameter.
127608589417****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
ClientInstallRatioobject

The statistics on the client installation rate.

HistoryItemsobject []

The list of historical statistics on the installation rate of the client.

Vendorlong

The type of the cloud asset. Valid values:

  • 0: an asset provided by Alibaba Cloud
  • 1: a third-party cloud asset
  • 2: an asset in a data center
  • 3, 4, 5, and 7: other cloud asset
  • 8: a simple application server
3
Itemsobject []

The list of statistics on the client installation rate.

CalculateTimelong

The timestamp of the calculation. Unit: milliseconds.

1687759630045
AssetTotalCountinteger

The total number of assets.

100
InstallRatiodouble

The installation rate. Unit: %.

80.00
InstalledAssetCountinteger

The number of assets on which the client is installed.

80
CurrentItemsobject []

The list of current statistics on the installation rate of the client.

Vendorlong

The type of the server. Valid values:

  • 0: an asset provided by Alibaba Cloud
  • 1: a third-party cloud asset
  • 2: an asset in a data center
  • 3, 4, 5, and 7: other cloud asset
  • 8: a lightweight asset
0
Itemsobject []

The list of the statistics on the installation rate of the client by vendor.

CalculateTimelong

The timestamp of the calculation. Unit: milliseconds.

1687759630045
AssetTotalCountinteger

The total number of assets.

100
InstallRatiodouble

The installation rate. Unit: %.

70.00
InstalledAssetCountinteger

The number of assets on which the client is installed.

70
ClientOnlineRatioobject

The statistics on the client online rate.

HistoryItemsobject []

The list of historical statistics on the online rate of the client.

Vendorlong

The type of the server. Valid values:

  • 0: an asset provided by Alibaba Cloud
  • 1: a third-party cloud asset
  • 2: an asset in a data center
  • 3, 4, 5, and 7: other cloud asset
  • 8: a lightweight asset
7
Itemsobject []

The list of historical statistics on the online rate of the client by vendor.

CalculateTimelong

The timestamp of the calculation. Unit: milliseconds.

1687759630045
AssetInstallCountinteger

The number of assets on which the client is installed.

50
OnlineRatiodouble

The online rate. Unit: %.

40.00
OnlineAssetCountinteger

The number of online assets.

20
CurrentItemsobject []

The list of current statistics on the online rate of the client.

Vendorlong

The type of the cloud asset. Valid values:

  • 0: an asset provided by Alibaba Cloud
  • 1: a third-party cloud asset
  • 2: an asset in a data center
  • 3, 4, 5, and 7: other cloud asset
  • 8: a simple application server
3
Itemsobject []

The list of current statistics on the online rate of the client by vendor.

CalculateTimelong

The timestamp of the calculation. Unit: milliseconds.

1687759630045
AssetInstallCountinteger

The number of assets on which the client is installed.

50
OnlineRatiodouble

The online rate. Unit: %.

20.00
OnlineAssetCountinteger

The number of online assets.

10
Datesarray

The list of time when statistics were collected.

long

The time when statistics were collected. Unit: milliseconds.

1687104000000

Examples

Sample success responses

JSONformat

{
  "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
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceDirectoryAccountId