Querying the Operation Protection Policy¶
Function¶
This API is used to query the operation protection policy.
URI¶
GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policy
Parameter | Mandatory | Type | Description |
---|---|---|---|
domain_id | Yes | String | Domain ID. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | Token with Security Administrator permissions. |
Response Parameters¶
Parameter | Type | Description |
---|---|---|
object | Operation protection policy. |
Parameter | Type | Description |
---|---|---|
operation_protection | Boolean | Indicates whether operation protection has been enabled. The value can be true or false. |
Example Request¶
GET https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policy
Example Response¶
Status code: 200
The request is successful.
{
"protect_policy" : {
"operation_protection" : false
}
}
Status code: 403
Access denied.
Example 1
{
"error_msg" : "You are not authorized to perform the requested action.",
"error_code" : "IAM.0002"
}
Example 2
{
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
"error_code" : "IAM.0003"
}
Status code: 404
The requested resource cannot be found.
{
"error_msg" : "Could not find %(target)s: %(target_id)s.",
"error_code" : "IAM.0004"
}
Status code: 500
Internal server error.
{
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
"error_code" : "IAM.0006"
}
Status Codes¶
Status Code | Description |
---|---|
200 | The request is successful. |
401 | Authentication failed. |
403 | Access denied. |
404 | The requested resource cannot be found. |
500 | Internal server error. |