DeleteAgentConfig - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:DeleteAgentConfig

delete

*All Resource

*

None

Request syntax

DELETE /api/v1/am/agent/deleteAgentConfig HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
agentId	string	No	The ID of the component associated with the configuration to be deleted.	74a86327-3170-412c-8e67-da3389ec56a9
configId	string	No	The ID of the component configuration to delete.	4d5ecf02-3d01-11f0-8c90-00163e1029af

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. `code == Success`: Authorization succeeded. Other status codes indicate that authorization failed. If authorization failed, check the `message` field for detailed error messages.	SysomOpenAPI.ServerError
data	object	The returned data.
taskId	string	The task ID.	The ID of the currently running task
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error message.	success
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "SysomOpenAPI.ServerError",
  "data": {
    "taskId": "The ID of the currently executing task"
  },
  "message": "success",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	Server error, please correct the code according to the error message

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.