Binding a Plug-in to an API
Function
This API is used to bind a plug-in to APIs.
-
Only published APIs can be bound with plug-ins.
-
Plug-ins take effect immediately after binding.
-
Plug-ins take effect immediately after being modified.
-
An API can be bound with only one plug-in of the same type.
URI
POST /v2/{project_id}/apic/instances/{instance_id}/plugins/{plugin_id}/attach
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. |
plugin_id |
Yes |
String |
Plug-in ID. |
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). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
env_id |
Yes |
String |
ID of the environment for API calling authorization. |
api_ids |
Yes |
Array of strings |
Bound API IDs. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
attached_plugins |
Array of PluginApiAttachInfo objects |
Bound plug-ins. |
Parameter |
Type |
Description |
---|---|---|
plugin_attach_id |
String |
Plug-in binding ID. |
plugin_id |
String |
Plug-in ID. |
plugin_name |
String |
Plug-in name. Enter 3 to 255 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
NOTE:
Chinese characters must be in UTF-8 or Unicode format. |
plugin_type |
String |
Plug-in type.
|
plugin_scope |
String |
Plug-in scope. Options:
|
env_id |
String |
ID of the environment for API calling authorization. |
env_name |
String |
Name of the environment for API calling authorization. |
api_id |
String |
Bound API ID. |
api_name |
String |
API name. |
attached_time |
String |
Time when the API is bound. |
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: 404
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
Bind a specified plug-in to a published API.
{ "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "api_ids" : [ "8aa097b00e9843efabc9c593d11b769d" ] }
Example Responses
Status code: 201
OK
{ "attached_plugins" : [ { "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e", "plugin_id" : "5b729aa252764739b3s237ef0d66dc63", "plugin_name" : "CORS plug-in.", "plugin_type" : "cors", "plugin_scope" : "global", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "api_id" : "8aa097b00e9843efabc9c593d11b769d", "api_name" : "api_name", "attached_time" : "2022-11-02T12:31:23.353Z" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. 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.3068", "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 does not exist" }
Status code: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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