Help Center/ ROMA Connect/ API Reference (ME-Abu Dhabi Region)/ APIC APIs/ Excluded Request Throttling Configuration/ Querying Excluded Request Throttling Configurations

Updated on 2022-12-05 GMT+08:00

View PDF

Querying Excluded Request Throttling Configurations

Function

This API is used to query all excluded configurations of a request throttling policy.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/throttles/{throttle_id}/throttle-specials

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID.
throttle_id	Yes	String	ID of a request throttle policy.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Long	Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0. Default: 0
limit	No	Integer	Number of items displayed on each page. Minimum: 1 Maximum: 500 Default: 20
object_type	No	String	Object type, which can be APP or USER.
app_name	No	String	Name of an excluded app.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
size	Integer	Length of the returned resource list.
total	Long	Number of resources that match the query conditions.
throttle_specials	Array of ThrottleSpecialInfo objects	List of excluded configurations.

**Table 5** ThrottleSpecialInfo
Parameter	Type	Description
id	String	Excluded request throttling configuration ID.
call_limits	Integer	Maximum number of times the excluded object can access an API within the throttling period.
apply_time	String	Time when the excluded request throttling configuration is created.
app_name	String	Name of the app to which the excluded request throttling configuration applies.
app_id	String	ID of the app to which the excluded request throttling configuration applies.
object_id	String	ID of an object specified in the excluded request throttling configuration.
object_type	String	Excluded object type, which can be APP or USER.
object_name	String	Name of an app or a tenant to which the excluded request throttling configuration applies.
throttle_id	String	Request throttling policy ID.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "throttle_specials" : [ {
    "call_limits" : 200,
    "app_name" : "app_demo",
    "object_name" : "app_demo",
    "object_id" : "356de8eb7a8742168586e5daf5339965",
    "throttle_id" : "3437448ad06f4e0c91a224183116e965",
    "apply_time" : "2020-08-04T02:40:56Z",
    "id" : "a3e9ff8db55544ed9db91d8b048770c0",
    "app_id" : "356de8eb7a8742168586e5daf5339965",
    "object_type" : "APP"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3005",
  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Excluded Request Throttling Configuration

Previous topic: Deleting an Excluded Request Throttling Configuration

Next topic: Signature Key Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot