
# 更改实例的采集状态 - ChangeAgentStatus
#### 功能介绍
改变指定实例的采集状态：开启和关闭。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-apm/apm_04_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apm/apm_04_0021.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                            | 访问级别  | 资源类型（\*为必须） | 条件键                   | 别名                              | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | apm:application:updateInstance | Write | -           | g:EnterpriseProjectId | apm:apm2BusinessInstance:update | -      |
     
  
 
#### URI
POST /v1/apm2/openapi/apm-service/agent-mgr/change-status
#### 请求参数
表1请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                |
|:---|:---|:---|:---|
| x-business-id | 是    | Long   | 应用id。             |
| X-Auth-Token  | 是    | String | 从IAM服务获取的用户Token。 |
   
表2请求Body参数 
| 参数            | 是否必选 | 参数类型              | 描述                          |
|:---|:---|:---|:---|
| instance_list | 是    | Array of integers | 探针实例id列表。                   |
| target_status | 是    | Integer           | 期望探针改变后的状态，0或1。0表示启用，1表示停用。 |
| region        | 是    | String            | 探针所在的区域。                    |
| env_id        | 否    | Long              | 探针所属环境的id。                  |
   
#### 响应参数
**状态码： 200**
表3响应Body参数 
| 参数   | 参数类型   | 描述          |
|:---|:---|:---|
| flag | String | 返回结果ok表示成功。 |
   
#### 请求示例
将实例ID为1097的采集状态修改为停止。
```
/v1/apm2/openapi/apm-service/agent-mgr/change-status
{
  "instance_list" : [ 1097 ],
  "target_status" : 1,
  "region" : "xx-xxxx-xxx"
}
```
#### 响应示例
**状态码： 200**
OK，请求响应成功。
```
{
  "flag": "ok"
}
```
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 200 | OK，请求响应成功。            |
| 400 | Bad Request，语义或参数有误。  |
| 401 | Unauthorized，没有权限。    |
| 403 | Forbidden，禁止访问。       |
| 404 | Not Found，没有找到要请求的资源。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-apm/ErrorCode.html)。
