Enabling/Disabling the Agent
Function
This API is used to enable or disable the agent audit function. An enabled agent collects user access information.
URI
POST /v2/{project_id}/audit/{instance_id}/agent/switch
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: 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 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 |
** Parameter description**: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. ** Restrictions**: N/A ** Value 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. (The token is the value of X-Subject-Token in the response header.) ** Restrictions**: N/A Range: Used by the IAM service to query the user token. ** Default value**: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
agent_id |
Yes |
String |
Audit agent ID. You can obtain the value from the ID field of the API for querying the agent list. |
status |
Yes |
Integer |
Agent status. The value can be:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
Operation Result
|
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: 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. |
Example Requests
/v2/{project_id}/audit/{instance_id}/agent/switch { "agent_id" : "ASWDSDSDSWEWDSDSD", "status" : 1 }
Example Responses
Status code: 200
Request succeeded.
{ "result" : "SUCCESS" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Invalid request parameter. |
403 |
Authentication failed. |
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