Modifying the Global Switch of a Policy (to Enable/Disable the Policy for All Associated Servers)
Function
This API is used to modify the global switch of a policy to enable or disable it for all associated servers.
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
POST /v5/{project_id}/policy/switch
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 | Yes | 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 Length: 1 to 256 characters Default Value 0: default enterprise project. |
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 |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
policy_name | Yes | String | Definition Policy name. Constraints Mandatory Range Default Value N/A |
enable | Yes | Boolean | Definition Whether the global policy switch is enabled. Constraints N/A Range Default Value N/A |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Modify the global switch of a policy.
POST https://{endpoint}/v5/{project_id}/policy/switch?enterprise_project_id=all_granted_eps
{
"policy_name" : "sp_feature",
"enable" : false
} Example Responses
None
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
