{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"Erro":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200082","type":"string"},"error_msg":{"description":"错误消息。","example":"The available IP addresses in the selected subnet are insufficient.","type":"string"}},"type":"object"},"SrCreateInstanceRsp":{"properties":{"instance":{"description":"实例信息。","properties":{"az_code":{"description":"可用区码。","example":"cn-southwest-244b","type":"string"},"az_mode":{"description":"可用区模式。\n\n取值范围:\n\nsingle:单可用区。\n\nmulti:多可用区。","example":"single","type":"string"},"db_user":{"description":"数据库用户。默认root。","example":"root","type":"string"},"enable_ssl":{"description":"SSL开关。","example":false,"type":"boolean"},"engine":{"description":"引擎信息。","properties":{"type":{"description":"引擎类型。","example":"star-rocks","type":"string"},"version":{"description":"引擎大版本号。","example":3.1,"type":"string"}}},"ha_mode":{"description":"部署模式。","example":"Single","type":"string"},"id":{"description":"StarRocks实例ID,严格匹配UUID规则。","example":"590031445ef845bb912d7fc8243db80cin17","type":"string"},"name":{"description":"实例名称。","example":"htap-ff64","type":"string"},"pay_info":{"description":"计费信息。","properties":{"is_auto_renew":{"description":"包周期是否自动续费。","example":null,"type":"string"},"order_id":{"description":"包周期计费ID。","example":null,"type":"string"},"pay_model":{"description":"计费模式。\n- 0:按需计费\n- 1:包周期\n\nStarRocks实例当前只支持按需计费,默认值为0","example":0,"type":"string"},"period":{"description":"包周期周期。","example":null,"type":"string"},"period_type":{"description":"包周期周期类型。","example":null,"type":"string"}}},"port":{"description":"数据库端口号。默认3306。","example":3306,"format":"int32","type":"integer"},"region":{"description":"实例所在区域。","example":"cn-southwest-244","type":"string"},"security_group_id":{"description":"安全组ID。","example":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","type":"string"},"status":{"description":"实例状态。","example":"creating","type":"string"},"sub_net_id":{"description":"子网ID。","example":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","type":"string"},"tags_info":{"description":"实例标签。","properties":{"sys_tags":{"description":"系统标签。","items":{"properties":{"key":{"description":"标签键。","example":"_sys_enterprise_project_id","type":"string"},"value":{"description":"标签值。","example":0,"type":"string"}}},"type":"array"},"tags":{"description":"用户标签。默认为空。","items":{"properties":{"key":{"description":"标签键。","type":"string"},"value":{"description":"标签值。","type":"string"}}},"type":"array"}}},"vpc_id":{"description":"虚拟私有云ID。","example":"d5a1a29b-1476-490f-9682-c1a59593e7b0","type":"string"}}},"job_id":{"description":"工作流ID。","example":"cf0b7506-1505-450f-9d95-ce9d93b6b5c3","type":"string"}},"type":"object"},"StarRocksCreateRequest":{"properties":{"az_code":{"description":"可用区代码。","example":"cn-southwest-244c","type":"string"},"az_mode":{"description":"可用区类型。\n当前仅支持single。","enum":["single"],"example":"single","type":"string"},"be_count":{"description":"BE节点数。\n- 单机时固定为1\n- 集群时取值[3, 10]","example":1,"format":"int32","type":"integer"},"be_flavor_id":{"description":"BE节点规格ID。使用可通过查询HTAP规格响应消息中的“id”。","example":"b44cfde6-d250-313c-8d7a-cd216f071658","type":"string"},"be_volume":{"description":"BE节点存储规格。","properties":{"capacity_in_gb":{"description":"磁盘容量,单位GB\n增长的步长:10GB。","format":"int32","maximum":32000,"minimum":50,"type":"integer"},"io_type":{"description":"磁盘类型。通过查询HTAP引擎资源返回消息获取。","type":"string"}},"required":["io_type","capacity_in_gb"]},"db_root_pwd":{"description":"数据库密码。\n\n取值范围:至少包含以下字符的三种:大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&|.,长度8~32个字符。 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。如果您输入弱密码,系统会自动判定密码非法。","example":"Test@123!","pattern":"^[a-zA-Z\\d~!@,$#%\\^\\-\\*_=\\+\\?\\|\\.]{8,32}$","type":"string"},"engine":{"description":"引擎信息。","properties":{"type":{"description":"引擎类型。仅支持star-rocks。","example":"star-rocks","type":"string"},"version":{"description":"引擎大版本号。","example":1,"type":"string"}},"required":["type","version"]},"fe_count":{"description":"FE节点数。\n- 单机时固定为1\n- 集群时取值[3, 10]","example":1,"format":"int32","type":"integer"},"fe_flavor_id":{"description":"FE节点规格ID。使用可通过查询HTAP规格响应消息中的“id”。","example":"b44cfde6-d250-313c-8d7a-cd216f071658","type":"string"},"fe_volume":{"description":"FE节点存储规格。","properties":{"capacity_in_gb":{"description":"磁盘容量,单位GB\n增长的步长:10GB。","example":50,"format":"int32","maximum":1000,"minimum":50,"type":"integer"},"io_type":{"description":"磁盘类型。通过查询HTAP引擎资源返回消息获取。","example":"SSD","type":"string"}},"required":["io_type","capacity_in_gb"]},"ha":{"description":"部署信息。","properties":{"mode":{"description":"部署模式。","enum":["Single","Cluster"],"example":"Single","type":"string"}},"required":["mode"]},"name":{"description":"实例名称。同一租户下,同类型的实例名可重名。\n\n取值范围:最小为4个字符,最大为64个字符且不超过64个字节,必须以字母开头,区分大小写,可以包含字母、数字、中划线、下划线,不能包含其他特殊字符。不支持中文名。","example":"htap-eca5","type":"string"},"pay_info":{"description":"支付信息。包周期场景必填。","properties":{"is_auto_renew":{"description":"包周期是否自动续费。包周期场景必填。\n取值范围:\n- 1:自动续费\n- 0:不自动续费","type":"string"},"pay_model":{"description":"计费模式,默认0。包周期场景必填。\n取值范围:\n- 0:按需计费\n- 1:包周期","type":"string"},"period":{"description":"包周期周期。包周期场景必填。","type":"string"},"period_type":{"description":"包周期周期类型。包周期场景必填。\n取值范围:\n- 2:包月\n- 3:包年","type":"string"}}},"region_code":{"description":"可用区。包周期场景必填。","type":"string"},"security_group_id":{"description":"实例安全组ID。默认与Taurus安全组ID一致。","example":"f8c849b1-56c1-4aab-a455-f4748df71ff1","type":"string"},"tags_info":{"description":"标签信息。","properties":{"sys_tags":{"description":"系统标签。","items":{"properties":{"key":{"description":"标签键。","enum":["_sys_enterprise_project_id"],"example":"_sys_enterprise_project_id","type":"string"},"value":{"description":"标签值。","enum":["0"],"example":0,"type":"string"}},"required":["key","value"]},"type":"array"}},"required":["sys_tags"]},"time_zone":{"description":"时区。默认时区为UTC+08:00。","example":"UTC+08:00","type":"string"}},"required":["name","engine","ha","fe_flavor_id","be_flavor_id","db_root_pwd","fe_count","be_count","az_mode","fe_volume","be_volume","az_code","tags_info"],"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"efb97a73f6984558aa9aee397a49082c","info_version":"v3","method":"post","name":"CreateStarrocksInstance","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks":{"post":{"description":"创建StarRocks实例。","operationId":"CreateStarrocksInstance","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"TaurusDB数据库实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"创建实例。","in":"body","name":"CreateStarrocksInstanceRequestBody","required":true,"schema":{"$ref":"#/definitions/StarRocksCreateRequest"}},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"内容类型。 取值:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Success.","examples":{"application/json":{"instance":{"az_code":"cn-southwest-244b","az_mode":"single","db_user":"root","enable_ssl":false,"engine":{"type":"star-rocks","version":"3.1"},"ha_mode":"Single","id":"590031445ef845bb912d7fc8243db80cin17","name":"htap-ff64","pay_info":{"is_auto_renew":null,"order_id":null,"pay_model":"0","period":null,"period_type":null},"port":3306,"region":"cn-southwest-244","security_group_id":"967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1","status":"creating","sub_net_id":"2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b","tags_info":{"sys_tags":[{"key":"_sys_enterprise_project_id","value":"0"}],"tags":[]},"vpc_id":"d5a1a29b-1476-490f-9682-c1a59593e7b0"},"job_id":"cf0b7506-1505-450f-9d95-ce9d93b6b5c3"}},"schema":{"$ref":"#/definitions/SrCreateInstanceRsp"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/Erro"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/Erro"}}},"summary":"创建StarRocks实例","tags":["HTAP-标准版"],"x-is-registered":"Y","x-request-examples-1":{"az_code":"cn-southwest-244b","az_mode":"single","be_count":1,"be_flavor_id":"de565db8-0a96-37ea-9388-61167624712c","be_volume":{"capacity_in_gb":50,"io_type":"SSD"},"db_root_pwd":"Test@123!","engine":{"type":"star-rocks","version":"3.1"},"fe_count":1,"fe_flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","fe_volume":{"capacity_in_gb":50,"io_type":"SSD"},"ha":{"mode":"Single"},"name":"htap-ff64","tags_info":{"sys_tags":[{"key":"_sys_enterprise_project_id","value":"0"}]},"time_zone":"UTC+08:00"},"x-request-examples-description-1":"创建数据库实例","x-request-examples-text-1":{"az_code":"cn-southwest-244b","az_mode":"single","be_count":1,"be_flavor_id":"de565db8-0a96-37ea-9388-61167624712c","be_volume":{"capacity_in_gb":50,"io_type":"SSD"},"db_root_pwd":"Test@123!","engine":{"type":"star-rocks","version":"3.1"},"fe_count":1,"fe_flavor_id":"afef3bfd-ac7c-32e1-ba44-c388acbb196a","fe_volume":{"capacity_in_gb":50,"io_type":"SSD"},"ha":{"mode":"Single"},"name":"htap-ff64","tags_info":{"sys_tags":[{"key":"_sys_enterprise_project_id","value":"0"}]},"time_zone":"UTC+08:00"},"x-request-examples-url-1":"POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建StarRocks实例","tags":"HTAP-标准版","uri":null,"version":"2.0"}