Skip to main content

Return S3 Vault telemetry

Select

SaaS
Customer Managed

Request trelemetry report for S3 Vault

Request Body
  • rangeUTC object

    Time range is for time related token rule values to specify from and to time in unix timestamp format.

  • fromTime string

    From time value in unix timestamp format

  • toTime string

    To time value in unix timestamp format

  • storeFilter Client entity[]

    List of S3 Vault clients to include into report

  • clientId int32 required

    Client ID

  • clientName string

    Client Name

  • endpointFilter Client entity[]

    List of S3 endpoints to include into report

  • clientId int32 required

    Client ID

  • clientName string

    Client Name

  • userFilter User or group entity[]

    List of users or groups to include into report

  • userId int32

    User ID

  • userGroupId int32

    Group ID

Responses

Result


Schema
  • errorCode int32
  • errorString string

    Error message

  • operationId undefined[]

    Report record for each operation (PUT,GET,HEAD,BROWSE). The activeUserId and activeUserBytes show most active user.

  • id int32

    Unique type id

  • name string

    Operation description

  • requestCount int64

    Total number of requests of this opertion type

  • totalSize int64

    Total size of data requested with this opertion type

  • averageSize int64

    Average size of request of this opertion type

  • lastRequestTime string

    Last time the request of this opertion type was received

  • throughputPerSec float

    Average throughput

  • activeUserId User entity
  • userId int32

    User ID

  • __type__ int32

    must be set to 13

  • activeUserBytes int64

    Total size of data requested by most active user

POST /v4/cvs3telemetry    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{
"rangeUTC": {
"fromTime": "string",
"toTime": "string"
},
"storeFilter": [
{
"clientId": 0,
"clientName": "string"
}
],
"endpointFilter": [
{
"clientId": 0,
"clientName": "string"
}
],
"userFilter": [
{
"userId": 0,
"userGroupId": 0
}
]
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Telemetry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"rangeUTC": {
"fromTime": "string",
"toTime": "string"
},
"storeFilter": [
{
"clientId": 0,
"clientName": "string"
}
],
"endpointFilter": [
{
"clientId": 0,
"clientName": "string"
}
],
"userFilter": [
{
"userId": 0,
"userGroupId": 0
}
]
}'