Queries notification policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDispatchRule

The operation that you want to perform. Set the value to ListDispatchRule.

RegionId String Yes cn-hangzhou

The ID of the region.

Name String No Prod

The name of the notification policy to be queried. Fuzzy match is supported.

System Boolean No true
  • The type of notification policies to be queried. Valid values: false: notification policies created in Application Real-Time Monitoring Service (ARMS). This is the default value.
  • true: notification policies created in an external system.
    Note You cannot use the ARMS console to modify the dispatch rules of a notification policy that is created in an external system.

Response parameters

Parameter Type Example Description
DispatchRules Array of DispatchRule

The struct returned.

Name String Prod

The name of the notification policy.

RuleId Long 10282

The ID of the notification policy.

State String true

Indicates whether the notification policy is enabled.

  • true: The notification policy is enabled.
  • false: The notification policy is disabled.
RequestId String 34ED024E-9E31-434A-9E4E-D9D15C3****

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDispatchRule
&RegionId=cn-hangzhou
&<Common request parameters>|

Sample success responses

XML format 

<ListDispatchRuleResponse>
  <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****	</RequestId>
  <DispatchRules>
        <State>true</State>
        <RuleId>10282</RuleId>
        <Name>Prod</Name>
  </DispatchRules>
</ListDispatchRuleResponse>

JSON format 

{
    "RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3****",
    "DispatchRules": {
        "State": true,
        "RuleId": 10282,
        "Name": "Prod"
    }
}