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":{"AuthorizerBase":{"properties":{"authorizer_alias_uri":{"description":"函数别名地址。\n\n当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN","example":"urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1","type":"string"},"authorizer_type":{"description":"自定义认证函数类型:\n- LD:自定义后端函数\n- FUNC:函数服务函数","enum":["LD","FUNC"],"example":"LD","type":"string"},"authorizer_uri":{"description":"函数地址。\n\n注意:使用自定义后端的函数API,API请求方法必须为POST,且API状态必须为已部署。","example":"'/test/ldapi'","type":"string"},"authorizer_version":{"description":"函数版本。\n\n当函数别名URN和函数版本同时传入时,函数版本将被忽略,只会使用函数别名URN","example":"v1","maxLength":64,"type":"string"},"identities":{"description":"认证来源","items":{"$ref":"#/definitions/Identity"},"type":"array"},"ld_api_id":{"description":"自定义后端服务ID。\n\n自定义认证函数类型为LD时必填","example":"2f808c7853804d1e8ad82ec72385b3fc","type":"string"},"name":{"description":"自定义认证的名称。\n长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。","example":"Authorizer_demo","type":"string"},"need_body":{"description":"是否发送body","example":true,"type":"boolean"},"ttl":{"description":"缓存时间","example":5,"format":"int32","type":"integer"},"type":{"description":"自定义认证类型\n\n- FRONTEND:前端\n- BACKEND:后端","enum":["FRONTEND","BACKEND"],"example":"FRONTEND","type":"string"},"user_data":{"description":"用户数据","example":"authorizer_test","type":"string"}},"required":["name","type","authorizer_type","authorizer_uri"]},"AuthorizerCreate":{"allOf":[{"$ref":"#/definitions/AuthorizerBase"}]},"AuthorizerResp":{"allOf":[{"$ref":"#/definitions/AuthorizerBase"},{"properties":{"create_time":{"description":"创建时间","format":"date-time","type":"string"},"id":{"description":"自定义认证编号","type":"string"},"roma_app_id":{"description":"自定义认证所属应用编号","type":"string"},"roma_app_name":{"description":"自定义认证所属应用名称","type":"string"}},"type":"object"}]},"Identity":{"properties":{"location":{"description":"参数位置","enum":["HEADER","QUERY"],"example":"HEADER","type":"string"},"name":{"description":"参数名称。\n\n支持数字,英文,下划线,中划线,点,且只能以数字或英文开头。","example":"header","maxLength":32,"minLength":0,"pattern":"^[a-zA-Z][a-zA-Z0-9._-]{0,31}$","type":"string"},"validation":{"description":"参数校验表达式,默认为null,不做校验","maxLength":1024,"type":"string"}},"required":["name","location"]},"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":"de4efe1e53a747bcb4d69cbacfcd194c","info_version":"v2","method":"post","name":"CreateCustomAuthorizerV2","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}/authorizers":{"post":{"description":"创建自定义认证","operationId":"CreateCustomAuthorizerV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"创建自定义认证请求体","in":"body","name":"CreateCustomAuthorizerV2RequestBody","required":true,"schema":{"$ref":"#/definitions/AuthorizerCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"authorizer_alias_uri":"","authorizer_type":"LD","authorizer_uri":"/test","authorizer_version":"","create_time":"2020-09-23T02:32:10.354159293Z","id":"0d982c1ac3da493dae47627b6439fc5c","identities":[{"location":"HEADER","name":"header"}],"name":"Authorizer_demo","need_body":true,"ttl":5,"type":"FRONTEND"}},"schema":{"$ref":"#/definitions/AuthorizerResp"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:type. 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.3019","error_msg":"The function URN 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":"创建自定义认证","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":1,"x-request-examples-1":{"authorizer_alias_uri":"","authorizer_type":"LD","authorizer_uri":"/test","authorizer_version":"","identities":[{"location":"HEADER","name":"header"}],"ld_api_id":"6f8e61317e4e4fbf8e8220cc19fcced9","name":"Authorizer_demo","ttl":5,"type":"FRONTEND"},"x-request-examples-description-1":"创建一个自定义认证,认证类型为前端认证,函数类型为自定义后端函数,认证来源使用Header参数","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":"自定义认证管理","uri":null,"version":"2.0"}