Querying Container WTP Statistics
Function
This API is used to query container WTP statistics.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v5/{project_id}/webtamper/statistics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
|
begin_time |
No |
Long |
Definition Start time, which is a 13-digit timestamp. Constraints The value must be earlier than or equal to end_time. If end_time is not specified, the current time is used as the query time by default. Range The value ranges from 0 to 9223372036854775807 (UTC time, starting from 1970-01-01 00:00:00). Default Value N/A |
|
end_time |
No |
Long |
Definition End time, which is a 13-digit timestamp. Constraints The value must be greater than or equal to begin_time. If begin_time is not specified, the query starts from timestamp 0. Range The value ranges from 0 to 9223372036854775807 (UTC time, starting from 1970-01-01 00:00:00). Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
protect_failed_nums |
Integer |
Number of protection failures. |
|
redundant_nums |
Integer |
Number of redundant protection quotas. |
|
unprotect_nums |
Integer |
Number of unprotected assets. |
|
protected_nums |
Integer |
Number of protected assets. |
|
protect_total_nums |
Integer |
Total number of protected assets. |
|
protected_event_nums |
Integer |
Number of protection events. |
Example Requests
GET https://{endpoint}/v5/{project_id}/webtamper/statistics?enterprise_project_id=all_granted_eps
Example Responses
Status code: 200
Request succeeded.
{
"protect_failed_nums" : 1,
"redundant_nums" : 2,
"protected_event_nums" : 3,
"unprotect_nums" : 2,
"protect_total_nums" : 12,
"protected_nums" : 2
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot