Obtaining the log retention time configuration of the audit instance
Function
Obtaining the log retention time configuration of the audit instance
URI
GET /v1/{project_id}/audit/{instance_id}/settings/common-settings
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | ** Parameter description**: Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. ** Restrictions**: N/A ** Value range**: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. ** Default value**: N/A |
| instance_id | Yes | String | Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. ** Restrictions**: N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. ** Default value**: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition: User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A Value range: You can obtain the value by calling the IAM API used to query a user token. Default value: N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| log_retention | log_retention object | Log Retention Settings |
| data_usage_limit | Integer | Disk quota for audit log storage. |
| Parameter | Type | Description |
|---|---|---|
| retention_days | Integer | Configured audit log retention period. |
| range_days_min | Integer | Minimum allowed retention period for audit logs. |
| range_days_max | Integer | Maximum allowed retention period for audit logs. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error Codes |
| error_msg | String | PDP5 error information |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5 authentication exception information |
| encoded_authorization_message | String | PDP5 authentication exception information |
| error_code | String | Error Codes |
| error_msg | String | Error message. |
Example Requests
/v1/{project_id}/audit/{instance_id}/settings/common-settings Example Responses
Status code: 200
OK
{
"log_retention" : {
"retention_days" : 180,
"range_days_min" : 30,
"range_days_max" : 1800
},
"data_usage_limit" : 80
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Invalid request parameter. |
| 401 | Unauthorized |
| 403 | Authentication failed. |
| 500 | Server error. |
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