修改
场景描述
调用该接口修改休息原因码。
接口方法
该接口仅支持PUT方法,不支持POST、GET和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/vdn/restcause?causeId=5
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
causeId |
number |
True |
休息原因码编号。 取值的类型为整数,取值范围为1-255。 |
日志中的方法名
modifyRestCause
请求消息
- 消息头
表2 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
- 消息体
表3 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
causeNo
number
False
休息原因码。
取值范围为1-255。
2
causeDesc
string
False
休息原因码描述。如果选择该项,不能为空值,即不能将休息原因置为空。
最大长度为100。
响应消息
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
1 |
message |
string |
描述 |
|
2 |
retcode |
string |
错误码。取值如下:
|
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
{ "causeNo": "5", "causeDesc": "rest" } - 响应参数
{ "message": "success", "retcode": "0" }