POST /CCSQM/rest/ccisqm/v1/speedrule/querySpeedRules
Scenario
This interface is invoked to query speed rules in pagination mode. The query criteria are page (current page number), limit (number of records on each page), and keyword (query keyword).
Method
POST
URI
https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/speedrule/querySpeedRules (For example, the domain name is service.besclouds.com.)
Request Description
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 |
No |
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. |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
page |
Number |
No |
Current page number. Pagination information. |
1.2 |
limit |
Number |
Yes |
Number of records on each page. Pagination information. |
1.3 |
keyword |
String |
No |
Query keyword |
Response Description
- Status code: 200
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
data |
Array [Object] |
No |
Rule set |
1.1.1 |
name |
String |
No |
Speed rule name |
1.1.2 |
score |
Number |
No |
Points deducted due to violation. The value ranges from 0 to 100. |
1.1.3 |
min |
Number |
No |
Minimum speed, which is the minimum number of words per minute. The value ranges from 1 to 220. |
1.1.4 |
max |
Number |
No |
Maximum speed, which is the maximum number of words per minute. The value ranges from 1 to 2147483647. |
1.1.5 |
speed_id |
String |
No |
Speed rule ID |
1.2 |
paging |
Object |
Yes |
Pagination information |
1.2.1 |
total |
Number |
Yes |
Total number of records |
1.3 |
resultCode |
String |
No |
Return code. The value 0405000 indicates success, and other values indicate failure. |
1.4 |
resultDesc |
String |
No |
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 speed rules.
x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979
Request parameters:
{ "page": 1, "limit": 10, "keyword": "APIcs" }
Response parameters:
{ "data": [{ "score": -3, "min": 100, "max": "150", "name": "rule", "speed_id": "925095745760006144" }], "resultCode": "0405000", "paging": { "total": 1 }, "resultDesc": "Operation successful." }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot