{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiGroupBase":{"properties":{"name":{"description":"API分组的名称。\n\n支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。\n> 中文字符必须为UTF-8或者unicode编码。","example":"api_group_001","maxLength":255,"minLength":3,"pattern":"^([a-zA-Z0-9]|[\\u4e00-\\u9fa5])([a-zA-Z0-9:._()\\\\//-]|[\\u4e00-\\u9fa5\\uff08\\uff09\\uff1a\\u3001]){2,254}$","type":"string"},"remark":{"description":"API分组描述。\n> 中文字符必须为UTF-8或者unicode编码。","example":"分组1","maxLength":1000,"type":"string"}},"required":["name"]},"ApiGroupCommonInfo":{"properties":{"id":{"description":"编号","example":"aa35dd27fcb9475f8b1b19669ba60309","type":"string"},"name":{"description":"API分组名称","example":"api_group_001","type":"string"},"on_sell_status":{"description":"是否已上架云市场:\n- 1:已上架\n- 2:未上架\n- 3:审核中\n\nROMA Connect暂未对接云市场,此字段默认返回2","example":2,"format":"int32","type":"integer"},"register_time":{"description":"创建时间","example":"2017-12-28T11:44:53.000Z","format":"date-time","type":"string"},"sl_domain":{"description":"系统默认分配的子域名","example":"aa35dd27fcb9475f8b1b19669ba60309.apic.****.com","type":"string"},"status":{"description":"状态\n - 1: 有效\n - 2: 锁定","enum":[1,2],"example":1,"format":"int32","type":"integer"},"update_time":{"description":"最近修改时间","example":"2017-12-28T11:49:01.048Z","format":"date-time","type":"string"},"url_domains":{"description":"分组上绑定的独立域名列表","items":{"$ref":"#/definitions/UrlDomain"},"type":"array"}},"required":["id","name","status","sl_domain","register_time","update_time","on_sell_status"]},"ApiGroupCreate":{"allOf":[{"$ref":"#/definitions/ApiGroupBase"},{"properties":{"roma_app_id":{"description":"分组归属的集成应用编号。\n\n分组版本V2时必填。","type":"string"},"version":{"description":"分组版本\n\n- V1:全局分组\n- V2:应用级分组","type":"string"}},"type":"object"}]},"ApiGroupInfo":{"allOf":[{"$ref":"#/definitions/ApiGroupCommonInfo"},{"properties":{"call_limits":{"description":"流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置\n\n暂不支持","example":200,"format":"int32","type":"integer"},"is_default":{"description":"是否为默认分组","example":2,"format":"int32","type":"integer"},"remark":{"description":"描述","example":"分组1","type":"string"},"roma_app_id":{"description":"分组归属的集成应用编号。\n\n分组版本V2时必填。","example":"98df09fb-d459-4cbf-83a7-2b55ca6f3d5d","type":"string"},"roma_app_name":{"description":"分组归属的集成应用名称","example":"roma_app_demo","type":"string"},"sl_domains":{"description":"系统默认分配的子域名列表","example":["aa35dd27fcb9475f8b1b19669ba60309.apic.****.com","aa35dd27fcb9475f8b1b19669ba60309.apic.****.cn"],"items":{"type":"string"},"type":"array"},"time_interval":{"description":"流控时长\n\n暂不支持","example":2,"format":"int32","type":"integer"},"time_unit":{"description":"流控的时间单位\n\n暂不支持","example":"SECOND","type":"string"},"version":{"description":"分组版本\n\n- V1:全局分组\n- V2:应用级分组","example":"V2","type":"string"}},"type":"object"}]},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]},"SslInfo":{"properties":{"algorithm_type":{"description":"证书算法类型:\n- RSA\n- ECC\n- SM2","enum":["RSA","ECC","SM2"],"example":"RSA","type":"string"},"ssl_id":{"description":"SSL证书编号","example":"ddsa83b07744e8eb1872d695ed4743b","type":"string"},"ssl_name":{"description":"SSL证书名称","example":"certificate","type":"string"},"type":{"default":"global","description":"证书可见范围:\n- instance:当前实例\n- global:全局","enum":["instance","global"],"example":"instance","type":"string"}}},"UrlDomain":{"properties":{"cname_status":{"description":"域名cname状态:\n- 1:未解析\n- 2:解析中\n- 3:解析成功\n- 4:解析失败","example":3,"format":"int32","type":"integer"},"domain":{"description":"访问域名","example":"domain.com","type":"string"},"id":{"description":"域名编号","example":"e91b83b07744e8eb1872d695ed4743b","type":"string"},"is_has_trusted_root_ca":{"default":false,"description":"是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。","example":false,"type":"boolean"},"min_ssl_version":{"default":"TLSv1.1","description":"最小ssl协议版本号。支持TLSv1.1或TLSv1.2","enum":["TLSv1.1","TLSv1.2"],"example":"TLSv1.1","type":"string"},"ssl_id":{"description":"SSL证书编号","example":"ddsa83b07744e8eb1872d695ed4743b","type":"string"},"ssl_infos":{"description":"SSL证书列表","items":{"$ref":"#/definitions/SslInfo"},"type":"array"},"ssl_name":{"description":"SSL证书名称","example":"certificate","type":"string"},"verified_client_certificate_enabled":{"default":false,"description":"是否开启客户端证书校验。只有绑定证书时,该参数才生效。当绑定证书存在trusted_root_ca时,默认开启;当绑定证书不存在trusted_root_ca时,默认关闭。","example":false,"type":"boolean"}}}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"e4033e67c0d244339fa5c8f7a4b89f13","info_version":"v2","method":"post","name":"CreateApiGroupV2","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}/api-groups":{"post":{"description":"API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。","operationId":"CreateApiGroupV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"创建API分组的请求体","in":"body","name":"CreateApiGroupV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiGroupCreate"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"id":"c77f5e81d9cb4424bf704ef2b0ac7600","is_default":2,"name":"api_group_001","on_sell_status":2,"register_time":"2020-07-31T06:55:55.383169068Z","remark":"group1","sl_domain":"c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com","sl_domains":["c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com","c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn"],"status":1,"update_time":"2020-07-31T06:55:55.383169299Z","version":"V1"}},"schema":{"$ref":"#/definitions/ApiGroupInfo"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:name. 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.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":1,"x-request-examples-1":{"name":"api_group_001","remark":"group1"},"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"}