Querying a Plug-in
Function
Query details about an API plug-in.
-
Pagination
-
Query by plug-in type
-
Query by plug-in scope
-
Query by plug-in ID
-
Fuzzy query by name
-
Query by integration application ID
-
query by integration application name
URI
GET /v2/{project_id}/apic/instances/{instance_id}/plugins
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. |
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 |
plugin_type |
No |
String |
Plug-in type. |
plugin_scope |
No |
String |
Plug-in scope. |
plugin_id |
No |
String |
Plug-in ID. |
plugin_name |
No |
String |
Plug-in name. Fuzzy match is supported. |
precise_search |
No |
String |
Parameter name for exact matching. Only plug-in names are supported. |
roma_app_id |
No |
String |
Integration application ID. |
roma_app_name |
No |
String |
Integration application name. |
Request 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
Parameter |
Type |
Description |
---|---|---|
size |
Integer |
Length of the returned resource list. |
total |
Long |
Number of resources that match the query conditions. |
plugins |
Array of PluginInfo objects |
Plug-in list. |
Parameter |
Type |
Description |
---|---|---|
plugin_id |
String |
Plug-in ID. |
plugin_name |
String |
Plug-in name. Enter 3 to 255 characters, starting with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
plugin_type |
String |
Plug-in type. Options:
|
plugin_scope |
String |
Plug-in scope. Options:
|
plugin_content |
String |
Plug-in definition, in JSON. Example: CorsPluginContent: cross-origin resource sharing SetRespHeadersContent: HTTP response header management KafkaLogContent: Kafka log push BreakerContent: circuit breaker RateLimitContent: request throttling ThirdAuthContent: third-party authentication Maximum: 65535 |
remark |
String |
Plug-in description. Max. 255 characters. Maximum: 255 |
create_time |
String |
Creation time. |
update_time |
String |
Update time. |
roma_app_id |
String |
Integration application ID. Valid when plugin_scope is set to app. |
roma_app_name |
String |
Name of the integration application to which the API belongs. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "total" : 1, "size" : 1, "plugins" : [ { "plugin_id" : "5b729aa252764739b3s237ef0d66dc63", "plugin_name" : "CORS plug-in.", "plugin_type" : "cors", "plugin_scope" : "global", "plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}", "remark" : "Cross-origin resource sharing.", "create_time" : "2022-11-02T12:31:23.353Z", "update_time" : "2022-11-02T12:31:23.353Z" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:plugin_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: 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 |
500 |
Internal Server Error |
Error Codes
See Error Codes.
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