调用ListWarningConfig获取预警配置列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListWarningConfig

系统规定参数。取值:ListWarningConfig。

JsonStr String {"pageNumber":1,"pageSize":10}

完整Json字符串信息,具体内容参见下方详细信息。

入参说明

属性

值类型

是否必须

说明

pageSize

Integer

每页条数。

pageNumber

Integer

当前页。

configName

String

配置名称。

ruleName

String

规则名称。

返回数据

名称 类型 示例值 描述
Code String 200

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

Data Array

详细返回数据。

WarningConfigInfo
Channels Array

订阅推送设置。

Channel
Type Integer 0

订阅推送类型,可取值:0(钉钉);1(回调) 。

Url String oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3ca

推送地址url。

ConfigId Long 32

预警配置ID。

ConfigName String 投诉预警

预警配置名称。

CreateTime String 2019-10-29T15:30Z

创建时间。

RidList List [5767,5647]

预警配置所设置的规则的ID集合。

RuleList Array

预警配置所设置的规则列表。

WarningRule
Rid Long 33452

规则ID。

RuleName String 客户可能要投诉

规则名称。

Status Integer 1

启用状态,可能值:0(未启用);1(启用) 。

UpdateTime String 2019-10-29T17:24Z

最后更新时间。

Message String successful

出错时表示出错详情,成功时为successful。

RequestId String 82C91484-B2D5-4D2A-A21F-A6D73F4D55C6

请求ID。

Success Boolean true

请求是否成功,调用方可根据此字段来判断请求是否成功:true表示成功;false/null表示失败。

示例

请求示例

http(s)://[Endpoint]/?Action=ListWarningConfig
&<公共请求参数>

正常返回示例

XML 格式

<ListWarningConfigResponse>
      <Message>successful</Message>
      <RequestId>3137EFD8-7173-42E1-A85C-D4EC9EB98DF8</RequestId>
      <Data>
            <WarningConfigInfo>
                  <Status>0</Status>
                  <RuleList>
                        <WarningRule>
                              <Rid>5818</Rid>
                              <RuleName>1111111</RuleName>
                        </WarningRule>
                        <WarningRule>
                              <Rid>5819</Rid>
                              <RuleName>4444444</RuleName>
                        </WarningRule>
                  </RuleList>
                  <ConfigName>test01</ConfigName>
                  <CreateTime>2019-10-29T15:30Z</CreateTime>
                  <UpdateTime>2019-10-29T17:24Z</UpdateTime>
                  <RidList>
                        <RidList>5819</RidList>
                        <RidList>5818</RidList>
                  </RidList>
                  <ConfigId>16</ConfigId>
                  <Channels>
                        <Channel>
                              <Type>0</Type>
                              <Url>oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3cafbd90cdb91532fd2b6b0c796ab08b5c4dca795ee7b60</Url>
                        </Channel>
                  </Channels>
            </WarningConfigInfo>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</ListWarningConfigResponse>

JSON 格式

{
    "Message":"successful",
    "RequestId":"3137EFD8-7173-42E1-A85C-D4EC9EB98DF8",
    "Data":{
        "WarningConfigInfo":[
            {
                "Status":0,
                "RuleList":{
                    "WarningRule":[
                        {
                            "Rid":5818,
                            "RuleName":"1111111"
                        },
                        {
                            "Rid":5819,
                            "RuleName":"4444444"
                        }
                    ]
                },
                "ConfigName":"test01",
                "CreateTime":"2019-10-29T15:30Z",
                "UpdateTime":"2019-10-29T17:24Z",
                "RidList":{
                    "RidList":[
                        5819,
                        5818
                    ]
                },
                "ConfigId":16,
                "Channels":{
                    "Channel":[
                        {
                            "Type":0,
                            "Url":"oapi.dingtalk.com/robot/send?access_token=c55628f700eb9ad2a3cafbd90cdb91532fd2b6b0c796ab08b5c4dca795ee7b60"
                        }
                    ]
                }
            }
        ]
    },
    "Code":"200",
    "Success":true
}

错误码

访问错误中心查看更多错误码。