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":{"ApiCheckInfo":{"properties":{"api_id":{"description":"需要对比的API ID","type":"string"},"group_id":{"description":"分组ID。\n\n校验分组下API定义是否重复时必填","type":"string"},"match_mode":{"description":"API的匹配方式\n- SWA:前缀匹配\n- NORMAL:正常匹配(绝对匹配)\n\ntype = path时必填","enum":["SWA","NORMAL"],"example":"NORMAL","type":"string"},"name":{"description":"API名称。\n\ntype = name时必填","type":"string"},"req_method":{"description":"请求方式。\n\ntype = path时必填","enum":["GET","POST","PUT","DELETE","HEAD","PATCH","OPTIONS","ANY"],"example":"GET","type":"string"},"req_uri":{"description":"API的访问地址。\n\ntype = path时必填","type":"string"},"roma_app_id":{"description":"集成应用ID。\n\n校验应用下API定义是否重复时必填","type":"string"}}},"ApiCheckInfoV2":{"allOf":[{"$ref":"#/definitions/ApiCheckInfo"},{"properties":{"type":{"description":"校验类型:\n  - path:路径类型\n  - name:名称类型","enum":["path","name"],"example":"path","type":"string"}},"type":"object"}],"required":["type"]},"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":"fc0906bb9b3e4d7ea29ae9d7dc992345","info_version":"v2","method":"post","name":"CheckApisV2","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/check":{"post":{"description":"校验API定义。校验API的路径或名称是否已存在","operationId":"CheckApisV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"校验API定义的请求体","in":"body","name":"CheckApisV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiCheckInfoV2"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.3202","error_msg":"The API name already exists, api_name:api_demo"}},"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.3030","error_msg":"The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"}},"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":"校验API定义","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":14,"x-request-examples-1":{"name":"api_demo","type":"name"},"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":"校验API定义","tags":"API管理","uri":null,"version":"2.0"}