删除agent- DeleteAgent
功能介绍
删除agent。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
apm:application:deleteInstance
Write
-
g:EnterpriseProjectId
apm:apm2BusinessInstance:delete
-
URI
POST /v1/apm2/openapi/apm-service/agent-mgr/delete-agent
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
x-business-id |
是 |
Long |
应用id。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_list |
是 |
Array of integers |
实例列表。 |
|
region |
是 |
String |
region英文名称。 |
|
business_id |
是 |
Long |
应用id。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
delete_status |
Integer |
删除状态,0表示成功,1表示失败。 |
请求示例
删除应用下的离线Agent实例,其中应用ID为1,Agent实例ID为1096
/v1/apm2/openapi/apm-service/agent-mgr/delete-agent
{
"instance_list" : [ 1096 ],
"region" : "xx-xxxx-xxx",
"business_id" : 1
}
响应示例
状态码: 200
OK,请求响应成功。
{
"delete_status" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK,请求响应成功。 |
|
400 |
Bad Request,语义或参数有误。 |
|
401 |
Unauthorized,没有权限。 |
|
403 |
Forbidden,禁止访问。 |
|
404 |
Not Found,没有找到要请求的资源。 |
错误码
请参见错误码。