Lens
GET Account stats#
Get all account stats.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/lens |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "totalStorage": 0, "objectCount": 0, "averageObjectSize": 0, "activeBuckets": 0, "topBuckets": [ { "bucket": "string", "totalStorage": 0, "objectCount": 0, "percentageOfTotal": 0, "averageObjectSize": 0 } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of results for account stats | |
| totalStorage | int | 0 | Returns the number of total storage usage |
| objectCount | int | 0 | Returns the number of objects in storage |
| averageObjectSize | int | 0 | Returns the avarage size of object in storage |
| activeBuckets | int | 0 | Returns the number of active buckets |
| topBuckets | array [object] | Returns the object of top buckets | |
| bucket | string | "string" | Returns the top bucket |
| totalStorage | string | "string" | Returns the number of total usage of the bucket |
| objectCount | long | 1234 | Returns the number of object into bucket |
| percentageOfTotal | string | "string" | Returns the percentage of total usage in bucket |
| averageObjectSize | long | 1234 | Returns the avarage usage size of objects in bucket |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down
GET Storage time stats#
Get all storage time stats over time.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/time-lens |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Period | No | int | 1, 17, 14, 30, 60 | Enter period time |
| UsageType | No | string | "string" | Enter the usage type |
| Bucket | No | string | "string" | Enter the bucket name |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "timestamp": "2022-04-01T08:54:23.484Z", "datapoint": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of results for storage stats over time | |
| timestamp | DateTime | "2022-04-01T08:54:23.484Z" | Returns the date time of the stroage stats over time |
| datapoint | int | 0 | Returns the number of data point |
| resultInfo | array [object] | Returns an object of lens | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down
GET Gateway stats#
Get gateway stats over time.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/rgw-lens |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Period | No | int | 1, 17, 14, 30, 60 | Enter period time |
| Category | No | string | "string" | Enter the category |
| Bucket | No | string | "string" | Enter the bucket name |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "timestamp": "2022-04-01T08:54:23.484Z", "datapoint": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Return a list of results for storage stats over time | |
| timestamp | DateTime | "2022-04-01T08:54:23.484Z" | Returns the date time of the gateway stats over time |
| datapoint | int | 0 | Returns the number of data point |
| resultInfo | array [object] | Returns an object of lens | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down
GET Gateway categories#
Get all account stats.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/lens |
| Headers | Authorization |
| Parameters | version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | Guid | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the id of project |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Project Id | Yes | string($Guid) | f5faa2e3-316b-4dd0-8f4d-ab41f6f71bd6 | Shows the project id of API |
| Period | No | int | 1, 17, 14, 30, 60 | Enter period time |
| Category | No | string | "string" | Enter the category |
| Bucket | No | string | "string" | Enter the bucket name |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ "string" ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | string | "string" | Returns a gateway category |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors#
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code: 401 Unauthorized
HTTP Status Code: 403 Forbidden
HTTP Status Code: 404 If the service is down