{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiOperPluginInfo":{"properties":{"env_id":{"description":"绑定API的环境编码。","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","type":"string"},"plugin_ids":{"description":"绑定的插件编码列表。","example":["5b729aa252764739b3s237ef0d66dc63"],"items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["env_id","plugin_ids"]},"PluginApiAttachInfo":{"properties":{"api_id":{"description":"绑定的API编码。","example":"8aa097b00e9843efabc9c593d11b769d","type":"string"},"api_name":{"description":"API的名称","example":"测试API","type":"string"},"attached_time":{"description":"绑定时间。","example":"2020-11-02T12:31:23.353Z","format":"date-time","type":"string"},"env_id":{"description":"绑定API的环境编码。","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","type":"string"},"env_name":{"description":"api授权绑定的环境名称","example":"RELEASE","type":"string"},"plugin_attach_id":{"description":"插件绑定编码。","example":"8aa097b00e9843efacb9c593d11b769e","type":"string"},"plugin_id":{"description":"插件编码。","example":"5b729aa252764739b3s237ef0d66dc63","type":"string"},"plugin_name":{"description":"插件名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3-255字符\n> 中文字符必须为UTF-8或者unicode编码。","example":"跨域插件","pattern":"^([a-zA-Z]|[\\u4e00-\\u9fa5])([a-zA-Z0-9_]|[\\u4e00-\\u9fa5]){2,254}$","type":"string"},"plugin_scope":{"description":"插件可见范围\n- global:全局可见\n- app:集成应用可见","enum":["global","app"],"example":"global","type":"string"},"plugin_type":{"description":"插件类型\n- cors:跨域资源共享\n- set_resp_headers:HTTP响应头管理\n- kafka_log:Kafka日志推送\n- breaker:断路器\n- rate_limit: 流量控制\n- third_auth: 第三方认证","enum":["cors","set_resp_headers","kafka_log","breaker","rate_limit","third_auth"],"example":"cors","type":"string"}}},"PluginApiAttachResult":{"properties":{"attached_plugins":{"description":"绑定插件信息列表。","items":{"$ref":"#/definitions/PluginApiAttachInfo"},"type":"array"}}},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"ad8492beca7a4d2392113f022a84fb51","info_version":"v2","method":"post","name":"AttachPluginToApi","parameters":{"apic_instance_id":{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string","x-example":"f0fa1789-3b76-433b-a787-9892951c620e"},"apic_project_id":{"description":"项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。","in":"path","name":"project_id","required":true,"type":"string","x-example":"73d69ae0cfcf460190522d06b60f05ad"},"apic_x_auth_token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2/{project_id}/apic/instances/{instance_id}/apis/{api_id}/plugins/attach":{"post":{"description":"绑定插件到API上。\n- 只能选择发布状态的API\n- 绑定以后及时生效\n- 修改插件后及时生效\n- 相同类型的插件只能绑定一个,原来已经绑定的同类型插件,会直接覆盖。","operationId":"AttachPluginToApi","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"API编号","in":"path","name":"api_id","required":true,"type":"string","x-example":"8aa097b00e9843efabc9c593d11b769d"},{"description":"插件绑定API请求体","in":"body","name":"AttachPluginToApiRequestBody","required":true,"schema":{"$ref":"#/definitions/ApiOperPluginInfo"}}],"responses":{"201":{"description":"OK","examples":{"application/json":{"attached_plugins":[{"api_id":"8aa097b00e9843efabc9c593d11b769d","api_name":"api_name","attached_time":"2022-11-02T12:31:23.353Z","env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID","env_name":"RELEASE","plugin_attach_id":"8aa097b00e9843efacb9c593d11b769e","plugin_id":"5b729aa252764739b3s237ef0d66dc63","plugin_name":"跨域插件","plugin_scope":"global","plugin_type":"cors"}]}},"schema":{"$ref":"#/definitions/PluginApiAttachResult"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2012","error_msg":"Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"APIG.1002","error_msg":"Incorrect token or token resolution failed"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"APIG.1005","error_msg":"No permissions to request this method"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"404":{"description":"Not Found","examples":{"application/json":{"error_code":"APIG.3068","error_msg":"Plugin b294018ee0554156a875b3513e02e5b9 does not exist"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"summary":"API绑定插件","tags":["插件管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":6,"x-request-examples-1":{"env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID","plugin_ids":["5b729aa252764739b3s237ef0d66dc63"]},"x-request-examples-description-1":"为指定API绑定插件","x-romaconnect-mode":"on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"API绑定插件","tags":"插件管理","uri":null,"version":"2.0"}