-
响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 quotas Object 参数解释: 配额列表对象。 详情请参见表3。 表3 quotas字段数据结构说明 名称 参数类型 说明 resources Array of objects 参数解释: 资源列表对象。 详情请参见表4。 表4 resources字段数据结构说明 名称 参数类型 说明 quota Integer 参数解释: 项目资源配额。 取值范围: 不涉及。 used Integer 参数解释: 已使用的资源数量。 取值范围: 不涉及。 type String 参数解释: 项目资源类型。 取值范围: instance:实例类型资源。 正常响应样例 {
"quotas" : {
"resources" : [ {
"quota" : 100,
"used" : 1,
"type" : "instance"
} ]
}
} 异常响应 请参见异常请求结果。
-
请求示例 修改企业项目配额,实例的配额设置为1000个,CPU配额100000核数,内存配额200000GB,存储空间配额1000000GB。 PUT https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/enterprise-projects/quotas
{
"eps_quotas": [
{
"enterprise_projects_id": "0",
"instance_quota": 1000,
"vcpus_quota": 100000,
"ram_quota": 200000,
"volume_quota": 1000000
}
]
}
-
URI PUT https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。
-
请求参数 表2 参数说明 名称 是否必选 参数类型 说明 eps_quotas 是 Array of objects 需要修改的企业配额列表。 表3。 表3 EpsQuotasOption参数说明 名称 是否必选 参数类型 说明 enterprise_projects_id 是 String 企业项目ID。 instance_quota 否 Integer 实例的配额。取值范围:实际创建的实例个数 ~ 100,000。 vcpus_quota 否 Integer CPU的配额。取值范围:实际使用的CPU核数 ~ 2,147,483,646。 ram_quota 否 Integer 内存的配额。单位GB。取值范围:实际使用的内存 ~ 2,147,483,646。 volume_quota 否 Integer 存储空间的配额。单位:GB。取值范围:实际使用的存储空间 ~ 2,147,483,646。
-
响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 absolute Object 租户配额信息,详情请参见表3。 表3 absolute数据结构说明 参数 参数类型 描述 maxTotalInstances Integer 云服务器最大申请数量。 maxTotalCores Integer 当前租户所有的CPU核数最大申请数量。 maxTotal
RAM Size Integer 内存最大申请容量(单位:MB)。 maxTotalSpotInstances Integer 竞价实例的最大申请数量。 竞价实例即采用竞价计费模式的实例,详细内容,请参见竞价计费(竞价模式)。 maxTotalSpotCores Integer 竞价实例的CPU核数最大申请数量。 maxTotalSpotRAMSize Integer 竞价实例的内存最大申请容量(单位:MB)。 maxTotalKeypairs Integer 可以申请的SSH密钥对最大数量。 maxServerMeta Integer 可输入元数据的最大长度。 maxPersonality Integer 可注入文件的最大个数。 maxPersonalitySize Integer 注入文件内容的最大长度(单位:Byte)。 maxServerGroups Integer 服务器组的最大个数。 maxServerGroupMembers Integer 服务器组中的最大弹性云服务器数。 totalServerGroupsUsed Integer 已使用的服务器组个数。 maxSecurityGroups Integer 安全组最大使用个数。 说明: 具体配额限制请以VPC配额限制为准。 maxSecurityGroupRules Integer 安全组中安全组规则最大的配置个数。 说明: 具体配额限制请以VPC配额限制为准。 maxTotalFloatingIps Integer 最大的浮动IP使用个数。 maxImageMeta Integer 镜像元数据最大的长度。 totalInstancesUsed Integer 当前云服务器使用个数。 totalCoresUsed Integer 当前已使用CPU核数。 totalRAMUsed Integer 当前内存使用容量(单位:MB)。 totalSpotInstancesUsed Integer 当前竞价实例的使用个数。 totalSpotCoresUsed Integer 当前竞价实例已使用的CPU核数。 totalSpotRAMUsed Integer 当前竞价实例的内存使用容量(单位:MB)。 totalSecurityGroupsUsed Integer 当前安全组使用个数。 totalFloatingIpsUsed Integer 当前浮动IP使用个数。 limit_by_flavor Array of objects 该属性当前未使用,返回值为[]。
-
响应示例 响应示例 {
"absolute":{
"maxServerMeta":128,
"maxPersonality":5,
"maxImageMeta":128,
"maxPersonalitySize":10240,
"maxSecurityGroupRules":20,
"maxTotalKeypairs":-1,
"totalRAMUsed":75776,
"totalInstancesUsed":21,
"maxSecurityGroups":10,
"totalFloatingIpsUsed":0,
"maxTotalCores":20480,
"totalSecurityGroupsUsed":1,
"maxTotalFloatingIps":10,
"maxTotalInstances":2048,
"totalCoresUsed":40,
"maxTotalRAMSize":25165824,
"maxTotalSpotInstances":20,
"maxTotalSpotCores":320,
"maxTotalSpotRAMSize":655360,
"totalSpotInstancesUsed":0,
"totalSpotCoresUsed":0,
"totalSpotRAMUsed":0,
"limit_by_flavor":[],
"maxServerGroups":10,
"maxServerGroupMembers":16,
"totalServerGroupsUsed":2
}
}
-
响应示例 {
"quota_set":{
"injected_file_content_bytes":10240,
"metadata_items":128,
"server_group_members":10,
"server_groups":10,
"ram":51200,
"floating_ips":10,
"key_pairs":100,
"injected_file_path_bytes":255,
"instances":10,
"security_group_rules":20,
"injected_files":5,
"cores":20,
"fixed_ips":-1,
"id":"474eff20eee84b2e87b5717cc7f34dd8",
"security_groups":10
}
}
-
响应消息 参数说明 表2 响应Body参数 参数 参数类型 是否必选 描述 quotas Object 是 配额信息。 详情请参见表3。 表3 ShowResourcesListResponseBody 参数 参数类型 是否必选 描述 resources Objects 是 资源列表对象。 详情请参见表4。 表4 ShowResourcesDetailResponseBody 参数 参数类型 是否必选 描述 type String 是 配额资源类型,当前配额类型仅支持实例类型(instance)。 mode String 是 实例类型: 若值为“Single”,则表示单节点实例配额信息。 若值为“ReplicaSet”,则表示副本集实例配额信息。 若值为“Sharding”,则表示集群实例配额信息。 quota Integer 是 当前配额值。 used Integer 是 已使用的配额数。 响应示例 {
"quotas" : {
"resources" : [ {
"type" : "instance",
"mode" : "Sharding",
"quota" : 80,
"used" : 6
}, {
"type" : "instance",
"mode" : "ReplicaSet",
"quota" : 80,
"used" : 9
}, {
"type" : "instance",
"mode" : "Single",
"quota" : 1000,
"used" : 5
} ]
}
}
-
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 quotas ShowResourcesListResponseBody object 参数解释: 配额信息。 表5 ShowResourcesListResponseBody 参数 参数类型 描述 resources Array of ShowResourcesDetailResponseBody objects 参数解释: 资源列表对象。 表6 ShowResourcesDetailResponseBody 参数 参数类型 描述 type String 参数解释: 配额资源类型。 约束限制: 当前配额类型仅支持实例类型(instance)。 取值范围: 不涉及。 quota Integer 参数解释: 当前配额值。 取值为0时,表示不限制当前配额值。 取值范围: 不涉及。 used Integer 参数解释: 已使用的资源数。 取值范围: 不涉及。
-
URI GET https://{Endpoint}/v3/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 datastore_type 否 String 参数解释: 数据库类型。 约束限制: 不涉及。 取值范围: 取值为“cassandra”,表示查询GeminiDB Cassandra数据库实例配额。 取值为“mongodb”,表示GeminiDB Mongo查询数据库实例配额。 取值为“influxdb”,表示查询GeminiDB Influx数据库实例配额。 取值为“redis”,表示查询GeminiDB Redis数据库实例配额。 默认取值: 如果不传该参数,表示查询所有数据库实例配额。 mode 否 String 参数解释: 实例类型。 约束限制: 不涉及。 取值范围: 取值为“Cluster”,表示GeminiDB Redis Proxy集群,GeminiDB Cassandra、GeminiDB Influx经典部署模式集群实例类型。 取值为“CloudNativeCluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”,表示GeminiDB Redis Cluster经典部署模式集群实例类型。 取值为“Replication”,表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”,表示GeminiDB Influx经典部署模式单节点实例类型。 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。 默认取值: 如果不传datastore_type参数,自动忽略该参数设置,传入datastore_type时,该参数必填。 product_type 否 String 参数解释: 产品类型。 约束限制: 不涉及。 取值范围: Capacity 容量型 Standard 标准型 当查询GeminiDB redis云原生部署模式集群类型配额必传此参数。 默认取值: 不涉及。
-
响应示例 状态码:400 Bad Request {
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
} 状态码:401 Unauthorized {
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403 Forbidden {
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} 状态码:404 Not Found {
"error_code" : "APIG.3093",
"error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist"
} 状态码:500 Internal Server Error {
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
-
URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号
-
响应参数 状态码:204 OK 状态码:400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
-
响应示例 状态码:201 OK {
"app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3",
"call_limits" : 1000,
"create_time" : "2020-09-19T15:27:47.60571141+08:00",
"name" : "ClientQuota_demo",
"reset_time" : "2020-09-20 00:00:00",
"time_interval" : 1,
"time_unit" : "DAY"
} 状态码:400 Bad Request {
"error_code" : "APIG.3325",
"error_msg" : "The API quota name already exists"
} 状态码:401 Unauthorized {
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403 Forbidden {
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} 状态码:404 Not Found {
"error_code" : "APIG.3030",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
} 状态码:500 Internal Server Error {
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
-
响应参数 状态码:201 表4 响应Body参数 参数 参数类型 描述 app_quota_id String 凭据配额编号 name String 配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3-255字符 call_limits Integer 凭据配额的访问次数限制 time_unit String 限定时间单位:SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark String 参数说明和描述 最大长度:255 reset_time String 首次配额重置时间点,不配置默认为首次调用时间计算 create_time String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述