huawei-cloud-api-definitions-ROMA 0.1.20240626

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]},"ThrottleApiBinding":{"properties":{"apply_time":{"description":"绑定时间","format":"date-time","type":"string"},"id":{"description":"绑定关系的ID","type":"string"},"publish_id":{"description":"API的发布记录编号","type":"string"},"scope":{"description":"策略作用域,取值如下:\n- 1:整个API\n- 2: 单个用户\n- 3:单个APP\n\n目前只支持1","enum":[1,2,3],"format":"int32","type":"integer"},"strategy_id":{"description":"流控策略的ID","type":"string"}}},"ThrottleApiBindingCreate":{"properties":{"publish_ids":{"description":"API的发布记录编号","example":["374a6d5a20c74ea182e119fce4556956","65e6fe531ac34481ba369f0bc6f22057"],"items":{"type":"string"},"type":"array"},"strategy_id":{"description":"流控策略编号","example":"0325b6712d504614986822102262695d","maxLength":65,"minLength":1,"pattern":"^[a-zA-Z0-9-_]{0,64}$","type":"string"}},"required":["strategy_id","publish_ids"]},"ThrottleApiBindingPage":{"properties":{"throttle_applys":{"description":"API与流控策略的绑定关系列表","items":{"$ref":"#/definitions/ThrottleApiBinding"},"type":"array"}}}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"34d0293794594ad9805b058614d9e1da","info_version":"v2","method":"post","name":"AssociateRequestThrottlingPolicyV2","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}/throttle-bindings":{"post":{"description":"将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。\n\n\n当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。\n\n\n为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。同一个API发布到不同的环境可以绑定不同的流控策略;一个API在发布到特定环境后只能绑定一个默认的流控策略。","operationId":"AssociateRequestThrottlingPolicyV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"绑定流控策略的请求体","in":"body","name":"AssociateRequestThrottlingPolicyV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ThrottleApiBindingCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"throttle_applys":[{"apply_time":"2020-08-03T12:25:52.257613934Z","id":"3e06ac135e18477e918060d3c59d6f6a","publish_id":"40e7162dc6b94bbbbb1a60d2a24b1b0c","scope":1,"strategy_id":"3437448ad06f4e0c91a224183116e965"}]}},"schema":{"$ref":"#/definitions/ThrottleApiBindingPage"}},"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.3005","error_msg":"Request throttling policy 3437448ad06f4e0c91a224183116e965 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"}}},"schemes":["https"],"summary":"绑定流控策略","tags":["API绑定流控策略"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":1,"x-request-examples-1":{"publish_ids":["40e7162dc6b94bbbbb1a60d2a24b1b0c"],"strategy_id":"3437448ad06f4e0c91a224183116e965"},"x-request-examples-description-1":"为API绑定指定的流控策略","x-romaconnect-mode":"huaweicloud,hybrid,on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"绑定流控策略","tags":"API绑定流控策略","uri":null,"version":"2.0"}