查询账户在KV服务的使用信息,包含所有的KV存储空间列表等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Status |
string |
账户状态。
|
online |
| RequestId |
string |
请求 ID。 |
EEEBE525-F576-1196-8DAF-2D70CA3F4D2F |
| NamespaceUsed |
integer |
账号下已申请 KV 存储空间数。 |
1 |
| NamespaceQuota |
integer |
账号下最多可申请的 KV 存储空间配额数。 |
10 |
| CapacityString |
string |
账户下所有 KV 存储空间的可用容量。 |
1 GB |
| CapacityUsedString |
string |
账户下所有 KV 存储空间的已用容量。 |
100 MB |
| Capacity |
integer |
账户下所有 KV 存储空间的可用容量,单位为字节。 |
1073741824 |
| CapacityUsed |
integer |
账户下所有 KV 存储空间的已用容量,单位为字节。 |
10048576 |
| NamespaceList |
array<object> |
账号的 KV 存储空间列表。 |
|
|
object |
|||
| Status |
string |
KV 存储空间状态,取值:
|
online |
| Namespace |
string |
KV 存储空间名称。 |
test_namespace |
| NamespaceId |
string |
KV 存储空间 ID。 |
643355322374688768 |
| Description |
string |
KV 存储空间的描述信息。 |
the first namespace |
| Capacity |
integer |
KV 存储空间的可用容量,单位为字节。 |
1073741824 |
| CapacityUsed |
integer |
KV 存储空间的已用容量,单位为字节。 |
100048576 |
| CapacityString |
string |
KV 存储空间的可用容量。 |
1 GB |
| CapacityUsedString |
string |
KV 存储空间的已用容量。 |
100 MB |
示例
正常返回示例
JSON格式
{
"Status": "online",
"RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
"NamespaceUsed": 1,
"NamespaceQuota": 10,
"CapacityString": "1 GB",
"CapacityUsedString": "100 MB",
"Capacity": 1073741824,
"CapacityUsed": 10048576,
"NamespaceList": [
{
"Status": "online",
"Namespace": "test_namespace",
"NamespaceId": "643355322374688768",
"Description": "the first namespace",
"Capacity": 1073741824,
"CapacityUsed": 100048576,
"CapacityString": "1 GB",
"CapacityUsedString": "100 MB"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidAccount.Malformed | The specified account is invalid. | 账号输入不对,比如输入为空。 |
| 400 | InvalidNameSpace.Malformed | The specified namespace is invalid. | 存储空间名输入错误,比如输入空字符串。 |
| 400 | InvalidKey.Malformed | The specified key is invalid. | Key名输入错误,比如输入空字符串。 |
| 400 | InvalidKey.ExceedsMaximum | The size of the key cannot exceed 512 bytes. | 请求的Key的长度过大。 |
| 400 | InvalidValue.ExceedsMaximum | The size of the value cannot exceed 2,000,000 bytes. | 存入的值过大。 |
| 403 | InvalidKey.ExceedsCapacity | The maximum capacity of a single namespace cannot exceed 1 GB. | 存储空间的容量超过限制。 |
| 403 | Unauthorized.InvalidParameters | The specified authentication parameters are invalid. | 鉴权参数输入错误。 |
| 403 | Unauthorized.InvalidTime | The specified authentication time is invalid. | 您输入的鉴权时间参数无效,请检查参数值后重试。 |
| 403 | Unauthorized.InvalidToken | Token authentication failed. | 您输入的token无效,请检查并输入正确的token后进行重试。 |
| 404 | InvalidAccount.NotFound | The specified account does not exist. | 指定的账号不存在。 |
| 404 | InvalidNameSpace.NotFound | The specified namespace does not exist. | 指定的存储空间不存在。 |
| 404 | InvalidKey.NotFound | The specified key does not exist. | 指定的键值对不存在。 |
| 406 | InvalidNameSpace.Duplicate | The specified namespace already exists. | 指定的存储空间已经存在。 |
| 406 | InvalidNameSpace.QuotaFull | The maximum number of namespaces is exceeded. | 存储空间的个数超过容量限制。 |
| 429 | TooManyRequests | Too many requests are submitted. | 提交太频繁,请稍候再试 |
| 429 | TooQuickRequests | Request for putting or deleting keys are frequently submitted. | 键值对的修改或者删除操作太频繁。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。