Updated on 2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/interposal-rules/queryInterposalRules

Scenario

This interface is invoked to query all interruption rules. The query criteria are limit (number of records on each page), page (current page number), and keyword (query keyword).

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/interposal-rules/queryInterposalRules (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

No

The value is fixed to application/json; charset=UTF-8.

2

x-app-key

String

No

App key

3

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

4

x-UserId

String

Yes

Operator ID

You can sign in to the system and go to the employee management page to view the value of userId returned by an interface.

Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

limit

Number

Yes

Number of records on each page. Pagination information.

1.2

page

Number

No

Current page number. Pagination information.

1.3

keyword

String (64)

No

Query keyword

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

data

Array [InterposalRule]

Yes

Rule set

1.2

paging

Object

Yes

Pagination information

1.2.1

total

Number

Yes

Total number of records

1.3

resultCode

String

Yes

Return code. The value 0405000 indicates success, and other values indicate failure.

1.4

resultDesc

Number

Yes

Return description

  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

  • Scenario: Query all interruption rules.

    Request header:

    x-app-key:************************************  
    X-UserID:1611917095665261978  
    Authorization:Bearer ********************************

    Request parameters:

    {
    	"limit": 10,
    	"page": 1
    }

    Response parameters:

    {
    	"data": [{
    		"score": "-1",
    		"seconds": "2",
    		"times": "3",
    		"interposal_id": "894378242138443776",
    		"name": "Interruption rule name 1"
    	}, {
    		"score": "-4",
    		"seconds": "4",
    		"times": "4",
    		"interposal_id": "922992717770788864",
    		"name": "test0611"
    	}, {
    		"score": "-4",
    		"seconds": "4",
    		"times": "4",
    		"interposal_id": "922992795956809728",
    		"name": "test0612"
    	}, {
    		"score": "-4",
    		"seconds": "4",
    		"times": "4",
    		"interposal_id": "922993405183660032",
    		"name": "test0613"
    	}],
    	"resultCode": "0405000",
    	"paging": {
    		"total": 4
    	},
    	"resultDesc": "Operation successful."
    }