请求参数
名称 |
类型 |
必须 |
长度限制(字符) |
参数格式 |
描述 |
Action |
String |
是 |
确定值 |
[a-zA-Z]+ |
操作接口名,系统规定参数,取值:ListProductQuotas |
ProductCode |
String |
是 |
|
|
服务名称缩写 |
QuotaId |
String |
否 |
|
|
配额ID |
Page |
Integer |
是 |
最小值1 |
|
页码 |
PageSize |
Integer |
否 |
最小值1,最大值200,默认200 |
|
用于限制本次查询结果返回的数量 |
返回元素(调用成功)
名称 |
类型 |
描述 |
Quotas |
Array |
数据 |
RequestId |
String |
请求id |
Quotas参数说明
名称 |
类型 |
描述 |
Total |
Integer |
数据总数 |
QuotaList |
Array |
配额信息 |
Page |
Integer |
当前页码 |
QuotaList参数说明:
名称 |
类型 |
描述 |
ProductName |
String |
服务中文名称 |
ProductEnName |
String |
服务英文名称 |
ProductCode |
String |
服务名称缩写 |
QuotaId |
String |
配额项 |
QuotaDescription |
String |
配额描述 |
QuotaType |
String |
配额类型 ResourceType(资源类型),RightType(权益配额) |
Consumable |
Bool |
是否支持展示已使用量 true:支持, false:不支持 |
Adjustable |
Bool |
是否支持客户发起配额调整 true:支持, false:不支持 |
DimensionsType |
String |
配额维度类型 GlobalType(全局)和RegionType(按机房) |
TotalQuota |
Integer |
配额项默认值 (如果QutaoType是权益配额,TotalQuota只有0(无权限)和1(有权限)两个值) |
AdjustMaxLimit |
Integer |
客户调整配额值上限 如果Adjustable为true时才有效, |
Dimensions |
Array |
配额维度数组 |
Dimensions数组参数说明:
名称 |
类型 |
描述 |
RegionName |
String |
机房中文名 |
RegionEnName |
String |
机房英文名 |
RegionId |
String |
机房code |
错误码(调用不成功)
错误代码(Code) |
错误消息(Message) |
HTTP 状态码 |
中文描述(语义) |
MissingRequiredHeader |
Bad request, must include valid http header: X-KSC-ACCOUNT-ID, X-KSC-SERVICE, X-KSC-REGION. |
400 |
|
InvalidParameterValue |
Parameters error: %s |
400 |
参数错误:%s,具体错误信息在%s说明 |
示例
请求示例
https://quota.api.ksyun.com/?Action=ListProductQuotas&Version=2021-05-19&ProductCode=KEC&QuotaId=quota_kec_dataguard&Page=1
返回示例
{
"Quotas": {
"Total": 1,
"QuotaList": [
{
"ProductName": "云服务器",
"ProductEnName": "Kingsoft Cloud Elastic Compute",
"ProductCode": "KEC",
"QuotaId": "quota_kec_dataguard",
"QuotaDescription": "容灾分组quota值配置",
"QuotaType": "ResourceType",
"Consumable": true,
"Adjustable": true,
"DimensionsType": "RegionType",
"TotalQuota": 10,
"AdjustMaxLimit": 20,
"Dimensions": [
{
"RegionName": "华东1(上海)",
"RegionEnName": "CN East 1(Shanghai)",
"RegionId": "cn-shanghai-2"
},
{
"RegionName": "华北1(北京)",
"RegionEnName": "CN North 1(Beijing)",
"RegionId": "cn-beijing-6"
},
{
"RegionName": "新加坡",
"RegionEnName": "Singapore",
"RegionId": "ap-singapore-1"
},
{
"RegionName": "华南1(广州)",
"RegionEnName": "CN South 1(Guangzhou)",
"RegionId": "cn-guangzhou-1"
},
{
"RegionName": "俄罗斯(莫斯科)",
"RegionEnName": "Russia (Moscow)",
"RegionId": "eu-east-1"
},
{
"RegionName": "华北政务1(北京)",
"RegionEnName": "CN North Government 1(Beijing)",
"RegionId": "cn-north-1-gov"
},
{
"RegionName": "西南1(重庆)",
"RegionEnName": "CN Southwest 1(Chongqing)",
"RegionId": "cn-southwest-1"
},
{
"RegionName": "华北金融1(北京)",
"RegionEnName": "CN North Finance 1(Beijing)",
"RegionId": "cn-beijing-fin"
},
{
"RegionName": "华东金融1(上海)",
"RegionEnName": "CN East Finance 1(Shanghai)",
"RegionId": "cn-shanghai-fin"
},
{
"RegionName": "华中1(武汉)",
"RegionEnName": "CN Central 1(Wuhan)",
"RegionId": "cn-central-1"
}
]
}
],
"Page": 1
},
"RequestId": "2047181d-b4c9-4ffd-90a9-7b0df0267fa6"
}