修改规则状态
功能介绍
应用服务器可调用此接口修改物联网平台中指定规则的状态，激活或者去激活规则。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v5/iot/{project_id}/rules/{rule_id}/status
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
rule_id |
是 |
String |
参数说明：规则Id。 取值范围：长度不超过32，只允许字母、数字的组合。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
status |
是 |
String |
参数说明：规则的激活状态。 取值范围：
|
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
status |
String |
参数说明：规则的激活状态。 取值范围：
|
请求示例
修改规则状态，修改状态为激活。
PUT https://{endpoint}/v5/iot/{project_id}/rules/{rule_id}/status
{
"status" : "active"
}
响应示例
状态码： 200
OK
{
"status" : "active"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。
