Adding an Audit Database Agent
Function
Adding an Audit Database Agent
URI
POST /v3/{project_id}/audit/{instance_id}/agents
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 |
** Parameter description**: User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. ** Restrictions**: N/A ** Value range**: Used by the IAM service to query the user token. ** Default value**: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
db_id |
Yes |
String |
Database ID, which can be obtained from the ID field of the API for querying the database list. |
mode |
Yes |
Integer |
Mode
|
agent_id |
No |
String |
Mandatory when an existing agent is selected |
agent_type |
Yes |
String |
Agent type. The value can be:
|
agent_os |
Yes |
String |
Agent OS type. The value can be:
|
agent_ip |
No |
String |
Agent IP address. This is mandatory when node type is set to Application. |
agent_nic |
No |
String |
Name of the agent audit NIC |
cpu_threshold |
No |
Integer |
CPU threshold |
mem_threshold |
No |
Integer |
Memory Threshold |
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. |
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
/v3/{project_id}/audit/{instance_id}/agents { "db_id" : "Gadr-Y4B51p4J06s5s5B", "mode" : 0, "agent_type" : "DB", "agent_os" : "LINUX64_X86", "cpu_threshold" : 80, "mem_threshold" : 80 }
Example Responses
Status code: 200
Success
{ "result" : "SUCCESS" }
Status Codes
Status Code |
Description |
---|---|
200 |
Success |
400 |
Failed |
403 |
Authorization 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