{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiAuthCreate":{"properties":{"api_ids":{"description":"API的编号列表。","example":["8aa097b00e9843efabc9c593d11b769d"],"items":{"type":"string"},"type":"array"},"app_ids":{"description":"APP的编号列表","example":["f8c6ea150d1b4c5bbd4b911610bd3b3e"],"items":{"type":"string"},"type":"array"},"auth_blacklist":{"description":"绿色通道授权黑名单。\n\nauth_tunnel = GREEN时生效","items":{"type":"string"},"type":"array"},"auth_tunnel":{"default":"NORMAL","description":"授权通道类型:\n- GREEN:绿色通道\n- NORMAL:非绿色通道\n\n实例开启green_tunnel特性时可以开启绿色通道,此字段不填默认为不使用绿色通道","example":"GREEN","type":"string"},"auth_whitelist":{"description":"绿色通道授权白名单。\n\n允许白名单中的IP不使用认证信息访问,auth_tunnel = GREEN时生效","items":{"type":"string"},"type":"array"},"env_id":{"description":"需要授权的环境编号","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","maxLength":65,"minLength":1,"pattern":"^[a-zA-Z0-9-_]{0,64}$","type":"string"},"visit_params":{"description":"访问参数列表。","items":{"$ref":"#/definitions/ApiAuthVisitParam"},"type":"array"}},"required":["api_ids","app_ids","env_id"]},"ApiAuthRelations":{"properties":{"api_id":{"description":"API编号","type":"string"},"app_id":{"description":"APP编号","type":"string"},"auth_blacklist":{"description":"绿色通道授权黑名单","items":{"type":"string"},"type":"array"},"auth_result":{"$ref":"#/definitions/AuthResult","description":"授权结果"},"auth_role":{"description":"授权者\n- PROVIDER:API提供者授权\n- CONSUMER:API消费者授权","enum":["PROVIDER","CONSUMER"],"type":"string"},"auth_time":{"description":"授权时间","format":"date-time","type":"string"},"auth_tunnel":{"default":"NORMAL","description":"授权通道类型:\n- GREEN:绿色通道\n- NORMAL:非绿色通道\n\n此字段不填默认为不使用绿色通道","example":"GREEN","type":"string"},"auth_whitelist":{"description":"绿色通道授权白名单。\n\n允许白名单中的IP不使用认证信息访问","items":{"type":"string"},"type":"array"},"id":{"description":"授权关系编号","type":"string"},"visit_params":{"description":"访问参数。","type":"string"}}},"ApiAuthResult":{"properties":{"auths":{"description":"API与APP的授权关系列表","items":{"$ref":"#/definitions/ApiAuthRelations"},"type":"array"}}},"ApiAuthVisitParam":{"properties":{"api_id":{"description":"需要授权的API编号","type":"string"},"app_id":{"description":"需要授权的APP编号","type":"string"},"visit_param":{"description":"访问参数\n\n支持英文、数字、下划线和中划线,多个参数以英文格式下的逗号隔开,单个参数须以英文或数字结尾且不能重复,且单个参数长度不超过255个字符。","pattern":"^[a-zA-Z0-9_,]*$","type":"string"}},"required":["api_id","visit_param"]},"AuthResult":{"description":"授权结果","properties":{"api_name":{"description":"授权失败的API名称","type":"string"},"app_name":{"description":"授权失败的APP名称","type":"string"},"error_code":{"description":"授权失败错误码","type":"string"},"error_msg":{"description":"授权失败错误信息","type":"string"},"status":{"description":"授权结果\n- SUCCESS:授权成功\n- SKIPPED:跳过\n- FILAED:授权失败","enum":["SUCCESS","SKIPPED","FAILED"],"type":"string"}}},"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":"fd32e2dce13048b7becc80822888ece8","info_version":"v2","method":"post","name":"CreateAuthorizingAppsV2","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}/app-auths":{"post":{"description":"APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。","operationId":"CreateAuthorizingAppsV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"APP授权的请求体","in":"body","name":"CreateAuthorizingAppsV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiAuthCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"auths":[{"api_id":"5f918d104dc84480a75166ba99efff21","app_id":"356de8eb7a8742168586e5daf5339965","auth_blacklist":[],"auth_result":{"status":"SUCCESS"},"auth_role":"PROVIDER","auth_time":"2020-08-04T04:02:22.482227344Z","auth_tunnel":"NORMAL","auth_whitelist":[],"id":"dd29b33ae4394e3b924b582c6b40880b"}]}},"schema":{"$ref":"#/definitions/ApiAuthResult"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:api_ids. 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.3004","error_msg":"App 356de8eb7a8742168586e5daf5339965 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":"APP授权","tags":["APP授权管理"],"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":{"api_ids":["5f918d104dc84480a75166ba99efff21"],"app_ids":["356de8eb7a8742168586e5daf5339965"],"env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID"},"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":"APP授权","tags":"APP授权管理","uri":null,"version":"2.0"}