summaryrefslogtreecommitdiff
path: root/data/zh_cn/quotas/2020-05-10/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/quotas/2020-05-10/api-docs.php')
-rw-r--r--data/zh_cn/quotas/2020-05-10/api-docs.php7863
1 files changed, 3110 insertions, 4753 deletions
diff --git a/data/zh_cn/quotas/2020-05-10/api-docs.php b/data/zh_cn/quotas/2020-05-10/api-docs.php
index a771602..446b7b8 100644
--- a/data/zh_cn/quotas/2020-05-10/api-docs.php
+++ b/data/zh_cn/quotas/2020-05-10/api-docs.php
@@ -1,518 +1,279 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'quotas',
- 'version' => '2020-05-10',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'quotas', 'version' => '2020-05-10'],
'directories' => [
[
- 'id' => 277504,
- 'title' => '产品配额',
+ 'children' => ['GetProductQuota', 'GetProductQuotaDimension', 'ListProductDimensionGroups', 'ListProductQuotaDimensions', 'ListProductQuotas', 'ListProducts', 'ListDependentQuotas'],
'type' => 'directory',
- 'children' => [
- 'GetProductQuota',
- 'GetProductQuotaDimension',
- 'ListProductDimensionGroups',
- 'ListProductQuotaDimensions',
- 'ListProductQuotas',
- 'ListProducts',
- 'ListDependentQuotas',
- ],
+ 'title' => '产品配额',
+ 'id' => 49802,
],
[
- 'id' => 277512,
- 'title' => '配额告警',
+ 'children' => ['CreateQuotaAlarm', 'DeleteQuotaAlarm', 'UpdateQuotaAlarm', 'ListQuotaAlarms', 'GetQuotaAlarm', 'ListAlarmHistories'],
'type' => 'directory',
- 'children' => [
- 'CreateQuotaAlarm',
- 'DeleteQuotaAlarm',
- 'UpdateQuotaAlarm',
- 'ListQuotaAlarms',
- 'GetQuotaAlarm',
- 'ListAlarmHistories',
- ],
+ 'title' => '配额告警',
+ 'id' => 49795,
],
[
- 'id' => 277519,
- 'title' => '配额提升申请',
+ 'children' => ['CreateQuotaApplication', 'GetQuotaApplication', 'ListQuotaApplications', 'GetQuotaApplicationApproval', 'RemindQuotaApplicationApproval'],
'type' => 'directory',
- 'children' => [
- 'CreateQuotaApplication',
- 'GetQuotaApplication',
- 'ListQuotaApplications',
- 'GetQuotaApplicationApproval',
- 'RemindQuotaApplicationApproval',
- ],
+ 'title' => '配额提升申请',
+ 'id' => 49810,
],
[
- 'id' => 277525,
- 'title' => '配额模板',
+ 'children' => ['GetQuotaTemplateServiceStatus', 'ModifyQuotaTemplateServiceStatus', 'CreateTemplateQuotaItem', 'ModifyTemplateQuotaItem', 'ListQuotaApplicationTemplates', 'DeleteTemplateQuotaItem', 'CreateQuotaApplicationsForTemplate', 'ListQuotaApplicationsDetailForTemplate', 'ListQuotaApplicationsForTemplate'],
'type' => 'directory',
- 'children' => [
- 'GetQuotaTemplateServiceStatus',
- 'ModifyQuotaTemplateServiceStatus',
- 'CreateTemplateQuotaItem',
- 'ModifyTemplateQuotaItem',
- 'ListQuotaApplicationTemplates',
- 'DeleteTemplateQuotaItem',
- 'CreateQuotaApplicationsForTemplate',
- 'ListQuotaApplicationsDetailForTemplate',
- 'ListQuotaApplicationsForTemplate',
- ],
+ 'title' => '配额模板',
+ 'id' => 49814,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetProductQuota' => [
- 'summary' => '查询目标云产品的配额详情。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateQuotaAlarm' => [
+ 'summary' => '创建配额告警。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'config'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'example' => 'q_hvnoqv'],
+ ],
+ [
+ 'name' => 'AlarmName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额告警名称。', 'type' => 'string', 'required' => true, 'example' => 'q_hvnoqv alarm'],
+ ],
+ [
+ 'name' => 'ThresholdType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '配额ID。'."\n"
+ 'description' => '配额告警类型。取值:'."\n"
."\n"
- .'> 关于如何获取目标云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
+ .'- used(默认值):已使用量告警。'."\n"
+ .'- usable:剩余可用量告警。',
'type' => 'string',
- 'required' => true,
- 'example' => 'q_security-groups',
+ 'required' => false,
+ 'example' => 'used',
+ 'default' => 'used',
+ 'enum' => ['used', 'usable'],
],
],
[
- 'name' => 'Dimensions',
+ 'name' => 'Threshold',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额告警阈值的数值。取值:'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设数值,您会收到告警通知。配额告警阈值必须大于配额的已使用量。'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设数值,您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。'."\n"
+ ."\n"
+ .'> 该参数与ThresholdPercent必须设置一个。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '1', 'example' => '150'],
+ ],
+ [
+ 'name' => 'ThresholdPercent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额告警阈值的百分比。取值:'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设百分比,您会收到告警通知。取值范围:(50%, 100%]。'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设百分比,您会收到告警通知。取值范围:(0%, 50%]。'."\n"
+ ."\n"
+ .'> 该参数与Threshold必须设置一个。', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '50', 'example' => '50'],
+ ],
+ [
+ 'name' => 'WebHook',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com/callback'],
+ ],
+ [
+ 'name' => 'QuotaDimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '配额维度。'."\n"
- .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
- .'> 部分云产品维度必填。云产品的配额是什么,以及配额是否必填可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)获取,返回参数`Requisite`表示该维度是否必填。',
+ .'配额项的属性,维度`Dimensions`+配额ID`QuotaActionCode`确定唯一的配额项。'."\n"
+ .'> 部分云产品维度必填,可以通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度, 返回参数`Requisite`表示该维度是否必填。',
'type' => 'array',
'items' => [
- 'description' => '配额维度。',
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数。您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数。您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,可通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .' > `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,可通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
'required' => false,
- 'example' => '{\\"regionId\\":\\"cn-beijing\\"}',
- 'maxItems' => 10,
+ 'maxItems' => 5,
],
],
+ [
+ 'name' => 'OriginalContext',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'Quota' => [
- 'description' => '配额详情。',
- 'type' => 'object',
- 'properties' => [
- 'Adjustable' => [
- 'description' => '配额是否可调整。取值:'."\n"
- ."\n"
- .'- true:可调整。'."\n"
- ."\n"
- .'- false:不可调整。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ApplicableRange' => [
- 'description' => '配额调整范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额调整范围。例如:`[802,10000]`。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '802',
- ],
- ],
- 'ApplicableType' => [
- 'description' => '配额调整类型。取值:'."\n"
- ."\n"
- .'- continuous:连续。'."\n"
- ."\n"
- .'- discontinuous:间断。',
- 'type' => 'string',
- 'example' => 'continuous',
- ],
- 'ApplyReasonTips' => [
- 'description' => '申请配额调整理由示例。',
- 'type' => 'string',
- 'example' => 'The business xxx is expected to grow by 50%.',
- ],
- 'Consumable' => [
- 'description' => '是否显示“已使用”的配额。取值:'."\n"
- ."\n"
- .'- true:显示“已使用”的配额。'."\n"
- ."\n"
- .'- false:不显示“已使用”的配额。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Dimensions' => [
- 'description' => '配额维度。格式:`{"regionId":"地域"}`。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效的UTC时间。',
- 'type' => 'string',
- 'example' => '2022-09-28T06:06:00Z',
- ],
- 'ExpireTime' => [
- 'description' => '配额失效的UTC时间。',
- 'type' => 'string',
- 'example' => '2022-09-29T06:06:00Z',
- ],
- 'GlobalQuota' => [
- 'description' => '是否为全局配额。取值:'."\n"
- .'- true:该配额项为所有Region共用。'."\n"
- .'- false:该配额项为每个Region独立。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Period' => [
- 'description' => '配额周期。',
- 'type' => 'object',
- 'properties' => [
- 'PeriodUnit' => [
- 'description' => '配额周期的单位。取值:'."\n"
- ."\n"
- .'- second:秒。'."\n"
- ."\n"
- .'- minute:分钟。'."\n"
- ."\n"
- .'- hour:小时。'."\n"
- ."\n"
- .'- day:天。'."\n"
- ."\n"
- .'- week:周。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'day',
- ],
- 'PeriodValue' => [
- 'description' => '配额周期的取值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'ProductCode' => [
- 'description' => '云产品名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/',
- ],
- 'QuotaCategory' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- ."\n"
- .'- FlowControl:API速率配额。'."\n"
- ."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'example' => 'CommonQuota',
- ],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of security groups that can be owned by the current account.',
- ],
- 'QuotaItems' => [
- 'description' => '配额详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额类别。',
- 'type' => 'object',
- 'properties' => [
- 'Quota' => [
- 'description' => '配额值。',
- 'type' => 'string',
- 'example' => '801',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。'."\n"
- ."\n"
- .'> 每个配额的单位不同。例如:容器服务Kubernetes版的配额`q_cbdch3`(最大集群数)单位为Cluster,云服务器ECS的配额`q_security-groups`(安全组总数量上限)单位为个。',
- 'type' => 'string',
- 'example' => 'Count',
- ],
- 'Type' => [
- 'description' => '配额类别。取值:'."\n"
- ."\n"
- .'- BaseQuota:保障配额。'."\n"
- ."\n"
- .'- ReservedQuota:预留配额。',
- 'type' => 'string',
- 'example' => 'BaseQuota',
- ],
- 'Usage' => [
- 'description' => '配额用量。',
- 'type' => 'string',
- 'example' => '26',
- ],
- ],
- ],
- ],
- 'QuotaName' => [
- 'description' => '配额名称。',
- 'type' => 'string',
- 'example' => 'Maximum Number of Security Groups',
- ],
- 'QuotaType' => [
- 'description' => '配额类型。取值:'."\n"
- ."\n"
- .'- privilege:特权。'."\n"
- ."\n"
- .'- normal:普通。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。'."\n"
- ."\n"
- .'> 每个配额的单位不同。例如:容器服务Kubernetes版的配额`q_cbdch3`(最大集群数)单位为Cluster,云服务器ECS的配额`q_security-groups`(安全组总数量上限)单位为个。',
- 'type' => 'string',
- 'example' => 'Count',
- ],
- 'SupportedRange' => [
- 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。',
- 'type' => 'array',
- 'items' => [
- 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。'."\n"
- ."\n"
- .'- 当ApplicableType为continuous时,如果取值为[802,1000],则表示取值为802~1000中的所有整数。'."\n"
- ."\n"
- .'- 当ApplicableType为discontinuous时,如果取值为[10,20,50,100],则表示取值仅为10、20、50和100。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '[802,1000]',
- ],
- ],
- 'TotalQuota' => [
- 'description' => '配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '801',
- ],
- 'TotalUsage' => [
- 'description' => '配额用量。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '26',
- ],
- 'UnadjustableDetail' => [
- 'description' => '配额不可调整原因。取值:'."\n"
- ."\n"
- .'- nonactivated:未开通服务。'."\n"
- ."\n"
- .'- applicationProcess:配额申请处理中。'."\n"
- ."\n"
- .'- limitReached:已达配额上限。'."\n"
- ."\n"
- .'- supportTicketRequired:需要提工单申请。',
- 'type' => 'string',
- 'example' => 'limitReached',
- ],
- 'UsageMetric' => [
- 'description' => '配额用量在云监控(CloudMonitor)中的监控信息。'."\n"
- ."\n"
- .'> 空表示云监控中无此配额监控数据。',
- 'type' => 'object',
- 'properties' => [
- 'MetricDimensions' => [
- 'description' => 'CloudMonitor监控维度。'."\n"
- ."\n"
- .'格式:`key:value`键值对形式的集合,例如:'."\n"
- .'`{"productCode":"***","metricKey":"***","regionId":"***","label":"***"}`。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => 'CloudMonitor监控维度值。',
- 'example' => 'ecs',
- ],
- ],
- 'MetricName' => [
- 'description' => 'CloudMonitor监控项名称。',
- 'type' => 'string',
- 'example' => 'Usage',
- ],
- 'MetricNamespace' => [
- 'description' => 'CloudMonitor监控数据命名空间。',
- 'type' => 'string',
- 'example' => 'acs_quotas_flowcontrol',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3',
- ],
+ 'AlarmId' => ['description' => '告警ID。', 'type' => 'string', 'example' => '18b3be23-b7b0-4d45-91bc-d0c331aa****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BD219E2B-E687-45EE-B5F3-61FB730551B1'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'QUOTA.UNSUPPORT.ALARM', 'errorMessage' => 'This quota does not support creating alarm', 'description' => ''],
+ ['errorCode' => 'ALARM.NAME.REPEAT', 'errorMessage' => 'The warning name must be unique.', 'description' => '预警名称不可重复。'],
+ ['errorCode' => 'QUOTA.ALARM.MAX', 'errorMessage' => 'Quota alarm have reached the upper limit of 100', 'description' => '已达配额预警数上限。'],
+ ['errorCode' => 'UNSUPPORTED.ALARM.TYPE', 'errorMessage' => 'Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.', 'description' => '统一告警不支持告警类型为已使用量告警,并且不支持配额告警阈值类型为数值'],
+ ['errorCode' => 'THRESHOLD.ILLEGAL', 'errorMessage' => 'The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].', 'description' => 'ThresholdPercent和Threshold不能同时为空或者ThresholdPercent需要在 (0,100]的范围内。'],
+ ['errorCode' => 'QUOTA.OFFLINE', 'errorMessage' => 'The quota has been offline.', 'description' => '该配额已下市。'],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Quota\\": {\\n \\"Adjustable\\": true,\\n \\"ApplicableRange\\": [\\n 802\\n ],\\n \\"ApplicableType\\": \\"continuous\\",\\n \\"ApplyReasonTips\\": \\"The business xxx is expected to grow by 50%.\\",\\n \\"Consumable\\": true,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:06:00Z\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:06:00Z\\",\\n \\"GlobalQuota\\": true,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaItems\\": [\\n {\\n \\"Quota\\": \\"801\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"Type\\": \\"BaseQuota\\",\\n \\"Usage\\": \\"26\\"\\n }\\n ],\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaType\\": \\"normal\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"SupportedRange\\": [\\n 0\\n ],\\n \\"TotalQuota\\": 801,\\n \\"TotalUsage\\": 26,\\n \\"UnadjustableDetail\\": \\"limitReached\\",\\n \\"UsageMetric\\": {\\n \\"MetricDimensions\\": {\\n \\"key\\": \\"ecs\\"\\n },\\n \\"MetricName\\": \\"Usage\\",\\n \\"MetricNamespace\\": \\"acs_quotas_flowcontrol\\"\\n }\\n },\\n \\"RequestId\\": \\"8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProductQuotaResponse>\\r\\n\\t<RequestId>8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3</RequestId>\\r\\n\\t<Quota>\\r\\n\\t\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\r\\n\\t\\t<Consumable>true</Consumable>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<TotalUsage>26</TotalUsage>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<Adjustable>true</Adjustable>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<QuotaName>安全组总数量上限</QuotaName>\\r\\n\\t\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\r\\n\\t\\t<TotalQuota>801</TotalQuota>\\r\\n\\t\\t<ApplicableType>continuous</ApplicableType>\\r\\n\\t\\t<ApplicableRange>802</ApplicableRange>\\r\\n\\t\\t<ApplicableRange>10000</ApplicableRange>\\r\\n\\t</Quota>\\r\\n</GetProductQuotaResponse>\\t","errorExample":""}]',
- 'title' => '查询目标云产品的配额详情',
+ 'title' => '创建配额用量告警',
+ 'description' => '配额告警功能已升级,本API即将废弃,请您使用云监控API [PutResourceMetricRules](~~2513316~~)、[PutMetricRuleTargets](~~2513302~~)对新版配额告警规则进行创建。'."\n"
+ .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetProductQuotaDimension' => [
- 'summary' => '查询目标云产品支持的配额维度详情。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaAlarm'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmId\\": \\"18b3be23-b7b0-4d45-91bc-d0c331aa****\\",\\n \\"RequestId\\": \\"BD219E2B-E687-45EE-B5F3-61FB730551B1\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaAlarmResponse>\\n\\t\\t<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>\\n\\t\\t<RequestId>88BAD9A9-0C47-4139-8531-08CB333F3384</RequestId>\\n</CreateQuotaAlarmResponse>","errorExample":""}]',
+ ],
+ 'CreateQuotaApplication' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasF0DSPH',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasF0DSPH'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'disk',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
],
[
- 'name' => 'DimensionKey',
+ 'name' => 'QuotaActionCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'example' => 'q_security-groups'],
+ ],
+ [
+ 'name' => 'DesireValue',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额申请的值。'."\n"
+ ."\n"
+ .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
+ .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '804'],
+ ],
+ [
+ 'name' => 'Reason',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额申请的原因。'."\n"
+ ."\n"
+ .'> 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'string', 'required' => true, 'example' => 'Scale Out'],
+ ],
+ [
+ 'name' => 'NoticeType',
'in' => 'formData',
'schema' => [
- 'description' => '目标配额维度的Key。'."\n"
+ 'description' => '配额申请结果是否发送通知。取值:'."\n"
."\n"
- .'> 当目标配额维度有依赖配额维度时,依赖配额维度的Key和Value必须设置,且需要同时设置。',
- 'type' => 'string',
+ .'- 0(默认值):否。'."\n"
+ .'- 3:是。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'zoneId',
+ 'example' => '0',
+ 'default' => '0',
+ 'enum' => ['0', '1', '2', '3'],
],
],
[
- 'name' => 'DependentDimensions',
+ 'name' => 'Dimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '目标配额维度依赖的配额维度。',
+ 'description' => '配额维度。'."\n"
+ .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
+ .'> 部分云产品维度必填。您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回参数`Requisite`表示该维度是否必填。',
'type' => 'array',
'items' => [
- 'description' => '目标配额维度依赖的配额维度。',
+ 'description' => '配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '目标配额维度依赖的配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于目标配额维度依赖的配额维度的个数。'."\n"
- .'> - 依赖配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '目标配额维度依赖的配额维度的Value。'."\n"
- ."\n"
- .'> - N的取值范围取决于目标配额维度依赖的配额维度的个数。'."\n"
- .'> - 依赖配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
@@ -520,1124 +281,650 @@
'maxItems' => 5,
],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '产品支持的配额维度详情列表。',
- 'type' => 'object',
- 'properties' => [
- 'QuotaDimension' => [
- 'description' => '配额维度详情。',
- 'type' => 'object',
- 'properties' => [
- 'DependentDimensions' => [
- 'description' => '目标配额依赖云服务的配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额依赖云服务的配额维度。',
- 'type' => 'string',
- 'example' => 'regionId',
- ],
- ],
- 'DimensionKey' => [
- 'description' => '配额维度的Key。取值:'."\n"
- .'- regionId:地域。'."\n"
- ."\n"
- .'- zoneId:可用区。'."\n"
- ."\n"
- .'- chargeType:付费类型。'."\n"
- ."\n"
- .'- networkType:网络类型。'."\n"
- ."\n"
- .'- resourceType:资源类型。',
- 'type' => 'string',
- 'example' => 'zoneId',
- ],
- 'DimensionValueDetail' => [
- 'description' => '配额维度Value的详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度Value的详情。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '配额维度Value的名称。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b',
- ],
- 'Value' => [
- 'description' => '配额维度Value的值。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b',
- ],
- ],
- ],
- ],
- 'DimensionValues' => [
- 'description' => '配额维度Value的列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度Value的列表。',
- 'type' => 'string',
- 'example' => '["cn-hangzhou-b", "cn-hangzhou-e", "cn-hangzhou-f", "cn-hangzhou-g", "cn-hangzhou-h", "cn-hangzhou-i", "cn-hangzhou-j", "cn-hangzhou-k"]',
- ],
- ],
- 'Name' => [
- 'description' => '配额维度的名称。',
- 'type' => 'string',
- 'example' => 'Zone',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaDimension\\": {\\n \\"DependentDimensions\\": [\\n \\"regionId\\"\\n ],\\n \\"DimensionKey\\": \\"zoneId\\",\\n \\"DimensionValueDetail\\": [\\n {\\n \\"Name\\": \\"cn-hangzhou-b\\",\\n \\"Value\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"DimensionValues\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\", \\\\\\"cn-hangzhou-e\\\\\\", \\\\\\"cn-hangzhou-f\\\\\\", \\\\\\"cn-hangzhou-g\\\\\\", \\\\\\"cn-hangzhou-h\\\\\\", \\\\\\"cn-hangzhou-i\\\\\\", \\\\\\"cn-hangzhou-j\\\\\\", \\\\\\"cn-hangzhou-k\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"Zone\\"\\n },\\n \\"RequestId\\": \\"1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProductQuotaDimensionResponse>\\r\\n\\t<RequestId>1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3</RequestId>\\r\\n\\t<QuotaDimension>\\r\\n\\t\\t<DimensionKey>regionId</DimensionKey>\\r\\n\\t\\t<DimensionValues>cn-shenzhen</DimensionValues>\\r\\n\\t\\t<DimensionValues>cn-beijing</DimensionValues>\\r\\n\\t\\t<DimensionValues>cn-hangzhou</DimensionValues>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-shenzhen</Value>\\r\\n\\t\\t\\t<Name>cn-shenzhen</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-beijing</Value>\\r\\n\\t\\t\\t<Name>cn-beijing</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-hangzhou</Value>\\r\\n\\t\\t\\t<Name>cn-hangzhou</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<Name>region</Name>\\r\\n\\t</QuotaDimension>\\r\\n</GetProductQuotaDimensionResponse>\\t","errorExample":""}]',
- 'title' => '查询目标云产品支持的配额维度详情',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListProductDimensionGroups' => [
- 'summary' => '查询目标云产品的维度组。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'NextToken',
- 'in' => 'query',
+ 'name' => 'QuotaCategory',
+ 'in' => 'formData',
'schema' => [
- 'description' => '用来标记开始查询数据的位置。置空表示从头开始。',
+ 'description' => '配额类型。'."\n"
+ ."\n"
+ .'默认值:CommonQuota。',
'type' => 'string',
'required' => false,
- 'example' => '1',
+ 'enumValueTitles' => ['FlowControl' => 'API速率配额', 'WhiteListLabel' => '权益配额', 'CommonQuota' => '通用配额'],
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
+ 'name' => 'AuditMode',
+ 'in' => 'formData',
'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- .'取值范围:1~200。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '><notice>该参数废弃,不建议使用。></notice>'."\n"
+ ."\n"
+ .'配额审核模式。',
+ 'type' => 'string',
'required' => false,
- 'maximum' => '200',
- 'example' => '3',
- 'default' => '30',
+ 'enumValueTitles' => [],
+ 'example' => 'Sync',
+ 'default' => 'Async',
+ 'enum' => ['Async', 'Sync'],
],
],
[
- 'name' => 'ProductCode',
- 'in' => 'query',
+ 'name' => 'EnvLanguage',
+ 'in' => 'formData',
'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
+ 'description' => '配额告警通知的语言。',
'type' => 'string',
- 'required' => true,
- 'example' => 'entconsole',
+ 'required' => false,
+ 'enumValueTitles' => ['en' => '英文', 'zh' => '中文'],
+ 'example' => 'zh',
],
],
+ [
+ 'name' => 'ExpireTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额失效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 当您未选择失效时间时,默认为提交时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-20T09:25:56Z'],
+ ],
+ [
+ 'name' => 'EffectiveTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额生效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 当您未选择生效时间时,默认为当前配额开始时间起99年。', 'type' => 'string', 'required' => false, 'example' => '2021-01-19T09:25:56Z'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '维度组。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'DimensionGroups' => [
- 'description' => '维度组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '维度组代码。',
- 'type' => 'object',
- 'properties' => [
- 'DimensionKeys' => [
- 'description' => '维度组的Key。',
- 'type' => 'array',
- 'items' => [
- 'description' => '维度组的Key。',
- 'type' => 'string',
- 'example' => 'regionId',
- ],
- ],
- 'GroupCode' => [
- 'description' => '维度组代码。',
- 'type' => 'string',
- 'example' => 'entconsole_zjzp4d****',
- ],
- 'GroupName' => [
- 'description' => '维度组名称。',
- 'type' => 'string',
- 'example' => 'Resource sharing',
- ],
- 'ProductCode' => [
- 'description' => '云服务代码。',
- 'type' => 'string',
- 'example' => 'entconsole',
- ],
- ],
- ],
- ],
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。',
+ 'ApplicationId' => ['description' => '配额申请ID。', 'type' => 'string', 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
+ 'ApplyTime' => ['description' => '配额提升申请时间。', 'type' => 'string', 'example' => '2021-01-19T09:25:56Z'],
+ 'ApproveValue' => ['description' => '配额提升申请审批通过的配额值。', 'type' => 'number', 'format' => 'float', 'example' => '804'],
+ 'AuditReason' => ['description' => '配额提升申请审批意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'DesireValue' => ['description' => '配额提升申请值。', 'type' => 'integer', 'format' => 'int32', 'example' => '804'],
+ 'Dimension' => ['description' => '配额维度。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => '配额生效时间。', 'type' => 'string', 'example' => '2021-01-19T09:25:56Z'],
+ 'ExpireTime' => ['description' => '配额失效时间。', 'type' => 'string', 'example' => '2021-01-20T09:25:56Z'],
+ 'NoticeType' => [
+ 'description' => '配额提升申请结果是否通知。取值:'."\n"
+ ."\n"
+ .'- 0:不通知。'."\n"
+ ."\n"
+ .'- 3:通知。',
'type' => 'integer',
- 'format' => 'int32',
+ 'format' => 'int64',
+ 'enumValueTitles' => ['不通知', 3 => '通知'],
'example' => '3',
],
- 'NextToken' => [
- 'description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。',
- 'type' => 'string',
- 'example' => '21',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
+ 'ProductCode' => ['description' => '云产品名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas::141339776561****:quota/ecs/q_security-groups'],
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of security groups that can be owned by the current account.'],
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'Maximum Number of Security Groups'],
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'AMOUNT'],
+ 'Reason' => ['description' => '配额提升申请原因。', 'type' => 'string', 'example' => 'Scale Out'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'Status' => [
+ 'description' => '配额提升申请的审批状态。',
'type' => 'string',
- 'example' => '057D210F-F2FC-5329-A536-26C16628BB09',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ 'enumValueTitles' => ['Cancel' => '已关闭', 'Agree' => '审核通过', 'Process' => '审核中', 'Disagree' => '审核拒绝'],
+ 'example' => 'Process',
],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"DimensionGroups\\": [\\n {\\n \\"DimensionKeys\\": [\\n \\"regionId\\"\\n ],\\n \\"GroupCode\\": \\"entconsole_zjzp4d****\\",\\n \\"GroupName\\": \\"Resource sharing\\",\\n \\"ProductCode\\": \\"entconsole\\"\\n }\\n ],\\n \\"MaxResults\\": 3,\\n \\"NextToken\\": \\"21\\",\\n \\"RequestId\\": \\"057D210F-F2FC-5329-A536-26C16628BB09\\",\\n \\"TotalCount\\": 3\\n}","errorExample":""},{"type":"xml","example":"<ListProductDimensionGroupsResponse>\\r\\n\\t<DimensionGroups>\\r\\n\\t\\t<GroupName>OSS_Group</GroupName>\\r\\n\\t\\t<ProductCode>oss</ProductCode>\\r\\n\\t\\t<GroupCode>oss_wf1ngqmd7q</GroupCode>\\r\\n\\t\\t<DimensionKeys>chargeType</DimensionKeys>\\r\\n\\t</DimensionGroups>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>057D210F-F2FC-5329-A536-26C16628BB09</RequestId>\\r\\n\\t<MaxResults>1</MaxResults>\\r\\n</ListProductDimensionGroupsResponse>\\t","errorExample":""}]',
- 'title' => '查询云产品的维度组',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'ACQUIRE.LOCK.FAIL', 'errorMessage' => 'The request is too frequent. Please try again later.', 'description' => '访问频繁,请稍后重试。'],
+ ['errorCode' => 'InvalidNoticeType', 'errorMessage' => 'Invalid NoticeType', 'description' => '参数NoticeType无效。'],
+ ['errorCode' => 'InvalidDesireValue', 'errorMessage' => 'Invalid DesireValue', 'description' => '参数 DesireValue 无效。'],
+ ['errorCode' => 'QUOTA.NOT.ADJUSTABLE', 'errorMessage' => 'Quota is not adjustable', 'description' => '配额不可调整。'],
+ ['errorCode' => 'QUOTA.NOT.FOUND', 'errorMessage' => 'The quota does not exist.', 'description' => '配额不存在。'],
+ ['errorCode' => 'QUOTA.APPLICATION.PROCESS', 'errorMessage' => 'The quota adjustment application is being processed. Please try again later.', 'description' => '配额申请调整处理中,暂不能提交申请。'],
+ ['errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL', 'errorMessage' => 'The applied quota value is invalid.', 'description' => ''],
+ ['errorCode' => 'QUOTA.APPLICATION.TIME.ERROE', 'errorMessage' => 'ExpireTime cannot be earlier than the current time or EffectiveTime.', 'description' => '失效时间不能早于当前时间或生效时间'],
+ ],
+ ],
+ 'title' => '创建配额提升申请',
+ 'summary' => '创建配额提升申请。',
+ 'description' => '> 创建配额提升申请后,您可以调用[ListQuotaApplications](~~440568~~)接口查看审批结果,当`Status`显示为`Agree`时,表示审批通过。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListProductQuotaDimensions' => [
- 'summary' => '查询目标云产品支持的配额维度。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaApplication'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaApplication', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"ApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"ApplyTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ApproveValue\\": 804,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"DesireValue\\": 804,\\n \\"Dimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ExpireTime\\": \\"2021-01-20T09:25:56Z\\",\\n \\"NoticeType\\": 3,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas::141339776561****:quota/ecs/q_security-groups\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"Reason\\": \\"Scale Out\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"Status\\": \\"Process\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaApplicationResponse>\\n\\t<Status>Process</Status>\\n\\t<ApplyTime>2021-11-11T03:24:39Z</ApplyTime>\\n\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\n\\t<RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n\\t<ProductCode>ecs</ProductCode>\\n\\t<Dimension>\\n\\t\\t<regionId>cn-hangzhou</regionId>\\n\\t</Dimension>\\n\\t<ApproveValue>1007</ApproveValue>\\n\\t<Reason>扩容</Reason>\\n\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\n\\t<QuotaName>安全组总数量上限</QuotaName>\\n\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\n\\t<NoticeType>0</NoticeType>\\n\\t<ApplicationId>d314d6ae-867d-484c-9009-3d421a80****</ApplicationId>\\n\\t<DesireValue>804</DesireValue>\\n</CreateQuotaApplicationResponse>\\t","errorExample":""}]',
+ ],
+ 'CreateQuotaApplicationsForTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasRRW33P'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'NextToken',
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '用来标记开始查询数据的位置。置空表示从头开始。'."\n",
+ 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
+ 'description' => '配额类型。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。',
'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'ProductCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '产品code', 'description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'ecs-spec'],
+ ],
+ [
+ 'name' => 'QuotaActionCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'quota的code', 'description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'example' => 'ecs.g5.2xlarge'],
+ ],
+ [
+ 'name' => 'Dimensions',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~200。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '配额维度',
+ 'description' => '配额维度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'maximum' => '200',
- 'example' => '5',
- 'default' => '30',
+ 'maxItems' => 10,
],
],
[
- 'name' => 'ProductCode',
+ 'name' => 'DesireValue',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'disk',
- ],
+ 'schema' => ['title' => '申请的配额量', 'description' => '配额申请的值。'."\n"
+ ."\n"
+ .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
+ .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '12'],
],
[
- 'name' => 'QuotaCategory',
+ 'name' => 'Reason',
'in' => 'formData',
+ 'schema' => ['title' => '申请理由', 'description' => '配额申请的原因。'."\n"
+ ."\n"
+ .'> 配额申请由各云服务的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'string', 'required' => true, 'example' => 'Scale Out'],
+ ],
+ [
+ 'name' => 'NoticeType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额申请结果是否发送通知。取值:'."\n"
+ ."\n"
+ .'- 0(默认值):否。'."\n"
+ .'- 3:是。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'EnvLanguage',
+ 'in' => 'formData',
+ 'schema' => ['title' => '环境 语种,如', 'description' => '配额申请结果通知的语言。取值:'."\n"
+ ."\n"
+ .'- zh(默认值):中文。'."\n"
+ .'- en:英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'EffectiveTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '生效时间', 'description' => '配额生效的UTC时间。该参数仅适用于权益配额(WhiteListLabel)。'."\n"
+ .' '."\n"
+ .'>如果当前账号不选择生效时间,则默认为提交时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-19T09:25:56Z'],
+ ],
+ [
+ 'name' => 'ExpireTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '过期时间(UTC 格式)', 'description' => '配额失效的UTC时间。该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 如果当前账号未选择失效时间,则失效时间为当前配额生效时间开始起99年。', 'type' => 'string', 'required' => false, 'example' => '2021-01-20T09:25:56Z'],
+ ],
+ [
+ 'name' => 'AliyunUids',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '配额种类。取值:'."\n"
- ."\n"
- .'- FlowControl:API速率配额。'."\n"
- ."\n"
- .'- CommonQuota(默认值):通用配额。'."\n"
+ 'title' => '批量调整账号',
+ 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。'."\n"
."\n"
- .'> 权益配额(WhiteListLabel)无配额维度。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'FlowControl',
- 'CommonQuota',
- ],
+ .'> 单次最多只支持为50个成员批量申请提升配额。关于资源目录的成员,请参见[ListAccounts](~~604207~~)。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额申请的资源目录成员的阿里云账号(主账号)。', 'type' => 'string', 'required' => false, 'example' => '135048337611****'."\n"],
+ 'required' => true,
+ 'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '无。',
+ 'title' => 'PopResultDTO<String>',
+ 'description' => '提交申请返回结果。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'NextToken' => [
- 'description' => '用来标记返回查询数据的位置。未返回表示数据已经查询完毕。',
- 'type' => 'string',
- 'example' => '84',
+ 'AliyunUids' => [
+ 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额申请的资源目录成员的阿里云账号(主账号)。', 'type' => 'string', 'example' => '135048337611****'],
],
- 'QuotaDimensions' => [
- 'description' => '配额维度。',
+ 'BatchQuotaApplicationId' => ['description' => '配额申请批次ID。', 'type' => 'string', 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
+ 'FailResults' => [
+ 'description' => '配额申请失败的资源目录成员的阿里云账号(主账号)和失败原因列表。',
'type' => 'array',
'items' => [
- 'description' => '配额维度。',
+ 'description' => '配额申请失败的资源目录成员的阿里云账号(主账号)和失败原因列表。',
'type' => 'object',
'properties' => [
- 'DependentDimensions' => [
- 'description' => '目标配额维度依赖的配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额维度依赖的配额维度。',
- 'type' => 'string',
- 'example' => 'regionId',
- ],
- ],
- 'DimensionKey' => [
- 'description' => '配额维度的Key。取值:'."\n"
- ."\n"
- .'- regionId:地域ID。'."\n"
- ."\n"
- .'- zoneId:可用区ID。'."\n"
- ."\n"
- .'- chargeType:付费类型。'."\n"
- ."\n"
- .'- networkType:网络类型。'."\n"
- ."\n"
- .'- resourceType:资源类型。',
- 'type' => 'string',
- 'example' => 'zoneId',
- ],
- 'DimensionValueDetail' => [
- 'description' => '配额维度Value的详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度value的详情。',
- 'type' => 'object',
- 'properties' => [
- 'DependentDimensions' => [
- 'description' => '目标配额维度依赖的配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额维度依赖的配额维度。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '目标配额维度依赖的配额维度的Key。',
- 'type' => 'string',
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '目标配额维度依赖的配额维度的Value。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
- ],
- ],
- ],
- ],
- 'Name' => [
- 'description' => '配额维度Value的名称。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b',
- ],
- 'Value' => [
- 'description' => '配额维度Value的值。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-b'."\n",
- ],
- ],
- ],
- ],
- 'DimensionValues' => [
- 'description' => '配额维度value的列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度Value的列表。',
- 'type' => 'string',
- 'example' => '["cn-hangzhou-b", "cn-hangzhou-e", "cn-hangzhou-f", "cn-hangzhou-g", "cn-hangzhou-h", "cn-hangzhou-i", "cn-hangzhou-j", "cn-hangzhou-k"]',
- ],
- ],
- 'Name' => [
- 'description' => '配额维度的名称。',
- 'type' => 'string',
- 'example' => 'Zone',
- ],
- 'Requisite' => [
- 'description' => '查询配额维度时是否必选。取值:'."\n"
- ."\n"
- .'- true:必选。'."\n"
- ."\n"
- .'- false:非必选。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'AliyunUid' => ['description' => '配额申请失败的资源目录成员的阿里云账号(主账号)。', 'type' => 'string', 'example' => '135048337611****'],
+ 'Reason' => ['description' => '失败原因。', 'type' => 'string', 'example' => 'The quota adjustment application is being processed. Please try again later.'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7ED584FB-ECBF-4A2A-969D-F54D25EFABF9',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"84\\",\\n \\"QuotaDimensions\\": [\\n {\\n \\"DependentDimensions\\": [\\n \\"regionId\\"\\n ],\\n \\"DimensionKey\\": \\"zoneId\\",\\n \\"DimensionValueDetail\\": [\\n {\\n \\"DependentDimensions\\": [\\n {\\n \\"Key\\": \\"regionId\\",\\n \\"Value\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"Name\\": \\"cn-hangzhou-b\\",\\n \\"Value\\": \\"cn-hangzhou-b\\\\n\\"\\n }\\n ],\\n \\"DimensionValues\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\", \\\\\\"cn-hangzhou-e\\\\\\", \\\\\\"cn-hangzhou-f\\\\\\", \\\\\\"cn-hangzhou-g\\\\\\", \\\\\\"cn-hangzhou-h\\\\\\", \\\\\\"cn-hangzhou-i\\\\\\", \\\\\\"cn-hangzhou-j\\\\\\", \\\\\\"cn-hangzhou-k\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"Zone\\",\\n \\"Requisite\\": false\\n }\\n ],\\n \\"RequestId\\": \\"7ED584FB-ECBF-4A2A-969D-F54D25EFABF9\\",\\n \\"TotalCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<ListProductQuotaDimensionsResponse>\\n<QuotaDimensions>\\n <DimensionKey>regionId</DimensionKey>\\n <DimensionValues>cn-shenzhen</DimensionValues>\\n <DimensionValues>cn-beijing</DimensionValues>\\n <DimensionValues>cn-wulanchabu</DimensionValues>\\n <DimensionValues>ap-south-1</DimensionValues>\\n <DimensionValues>eu-west-1</DimensionValues>\\n <DimensionValues>ap-northeast-1</DimensionValues>\\n <DimensionValues>me-east-1</DimensionValues>\\n <DimensionValues>cn-chengdu</DimensionValues>\\n <DimensionValues>cn-qingdao</DimensionValues>\\n <DimensionValues>cn-shanghai</DimensionValues>\\n <DimensionValues>cn-guangzhou</DimensionValues>\\n <DimensionValues>cn-hongkong</DimensionValues>\\n <DimensionValues>ap-southeast-1</DimensionValues>\\n <DimensionValues>cn-heyuan</DimensionValues>\\n <DimensionValues>ap-southeast-2</DimensionValues>\\n <DimensionValues>ap-southeast-3</DimensionValues>\\n <DimensionValues>eu-central-1</DimensionValues>\\n <DimensionValues>cn-huhehaote</DimensionValues>\\n <DimensionValues>ap-southeast-5</DimensionValues>\\n <DimensionValues>us-east-1</DimensionValues>\\n <DimensionValues>cn-zhangjiakou</DimensionValues>\\n <DimensionValues>us-west-1</DimensionValues>\\n <DimensionValues>cn-hangzhou</DimensionValues>\\n <Name>region</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>zoneId</DimensionKey>\\n <Name>可用区ID</Name>\\n <Requisite>false</Requisite>\\n <DependentDimensions>regionId</DependentDimensions>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>chargeType</DimensionKey>\\n <DimensionValues>Spot</DimensionValues>\\n <DimensionValues>PostPaid</DimensionValues>\\n <DimensionValues>PrePaid</DimensionValues>\\n <Name>付费类型</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>networkType</DimensionKey>\\n <DimensionValues>classic</DimensionValues>\\n <DimensionValues>vpc</DimensionValues>\\n <Name>网络类型</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<TotalCount>4</TotalCount>\\n<RequestId>7ED584FB-ECBF-4A2A-969D-F54D25EFABF9</RequestId>\\n<MaxResults>4</MaxResults>\\n</ListProductQuotaDimensionsResponse>","errorExample":""}]',
- 'title' => '查询云产品支持的配额维度',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ListProductQuotas' => [
- 'summary' => '查询目标云产品的配额列表。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'QUOTA.APPLICATION.TIME.ERROE', 'errorMessage' => 'ExpireTime cannot be earlier than the current time or EffectiveTime.', 'description' => '失效时间不能早于当前时间或生效时间'],
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ['errorCode' => 'QUOTA.APPLICATION.PROCESS', 'errorMessage' => 'The quota adjustment application is being processed. Please try again later.', 'description' => '配额申请调整处理中,暂不能提交申请。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '通过配额模板批量申请成员配额',
+ 'summary' => '当您将配额项加入配额模板时,仅资源目录中新增的成员会自动提交配额提升申请,已有成员无变化。如果您需要通过配额模板为已有成员提升配额,则可以批量选择配额模板为资源目录中的多个成员提交配额提升申请。只有资源目录的管理员账号可批量创建配额申请。',
+ 'description' => '### 使用限制'."\n"
+ .'单次申请的配额项不超过10个。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaApplicationsForTemplate'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaApplicationsForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AliyunUids\\": [\\n \\"135048337611****\\"\\n ],\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"FailResults\\": [\\n {\\n \\"AliyunUid\\": \\"135048337611****\\",\\n \\"Reason\\": \\"The quota adjustment application is being processed. Please try again later.\\"\\n }\\n ],\\n \\"RequestId\\": \\"8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3\\"\\n}","type":"json"}]',
+ ],
+ 'CreateTemplateQuotaItem' => [
+ 'summary' => '管理账号创建配额模板后,如果资源目录新增成员,则配额模板自动为新增的成员提交配额提升申请,已有成员无变化。通过配额模板,您一次可以申请提升多个配额项,提升整个组织的配额管理效率和自动化水平。只有资源目录的管理员账号可创建配额模版。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。'."\n"
- ."\n"
- .'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
- .'- 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAd****',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~100。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- [
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
+ 'schema' => ['title' => '云服务名称缩写。', 'description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_security-groups',
- ],
- ],
- [
- 'name' => 'KeyWord',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额的搜索关键字。'."\n"
- .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),搜索范围:`QuotaName`,`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'security',
- ],
+ 'schema' => ['title' => '配额ID。', 'description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'example' => 'q_security-groups'],
],
[
- 'name' => 'SortField',
+ 'name' => 'DesireValue',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额支持的排序方式。'."\n"
- ."\n"
- .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),如果不设置,则为空。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'TOTAL' => '按总配额用量排序',
- 'TIME' => '按最近更新时间排序',
- 'RESERVED' => '按预留配额用量排序',
- ],
- 'example' => 'TIME',
- ],
+ 'schema' => ['title' => '配额申请的值。', 'description' => '配额申请的值。'."\n"
+ ."\n"
+ .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
+ .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '804'],
],
[
- 'name' => 'SortOrder',
+ 'name' => 'NoticeType',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额支持的排序方式。'."\n"
- ."\n"
- .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),如果不设置,则为空。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'Descending' => '降序',
- 'Ascending' => '升序',
- ],
- 'example' => 'Ascending',
- 'enum' => [
- 'Ascending',
- 'Descending',
- ],
- ],
+ 'schema' => ['title' => '配额申请结果是否发送通知', 'description' => '配额申请结果是否发送通知。取值:'."\n"
+ .'- 0(默认值):否。'."\n"
+ .'- 3:是。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'Dimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
+ 'title' => '配额维度。',
'description' => '配额维度。',
'type' => 'array',
'items' => [
'description' => '配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> N的取值范围取决于对应云产品支持的维度个数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> N的取值范围取决于对应云产品支持的维度个数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
'required' => false,
- 'maxItems' => 10,
+ 'maxItems' => 5,
],
],
[
- 'name' => 'QuotaCategory',
+ 'name' => 'EnvLanguage',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额种类。'."\n"
- ."\n"
- .'默认值:CommonQuota。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'FlowControl' => 'API速率配额',
- 'WhiteListLabel' => '权益配额',
- 'CommonQuota' => '通用配额',
- ],
- 'example' => 'FlowControl',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
- ],
- ],
+ 'schema' => ['description' => '配额告警通知的语言。取值:'."\n"
+ ."\n"
+ .'- zh(默认值):中文。'."\n"
+ .'- en:英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
- 'name' => 'GroupCode',
+ 'name' => 'EffectiveTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额生效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 数据为空表示立即生效。', 'type' => 'string', 'required' => false, 'example' => '2021-01-19T09:25:56Z'],
+ ],
+ [
+ 'name' => 'ExpireTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额失效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 数据为空表示未设定UTC失效时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-20T09:25:56Z'],
+ ],
+ [
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '维度组代码。',
+ 'description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- WhiteListLabel:权益配额。'."\n"
+ .'- FlowControl:API速率配额。',
'type' => 'string',
'required' => false,
- 'example' => 'entconsole_w1j3ms****',
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'WhiteListLabel', 'FlowControl'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回结果。',
+ 'title' => 'Schema of Response',
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NextToken' => [
- 'description' => '是否拥有下一次查询的令牌(Token)。'."\n"
- ."\n"
- .'- 如果 NextToken 为空表示没有下一次查询。'."\n"
- .'- 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。',
- 'type' => 'string',
- 'example' => 'AAAAAd****',
- ],
- 'Quotas' => [
- 'description' => '配额详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额详情。',
- 'type' => 'object',
- 'properties' => [
- 'Adjustable' => [
- 'description' => '配额是否可调整。',
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '配额可调整',
- 'false' => '配额不可调整',
- ],
- 'example' => 'true',
- ],
- 'ApplicableRange' => [
- 'description' => '当前配额项可申请的配额值区间,用于配额申请时进行参考。',
- 'type' => 'array',
- 'items' => [
- 'description' => '当前配额项可申请的配额值区间。'."\n"
- ."\n"
- .'排除当前用户已有区间,用于申请配额时进行参考,例如:`[1010,10000]`。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '[1010,10000]',
- ],
- ],
- 'ApplicableType' => [
- 'description' => '配额调整类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'continuous' => '连续',
- 'discontinuous' => '间断',
- ],
- 'example' => 'discontinuous',
- ],
- 'ApplyReasonTips' => [
- 'description' => '申请配额调整理由示例。',
- 'type' => 'string',
- 'example' => 'The business xxx is expected to grow by 50%.',
- ],
- 'Consumable' => [
- 'description' => '是否显示“已使用”的配额。',
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '显示“已使用”的配额',
- 'false' => '不显示“已使用”的配额',
- ],
- 'example' => 'true',
- ],
- 'Dimensions' => [
- 'description' => '配额维度。格式:`{"regionId":"地域"}`。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效的UTC时间。',
- 'type' => 'string',
- 'example' => '2022-09-28T06:07:00Z',
- ],
- 'ExpireTime' => [
- 'description' => '配额失效的UTC时间。',
- 'type' => 'string',
- 'example' => '2022-09-29T06:07:00Z',
- ],
- 'GlobalQuota' => [
- 'description' => '是否为全局配额。',
- 'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '该配额项为所有Region共用',
- 'false' => '该配额项为每个Region独立',
- ],
- 'example' => 'true',
- ],
- 'Period' => [
- 'description' => '配额计算周期。',
- 'type' => 'object',
- 'properties' => [
- 'PeriodUnit' => [
- 'description' => '配额计算周期的单位。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'week' => '周',
- 'hour' => '小时',
- 'day' => '天',
- 'second' => '秒',
- 'minute' => '分钟',
- ],
- 'example' => 'day',
- ],
- 'PeriodValue' => [
- 'description' => '配额计算周期的取值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '{}',
- ],
- ],
- ],
- 'ProductCode' => [
- 'description' => '云产品名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups',
- ],
- 'QuotaCategory' => [
- 'description' => '配额类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'FlowControl' => 'API速率配额',
- 'WhiteListLabel' => '权益配额',
- 'CommonQuota' => '通用配额',
- ],
- 'example' => 'CommonQuota',
- ],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of security groups that can be owned by the current account.',
- ],
- 'QuotaItems' => [
- 'description' => '配额详情。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额详情。',
- 'type' => 'object',
- 'properties' => [
- 'Quota' => [
- 'description' => '配额值。',
- 'type' => 'string',
- 'example' => '1009',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'Count',
- ],
- 'Type' => [
- 'description' => '配额类别。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'BaseQuota' => '保障配额',
- 'ReservedQuota' => '预留配额',
- ],
- 'example' => 'BaseQuota',
- ],
- 'Usage' => [
- 'description' => '配额用量。',
- 'type' => 'string',
- 'example' => '1009',
- ],
- ],
- ],
- ],
- 'QuotaName' => [
- 'description' => '配额名称。',
- 'type' => 'string',
- 'example' => 'ecs.g5.2xlarge',
- ],
- 'QuotaType' => [
- 'description' => '配额类型。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'normal' => '普通',
- 'privilege' => '特权',
- ],
- 'example' => 'privilege',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'AMOUNT',
- ],
- 'SupportedRange' => [
- 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。',
- 'type' => 'array',
- 'items' => [
- 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。'."\n"
- ."\n"
- .'- 当ApplicableType为continuous时,如果取值为[1009,10000],则表示取值为1009~10000中的所有数。'."\n"
- ."\n"
- .'- 当ApplicableType为discontinuous时,如果取值为[10,20,50,100],则表示取值仅为10、20、50和100。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '[1009,10000]',
- ],
- ],
- 'TotalQuota' => [
- 'description' => '配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '200',
- ],
- 'TotalUsage' => [
- 'description' => '配额用量。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1009',
- ],
- 'UnadjustableDetail' => [
- 'description' => '配额不可调整原因。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'limitReached' => '已达配额上限',
- 'nonactivated' => '未开通服务',
- 'applicationProcess' => '配额申请处理中',
- ],
- 'example' => 'applicationProcess',
- ],
- 'UsageMetric' => [
- 'description' => '配额用量在云监控(CloudMonitor)中的监控信息。'."\n"
- ."\n"
- .'> 空表示云监控中无此配额监控数据。',
- 'type' => 'object',
- 'properties' => [
- 'MetricDimensions' => [
- 'description' => 'CloudMonitor监控维度。'."\n"
- ."\n"
- .'格式:`key:value`键值对形式的集合,例如:'."\n"
- .'`{"productCode":"***","metricKey":"***","regionId":"***","label":"***"}`。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'ecs',
- 'description' => 'CloudMonitor监控维度值。',
- ],
- ],
- 'MetricName' => [
- 'description' => 'CloudMonitor监控项名称。',
- 'type' => 'string',
- 'example' => 'Usage',
- ],
- 'MetricNamespace' => [
- 'description' => 'CloudMonitor监控数据命名空间。',
- 'type' => 'string',
- 'example' => 'acs_quotas_flowcontrol',
- ],
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D0131FD5-5397-44FE-BF5A-4B7165B813CC',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Id' => ['description' => '配额模板ID。', 'type' => 'string', 'example' => '1****'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidSortOrder',
- 'errorMessage' => 'Invalid SortOrder',
- ],
- [
- 'errorCode' => 'INVALID.MAX.RESULTS',
- 'errorMessage' => 'The maxResults parameter is invalid. Use an integer ranging from 1 to 100.',
- ],
- [
- 'errorCode' => 'DIMENSIONGROUP.NOT.FOUND',
- 'errorMessage' => 'Dimension group does not exist.',
- ],
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ['errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL', 'errorMessage' => 'DesirValue less than or equal to the current quota value, or that is not within the adjustable range.', 'description' => '申请值小于等于当前配额值或申请值不在配额项可调整的范围内。'],
+ ['errorCode' => 'QUOTA.NOT.ADJUSTABLE', 'errorMessage' => 'Quota is not adjustable', 'description' => '配额不可调整。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '创建配额模板',
+ 'description' => '### 前提条件'."\n"
+ .'请确保配额模板的状态为已开启(即`ServiceStatus`为`1`)。'."\n"
+ ."\n"
+ .'调用[GetQuotaTemplateServiceStatus](~~450407~~)接口查询配额模板的状态,当配额模板的状态`ServiceStatus`为`0`(未设置)或`-1`(禁用)时,需要调用[ModifyQuotaTemplateServiceStatus](~~450406~~)接口将配额模板的状态修改为`1`(开启)。'."\n"
+ ."\n"
+ .'### 使用说明'."\n"
+ .'创建配额模板后,您可以调用[ListQuotaApplicationsForTemplate](~~2584864~~)接口查看审批结果,当`Status`显示为`Agree`时,表示审批通过。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplateQuotaItem'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"AAAAAd****\\",\\n \\"Quotas\\": [\\n {\\n \\"Adjustable\\": true,\\n \\"ApplicableRange\\": [\\n 0\\n ],\\n \\"ApplicableType\\": \\"discontinuous\\",\\n \\"ApplyReasonTips\\": \\"The business xxx is expected to grow by 50%.\\",\\n \\"Consumable\\": true,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:07:00Z\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:07:00Z\\",\\n \\"GlobalQuota\\": true,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 0\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaItems\\": [\\n {\\n \\"Quota\\": \\"1009\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"Type\\": \\"BaseQuota\\",\\n \\"Usage\\": \\"1009\\"\\n }\\n ],\\n \\"QuotaName\\": \\"ecs.g5.2xlarge\\",\\n \\"QuotaType\\": \\"privilege\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"SupportedRange\\": [\\n 0\\n ],\\n \\"TotalQuota\\": 200,\\n \\"TotalUsage\\": 1009,\\n \\"UnadjustableDetail\\": \\"applicationProcess\\",\\n \\"UsageMetric\\": {\\n \\"MetricDimensions\\": {\\n \\"key\\": \\"ecs\\"\\n },\\n \\"MetricName\\": \\"Usage\\",\\n \\"MetricNamespace\\": \\"acs_quotas_flowcontrol\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"D0131FD5-5397-44FE-BF5A-4B7165B813CC\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListProductQuotasResponse>\\n <TotalCount>4</TotalCount>\\n <RequestId>F3A3568B-B01E-4EA7-B3DD-0699B4D319F9</RequestId>\\n <NextToken>AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX</NextToken>\\n <Quotas>\\n <QuotaDescription>ecs.g5.2xlarge</QuotaDescription>\\n <Consumable>true</Consumable>\\n <TotalUsage>3</TotalUsage>\\n <ProductCode>ecs-spec</ProductCode>\\n <Dimensions>\\n <regionId>cn-hangzhou</regionId>\\n <chargeType>PostPaid</chargeType>\\n <zoneId>cn-hangzhou-i</zoneId>\\n <networkType>vpc</networkType>\\n <resourceType>InstanceType</resourceType>\\n </Dimensions>\\n <QuotaUnit>AMOUNT</QuotaUnit>\\n <Period/>\\n <Adjustable>true</Adjustable>\\n <QuotaActionCode>ecs.g5.2xlarge</QuotaActionCode>\\n <QuotaName>ecs.g5.2xlarge</QuotaName>\\n <QuotaItems>\\n <Usage>0</Usage>\\n <Type>ReservedQuota</Type>\\n <Quota>0</Quota>\\n </QuotaItems>\\n <QuotaItems>\\n <Usage>0</Usage>\\n <Type>BaseQuota</Type>\\n <Quota>0</Quota>\\n </QuotaItems>\\n <QuotaArn>acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i</QuotaArn>\\n <TotalQuota>160</TotalQuota>\\n <ApplicableType>continuous</ApplicableType>\\n </Quotas>\\n <MaxResults>1</MaxResults>\\n</ListProductQuotasResponse>","errorExample":""}]',
- 'title' => '查询目标云产品的配额列表',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</CreateTemplateQuotaItemResponse>","errorExample":""}]',
],
- 'ListProducts' => [
- 'summary' => '查询配额中心支持的云产品列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteQuotaAlarm' => [
+ 'summary' => '删除配额用量告警。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
],
'parameters' => [
[
- 'name' => 'NextToken',
+ 'name' => 'AlarmId',
'in' => 'formData',
+ 'schema' => ['description' => '配额告警ID。'."\n"
+ ."\n"
+ .'> 关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~440561~~)。', 'type' => 'string', 'required' => true, 'example' => '6b512ab7-da3a-4142-b529-2b2a9294****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用来标记开始查询数据的位置。置空表示从头开始。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '4',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A95C65B3-7CF4-469E-B1D5-1CA0628A6411'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
+ ['errorCode' => 'ALARM.NOT.FOUND', 'errorMessage' => 'The AlarmId provided does not exist in our records.', 'description' => '配额预警不存在。'],
+ ],
+ ],
+ 'title' => '删除配额用量告警',
+ 'description' => '配额告警功能已升级,本API即将废弃,本API仅可删除旧版配额用量告警,若您想删除新版配额用量告警,请您使用云监控API [DeleteMetricRules](~~2513295~~)、[DeleteMetricRuleTargets](~~2513294~~)进行操作。'."\n"
+ .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteQuotaAlarm'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'quotas:DeleteQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A95C65B3-7CF4-469E-B1D5-1CA0628A6411\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteQuotaAlarmResponse>\\r\\n<RequestId>A95C65B3-7CF4-469E-B1D5-1CA0628A6411</RequestId>\\r\\n</DeleteQuotaAlarmResponse>","errorExample":""}]',
+ ],
+ 'DeleteTemplateQuotaItem' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREquotasC0TSBQ'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~200。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'example' => '4',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '配额项ID', 'description' => '配额模板ID。'."\n"
+ ."\n"
+ .'关于如何获取配额模板ID,请参见[ListQuotaApplicationTemplates](~~450403~~)。', 'type' => 'string', 'required' => true, 'example' => '1****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'NextToken' => [
- 'description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'ProductInfo' => [
- 'description' => '云产品信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CommonQuotaSupport' => [
- 'title' => '通用配额是否支持',
- 'description' => '是否支持通用配额。取值:'."\n"
- ."\n"
- .'- support:支持。'."\n"
- ."\n"
- .'- unsupport:不支持。',
- 'type' => 'string',
- 'example' => 'support',
- ],
- 'Dynamic' => [
- 'description' => '<notice>该参数废弃,不建议使用。></notice>'."\n"
- ."\n"
- .'是否支持动态调整配额。取值:'."\n"
- ."\n"
- .'- true'."\n"
- ."\n"
- .'- false',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FlowControlSupport' => [
- 'title' => '是否支持流程',
- 'description' => '是否支持API速率配额。取值:'."\n"
- ."\n"
- .'- support:支持。'."\n"
- ."\n"
- .'- unsupport:不支持。',
- 'type' => 'string',
- 'example' => 'unsupport',
- ],
- 'ProductCode' => [
- 'description' => '云产品名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'ProductName' => [
- 'description' => '云产品名称。',
- 'type' => 'string',
- 'example' => 'Elastic Compute Service (ECS)',
- ],
- 'ProductNameEn' => [
- 'description' => '云产品英文名称。',
- 'type' => 'string',
- 'example' => 'Elastic Compute Service',
- ],
- 'SecondCategoryId' => [
- 'description' => '产品类目ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'SecondCategoryName' => [
- 'description' => '产品类目名称。',
- 'type' => 'string',
- 'example' => 'Elastic Compute',
- ],
- 'SecondCategoryNameEn' => [
- 'description' => '产品类目英文名称。',
- 'type' => 'string',
- 'example' => 'Elastic Compute',
- ],
- 'WhiteListLabelQuotaSupport' => [
- 'description' => '是否支持权益配额。取值:'."\n"
- ."\n"
- .'- support:支持。'."\n"
- ."\n"
- .'- unsupport:不支持。',
- 'type' => 'string',
- 'example' => 'support',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1DA9C136-11BC-4C39-ADC6-B86276128072',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Id' => ['description' => '配额模板ID。', 'type' => 'string', 'example' => '1****'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 4,\\n \\"NextToken\\": \\"4\\",\\n \\"ProductInfo\\": [\\n {\\n \\"CommonQuotaSupport\\": \\"support\\",\\n \\"Dynamic\\": true,\\n \\"FlowControlSupport\\": \\"unsupport\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"Elastic Compute Service (ECS)\\",\\n \\"ProductNameEn\\": \\"Elastic Compute Service\\",\\n \\"SecondCategoryId\\": 5,\\n \\"SecondCategoryName\\": \\"Elastic Compute\\",\\n \\"SecondCategoryNameEn\\": \\"Elastic Compute\\",\\n \\"WhiteListLabelQuotaSupport\\": \\"support\\"\\n }\\n ],\\n \\"RequestId\\": \\"1DA9C136-11BC-4C39-ADC6-B86276128072\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListProductsResponse>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>云服务器ECS</ProductName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Elastic Compute Service</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>云服务器ECS规格配额</ProductName>\\r\\n\\t\\t<ProductCode>ecs-spec</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Ecs Quotas by Instance Type</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>弹性伸缩</ProductName>\\r\\n\\t\\t<ProductCode>ess</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Auto Scaling</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Security Management</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>操作审计</ProductName>\\r\\n\\t\\t<ProductCode>actiontrail</ProductCode>\\r\\n\\t\\t<SecondCategoryName>安全管理</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>21</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>ActionTrail</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<TotalCount>22</TotalCount>\\r\\n\\t<RequestId>16AD05A1-10E4-4048-AD9D-03BC6B9D5CDA</RequestId>\\r\\n\\t<NextToken>4</NextToken>\\r\\n\\t<MaxResults>4</MaxResults>\\r\\n</ListProductsResponse>\\t","errorExample":""}]',
- 'title' => '查询配额中心支持的云产品列表',
- 'description' => '查询结果与[支持配额中心的云产品](~~182368~~)相同。',
- ],
- 'ListDependentQuotas' => [
- 'summary' => '部分配额之间存在关联,关联配额最好同时提升,该接口返回某个配额关联的配额项列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '删除配额模板',
+ 'summary' => '管理账号删除配额模板后,如果资源目录新增成员,则配额模板不再自动为新增的成员提交配额提升申请。只有资源目录的管理员账号可删除配额模版。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplateQuotaItem'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'quotas:DeleteTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</DeleteTemplateQuotaItemResponse>","errorExample":""}]',
+ ],
+ 'GetProductQuota' => [
+ 'summary' => '查询目标云产品的配额详情。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1649,10 +936,7 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
],
'parameters' => [
[
@@ -1664,256 +948,265 @@
.'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
'type' => 'string',
'required' => true,
- 'example' => 'cloudsso',
+ 'enumValueTitles' => [],
+ 'example' => 'ecs',
],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取目标云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'example' => 'q_security-groups'],
+ ],
+ [
+ 'name' => 'Dimensions',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取目标云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'q_system-policy-per-access-configuration',
+ 'description' => '配额维度。'."\n"
+ .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
+ .'> 部分云产品维度必填。云产品的配额是什么,以及配额是否必填可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)获取,返回参数`Requisite`表示该维度是否必填。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数。您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数。您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'example' => '{\\"regionId\\":\\"cn-beijing\\"}',
+ 'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '无。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'Quotas' => [
- 'description' => '目标配额依赖的配额列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额依赖的配额列表。',
- 'type' => 'object',
- 'properties' => [
- 'Dimensions' => [
- 'description' => '目标配额依赖的配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额依赖的配额维度。',
- 'type' => 'object',
- 'properties' => [
- 'DependentDimension' => [
- 'description' => '目标配额依赖的配额维度所依赖的配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额依赖的配额维度所依赖的配额维度。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- ],
- 'DimensionKey' => [
- 'description' => '目标配额依赖的配额维度的Key。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'DimensionValues' => [
- 'description' => '目标配额依赖的配额维度所依赖的配额维度的Value。',
- 'type' => 'array',
- 'items' => [
- 'description' => '目标配额依赖的配额维度所依赖的配额维度的Value。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- ],
- ],
- ],
- ],
- 'ProductCode' => [
- 'description' => '云产品名称缩写。',
- 'type' => 'string',
- 'example' => 'ram',
+ 'Quota' => [
+ 'description' => '配额详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Adjustable' => ['description' => '配额是否可调整。取值:'."\n"
+ ."\n"
+ .'- true:可调整。'."\n"
+ ."\n"
+ .'- false:不可调整。', 'type' => 'boolean', 'example' => 'true'],
+ 'ApplicableRange' => [
+ 'description' => '配额调整范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额调整范围。例如:`[802,10000]`。', 'type' => 'number', 'format' => 'float', 'example' => '802'],
+ ],
+ 'ApplicableType' => ['description' => '配额调整类型。取值:'."\n"
+ ."\n"
+ .'- continuous:连续。'."\n"
+ ."\n"
+ .'- discontinuous:间断。', 'type' => 'string', 'example' => 'continuous'],
+ 'ApplyReasonTips' => ['description' => '申请配额调整理由示例。', 'type' => 'string', 'example' => 'The business xxx is expected to grow by 50%.'],
+ 'Consumable' => ['description' => '是否显示“已使用”的配额。取值:'."\n"
+ ."\n"
+ .'- true:显示“已使用”的配额。'."\n"
+ ."\n"
+ .'- false:不显示“已使用”的配额。', 'type' => 'boolean', 'example' => 'true'],
+ 'Dimensions' => ['description' => '配额维度。格式:`{"regionId":"地域"}`。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => '配额生效的UTC时间。', 'type' => 'string', 'example' => '2022-09-28T06:06:00Z'],
+ 'ExpireTime' => ['description' => '配额失效的UTC时间。', 'type' => 'string', 'example' => '2022-09-29T06:06:00Z'],
+ 'GlobalQuota' => ['description' => '是否为全局配额。取值:'."\n"
+ .'- true:该配额项为所有Region共用。'."\n"
+ .'- false:该配额项为每个Region独立。', 'type' => 'boolean', 'example' => 'true'],
+ 'Period' => [
+ 'description' => '配额周期。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['description' => '配额周期的单位。取值:'."\n"
+ ."\n"
+ .'- second:秒。'."\n"
+ ."\n"
+ .'- minute:分钟。'."\n"
+ ."\n"
+ .'- hour:小时。'."\n"
+ ."\n"
+ .'- day:天。'."\n"
+ ."\n"
+ .'- week:周。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'day'],
+ 'PeriodValue' => ['description' => '配额周期的取值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
- 'QuotaActionCode' => [
- 'description' => '目标配额依赖的配额ID。',
- 'type' => 'string',
- 'example' => 'q_laxtn4',
+ ],
+ 'ProductCode' => ['description' => '云产品名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/'],
+ 'QuotaCategory' => ['description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ ."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ ."\n"
+ .'- WhiteListLabel:权益配额。', 'type' => 'string', 'example' => 'CommonQuota'],
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of security groups that can be owned by the current account.'],
+ 'QuotaItems' => [
+ 'description' => '配额详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额类别。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Quota' => ['description' => '配额值。', 'type' => 'string', 'example' => '801'],
+ 'QuotaUnit' => ['description' => '配额单位。'."\n"
+ ."\n"
+ .'> 每个配额的单位不同。例如:容器服务Kubernetes版的配额`q_cbdch3`(最大集群数)单位为Cluster,云服务器ECS的配额`q_security-groups`(安全组总数量上限)单位为个。', 'type' => 'string', 'example' => 'Count'],
+ 'Type' => ['description' => '配额类别。取值:'."\n"
+ ."\n"
+ .'- BaseQuota:保障配额。'."\n"
+ ."\n"
+ .'- ReservedQuota:预留配额。', 'type' => 'string', 'example' => 'BaseQuota'],
+ 'Usage' => ['description' => '配额用量。', 'type' => 'string', 'example' => '26'],
+ ],
],
- 'Scale' => [
- 'description' => '目标配额与依赖配额的关系比例。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
+ ],
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'Maximum Number of Security Groups'],
+ 'QuotaType' => ['description' => '配额类型。取值:'."\n"
+ ."\n"
+ .'- privilege:特权。'."\n"
+ ."\n"
+ .'- normal:普通。', 'type' => 'string', 'example' => 'normal'],
+ 'QuotaUnit' => ['description' => '配额单位。'."\n"
+ ."\n"
+ .'> 每个配额的单位不同。例如:容器服务Kubernetes版的配额`q_cbdch3`(最大集群数)单位为Cluster,云服务器ECS的配额`q_security-groups`(安全组总数量上限)单位为个。', 'type' => 'string', 'example' => 'Count'],
+ 'SupportedRange' => [
+ 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。',
+ 'type' => 'array',
+ 'items' => ['description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。'."\n"
+ ."\n"
+ .'- 当ApplicableType为continuous时,如果取值为[802,1000],则表示取值为802~1000中的所有整数。'."\n"
+ ."\n"
+ .'- 当ApplicableType为discontinuous时,如果取值为[10,20,50,100],则表示取值仅为10、20、50和100。', 'type' => 'number', 'format' => 'float', 'example' => '[802,1000]'],
+ ],
+ 'TotalQuota' => ['description' => '配额值。', 'type' => 'number', 'format' => 'float', 'example' => '801'],
+ 'TotalUsage' => ['description' => '配额用量。', 'type' => 'number', 'format' => 'float', 'example' => '26'],
+ 'UnadjustableDetail' => ['description' => '配额不可调整原因。取值:'."\n"
+ ."\n"
+ .'- nonactivated:未开通服务。'."\n"
+ ."\n"
+ .'- applicationProcess:配额申请处理中。'."\n"
+ ."\n"
+ .'- limitReached:已达配额上限。'."\n"
+ ."\n"
+ .'- supportTicketRequired:需要提工单申请。', 'type' => 'string', 'example' => 'limitReached'],
+ 'UsageMetric' => [
+ 'description' => '配额用量在云监控(CloudMonitor)中的监控信息。'."\n"
+ ."\n"
+ .'> 空表示云监控中无此配额监控数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetricDimensions' => [
+ 'description' => 'CloudMonitor监控维度。'."\n"
+ ."\n"
+ .'格式:`key:value`键值对形式的集合,例如:'."\n"
+ .'`{"productCode":"***","metricKey":"***","regionId":"***","label":"***"}`。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => 'CloudMonitor监控维度值。', 'example' => 'ecs'],
+ ],
+ 'MetricName' => ['description' => 'CloudMonitor监控项名称。', 'type' => 'string', 'example' => 'Usage'],
+ 'MetricNamespace' => ['description' => 'CloudMonitor监控数据命名空间。', 'type' => 'string', 'example' => 'acs_quotas_flowcontrol'],
],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '920D8A47-26BB-49FA-A09F-F98D7DAA55F3',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Quotas\\": [\\n {\\n \\"Dimensions\\": [\\n {\\n \\"DependentDimension\\": [\\n \\"[]\\"\\n ],\\n \\"DimensionKey\\": \\"[]\\",\\n \\"DimensionValues\\": [\\n \\"[]\\"\\n ]\\n }\\n ],\\n \\"ProductCode\\": \\"ram\\",\\n \\"QuotaActionCode\\": \\"q_laxtn4\\",\\n \\"Scale\\": 100\\n }\\n ],\\n \\"RequestId\\": \\"920D8A47-26BB-49FA-A09F-F98D7DAA55F3\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDependentQuotasResponse>\\r\\n\\t<RequestId>B871952D-ACA9-4641-B21A-713B08A5270A</RequestId>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_fh20b0</QuotaActionCode>\\r\\n\\t\\t<ProductCode>slb</ProductCode>\\r\\n\\t</Quotas>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_3mmbsp</QuotaActionCode>\\r\\n\\t\\t<ProductCode>slb</ProductCode>\\r\\n\\t</Quotas>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_elastic-network-interfaces</QuotaActionCode>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<DimensionKey>regionId</DimensionKey>\\r\\n\\t\\t\\t<DimensionValues>cn-shenzhen</DimensionValues>\\r\\n\\t\\t\\t<DimensionValues>cn-beijing</DimensionValues>\\r\\n\\t\\t\\t<DimensionValues>cn-hangzhou</DimensionValues>\\r\\n\\t\\t</Dimensions>\\r\\n\\t</Quotas>\\r\\n</ListDependentQuotasResponse>\\t","errorExample":""}]',
- 'title' => '查询目标配额依赖的配额列表',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询目标云产品的配额详情',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateQuotaAlarm' => [
- 'summary' => '创建配额告警。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProductQuota'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetProductQuota',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Quota\\": {\\n \\"Adjustable\\": true,\\n \\"ApplicableRange\\": [\\n 802\\n ],\\n \\"ApplicableType\\": \\"continuous\\",\\n \\"ApplyReasonTips\\": \\"The business xxx is expected to grow by 50%.\\",\\n \\"Consumable\\": true,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:06:00Z\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:06:00Z\\",\\n \\"GlobalQuota\\": true,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaItems\\": [\\n {\\n \\"Quota\\": \\"801\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"Type\\": \\"BaseQuota\\",\\n \\"Usage\\": \\"26\\"\\n }\\n ],\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaType\\": \\"normal\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"SupportedRange\\": [\\n 0\\n ],\\n \\"TotalQuota\\": 801,\\n \\"TotalUsage\\": 26,\\n \\"UnadjustableDetail\\": \\"limitReached\\",\\n \\"UsageMetric\\": {\\n \\"MetricDimensions\\": {\\n \\"key\\": \\"ecs\\"\\n },\\n \\"MetricName\\": \\"Usage\\",\\n \\"MetricNamespace\\": \\"acs_quotas_flowcontrol\\"\\n }\\n },\\n \\"RequestId\\": \\"8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProductQuotaResponse>\\r\\n\\t<RequestId>8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3</RequestId>\\r\\n\\t<Quota>\\r\\n\\t\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\r\\n\\t\\t<Consumable>true</Consumable>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<TotalUsage>26</TotalUsage>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<Adjustable>true</Adjustable>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<QuotaName>安全组总数量上限</QuotaName>\\r\\n\\t\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\r\\n\\t\\t<TotalQuota>801</TotalQuota>\\r\\n\\t\\t<ApplicableType>continuous</ApplicableType>\\r\\n\\t\\t<ApplicableRange>802</ApplicableRange>\\r\\n\\t\\t<ApplicableRange>10000</ApplicableRange>\\r\\n\\t</Quota>\\r\\n</GetProductQuotaResponse>\\t","errorExample":""}]',
+ ],
+ 'GetProductQuotaDimension' => [
+ 'summary' => '查询目标云产品支持的配额维度详情。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasF0DSPH'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'config',
- ],
- ],
- [
- 'name' => 'QuotaActionCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'q_hvnoqv',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'disk'],
],
[
- 'name' => 'AlarmName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'q_hvnoqv alarm',
- ],
- ],
- [
- 'name' => 'ThresholdType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警类型。取值:'."\n"
- ."\n"
- .'- used(默认值):已使用量告警。'."\n"
- .'- usable:剩余可用量告警。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'used',
- 'default' => 'used',
- 'enum' => [
- 'used',
- 'usable',
- ],
- ],
- ],
- [
- 'name' => 'Threshold',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警阈值的数值。取值:'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设数值,您会收到告警通知。配额告警阈值必须大于配额的已使用量。'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设数值,您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。'."\n"
- ."\n"
- .'> 该参数与ThresholdPercent必须设置一个。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '150',
- ],
- ],
- [
- 'name' => 'ThresholdPercent',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警阈值的百分比。取值:'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设百分比,您会收到告警通知。取值范围:(50%, 100%]。'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设百分比,您会收到告警通知。取值范围:(0%, 50%]。'."\n"
- ."\n"
- .'> 该参数与Threshold必须设置一个。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '50',
- 'example' => '50',
- ],
- ],
- [
- 'name' => 'WebHook',
+ 'name' => 'DimensionKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://alert.aliyun.com/callback',
- ],
+ 'schema' => ['description' => '目标配额维度的Key。'."\n"
+ ."\n"
+ .'> 当目标配额维度有依赖配额维度时,依赖配额维度的Key和Value必须设置,且需要同时设置。', 'type' => 'string', 'required' => false, 'example' => 'zoneId'],
],
[
- 'name' => 'QuotaDimensions',
+ 'name' => 'DependentDimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '配额维度。'."\n"
- .'配额项的属性,维度`Dimensions`+配额ID`QuotaActionCode`确定唯一的配额项。'."\n"
- .'> 部分云产品维度必填,可以通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度, 返回参数`Requisite`表示该维度是否必填。',
+ 'description' => '目标配额维度依赖的配额维度。',
'type' => 'array',
'items' => [
- 'description' => '无。',
+ 'description' => '目标配额维度依赖的配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,可通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .' > `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,可通过[ListProductQuotaDimensions](~~440553~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '目标配额维度依赖的配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于目标配额维度依赖的配额维度的个数。'."\n"
+ .'> - 依赖配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '目标配额维度依赖的配额维度的Value。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于目标配额维度依赖的配额维度的个数。'."\n"
+ .'> - 依赖配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
@@ -1921,313 +1214,294 @@
'maxItems' => 5,
],
],
- [
- 'name' => 'OriginalContext',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '产品支持的配额维度详情列表。',
'type' => 'object',
'properties' => [
- 'AlarmId' => [
- 'description' => '告警ID。',
- 'type' => 'string',
- 'example' => '18b3be23-b7b0-4d45-91bc-d0c331aa****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'BD219E2B-E687-45EE-B5F3-61FB730551B1',
+ 'QuotaDimension' => [
+ 'description' => '配额维度详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DependentDimensions' => [
+ 'description' => '目标配额依赖云服务的配额维度。',
+ 'type' => 'array',
+ 'items' => ['description' => '目标配额依赖云服务的配额维度。', 'type' => 'string', 'example' => 'regionId'],
+ ],
+ 'DimensionKey' => ['description' => '配额维度的Key。取值:'."\n"
+ .'- regionId:地域。'."\n"
+ ."\n"
+ .'- zoneId:可用区。'."\n"
+ ."\n"
+ .'- chargeType:付费类型。'."\n"
+ ."\n"
+ .'- networkType:网络类型。'."\n"
+ ."\n"
+ .'- resourceType:资源类型。', 'type' => 'string', 'example' => 'zoneId'],
+ 'DimensionValueDetail' => [
+ 'description' => '配额维度Value的详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度Value的详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '配额维度Value的名称。', 'type' => 'string', 'example' => 'cn-hangzhou-b'],
+ 'Value' => ['description' => '配额维度Value的值。', 'type' => 'string', 'example' => 'cn-hangzhou-b'],
+ ],
+ ],
+ ],
+ 'DimensionValues' => [
+ 'description' => '配额维度Value的列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额维度Value的列表。', 'type' => 'string', 'example' => '["cn-hangzhou-b", "cn-hangzhou-e", "cn-hangzhou-f", "cn-hangzhou-g", "cn-hangzhou-h", "cn-hangzhou-i", "cn-hangzhou-j", "cn-hangzhou-k"]'],
+ ],
+ 'Name' => ['description' => '配额维度的名称。', 'type' => 'string', 'example' => 'Zone'],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'QUOTA.UNSUPPORT.ALARM',
- 'errorMessage' => 'This quota does not support creating alarm',
- ],
- [
- 'errorCode' => 'ALARM.NAME.REPEAT',
- 'errorMessage' => 'The warning name must be unique.',
- ],
- [
- 'errorCode' => 'QUOTA.ALARM.MAX',
- 'errorMessage' => 'Quota alarm have reached the upper limit of 100',
- ],
- [
- 'errorCode' => 'UNSUPPORTED.ALARM.TYPE',
- 'errorMessage' => 'Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.',
- ],
- [
- 'errorCode' => 'THRESHOLD.ILLEGAL',
- 'errorMessage' => 'The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].',
- ],
- [
- 'errorCode' => 'QUOTA.OFFLINE',
- 'errorMessage' => 'The quota has been offline.',
+ 'title' => '查询目标云产品支持的配额维度详情',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProductQuotaDimension'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetProductQuotaDimension',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmId\\": \\"18b3be23-b7b0-4d45-91bc-d0c331aa****\\",\\n \\"RequestId\\": \\"BD219E2B-E687-45EE-B5F3-61FB730551B1\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaAlarmResponse>\\n\\t\\t<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>\\n\\t\\t<RequestId>88BAD9A9-0C47-4139-8531-08CB333F3384</RequestId>\\n</CreateQuotaAlarmResponse>","errorExample":""}]',
- 'title' => '创建配额用量告警',
- 'description' => '配额告警功能已升级,本API即将废弃,请您使用云监控API [PutResourceMetricRules](~~2513316~~)、[PutMetricRuleTargets](~~2513302~~)对新版配额告警规则进行创建。'."\n"
- .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaDimension\\": {\\n \\"DependentDimensions\\": [\\n \\"regionId\\"\\n ],\\n \\"DimensionKey\\": \\"zoneId\\",\\n \\"DimensionValueDetail\\": [\\n {\\n \\"Name\\": \\"cn-hangzhou-b\\",\\n \\"Value\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"DimensionValues\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\", \\\\\\"cn-hangzhou-e\\\\\\", \\\\\\"cn-hangzhou-f\\\\\\", \\\\\\"cn-hangzhou-g\\\\\\", \\\\\\"cn-hangzhou-h\\\\\\", \\\\\\"cn-hangzhou-i\\\\\\", \\\\\\"cn-hangzhou-j\\\\\\", \\\\\\"cn-hangzhou-k\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"Zone\\"\\n },\\n \\"RequestId\\": \\"1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3\\"\\n}","errorExample":""},{"type":"xml","example":"<GetProductQuotaDimensionResponse>\\r\\n\\t<RequestId>1FA5F0E2-368E-4BA4-A8D0-6060FC6BB8F3</RequestId>\\r\\n\\t<QuotaDimension>\\r\\n\\t\\t<DimensionKey>regionId</DimensionKey>\\r\\n\\t\\t<DimensionValues>cn-shenzhen</DimensionValues>\\r\\n\\t\\t<DimensionValues>cn-beijing</DimensionValues>\\r\\n\\t\\t<DimensionValues>cn-hangzhou</DimensionValues>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-shenzhen</Value>\\r\\n\\t\\t\\t<Name>cn-shenzhen</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-beijing</Value>\\r\\n\\t\\t\\t<Name>cn-beijing</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<DimensionValueDetail>\\r\\n\\t\\t\\t<Value>cn-hangzhou</Value>\\r\\n\\t\\t\\t<Name>cn-hangzhou</Name>\\r\\n\\t\\t</DimensionValueDetail>\\r\\n\\t\\t<Name>region</Name>\\r\\n\\t</QuotaDimension>\\r\\n</GetProductQuotaDimensionResponse>\\t","errorExample":""}]',
],
- 'DeleteQuotaAlarm' => [
- 'summary' => '删除配额用量告警。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQuotaAlarm' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
],
'parameters' => [
[
'name' => 'AlarmId',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警ID。'."\n"
- ."\n"
- .'> 关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~440561~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6b512ab7-da3a-4142-b529-2b2a9294****',
- ],
+ 'schema' => ['description' => '配额告警ID。'."\n"
+ ."\n"
+ .'关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~184348~~)。', 'type' => 'string', 'required' => false, 'example' => '78d7e436-4b25-4897-84b5-d7b656bb****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A95C65B3-7CF4-469E-B1D5-1CA0628A6411',
+ 'QuotaAlarm' => [
+ 'description' => '配额告警详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AlarmId' => ['description' => '配额告警ID。', 'type' => 'string', 'example' => '78d7e436-4b25-4897-84b5-d7b656bb****'],
+ 'AlarmName' => ['description' => '配额告警名称。', 'type' => 'string', 'example' => 'q_security-groups alarm'],
+ 'CreateTime' => ['description' => '配额告警创建时间。', 'type' => 'string', 'example' => '2021-01-21T03:47:28Z'],
+ 'NotifyChannels' => [
+ 'description' => '告警通知渠道。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额告警通知渠道。取值:'."\n"
+ ."\n"
+ .'- sms:短信。'."\n"
+ ."\n"
+ .'- email:邮箱。', 'type' => 'string', 'example' => '["sms", "email"]'],
+ ],
+ 'NotifyTarget' => ['description' => '配额告警通知对象。', 'type' => 'string', 'example' => 'accountContact'],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaDimension' => ['description' => '配额维度。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'QuotaUsage' => ['description' => '配额用量。', 'type' => 'number', 'format' => 'float', 'example' => '28'],
+ 'QuotaValue' => ['description' => '配额值。', 'type' => 'number', 'format' => 'float', 'example' => '804'],
+ 'Threshold' => ['description' => '配额告警阈值的数值。', 'type' => 'number', 'format' => 'float', 'example' => '29'],
+ 'ThresholdPercent' => ['description' => '配额告警阈值的百分比。', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'ThresholdType' => ['description' => '配额告警类型。取值:'."\n"
+ ."\n"
+ .'- used:配额已使用量告警。'."\n"
+ .'- usable:配额剩余可用量告警。', 'type' => 'string', 'example' => 'used'],
+ 'Webhook' => ['description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。', 'type' => 'string', 'example' => 'https://alert.aliyun.com/callback'],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '81B9D511-F3DD-43B1-9A81-1795DDB52ADF'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- [
- 'errorCode' => 'ALARM.NOT.FOUND',
- 'errorMessage' => 'The AlarmId provided does not exist in our records.',
- ],
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
+ ['errorCode' => 'ALARM.NOT.FOUND', 'errorMessage' => 'The AlarmId provided does not exist in our records.', 'description' => '配额预警不存在。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A95C65B3-7CF4-469E-B1D5-1CA0628A6411\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteQuotaAlarmResponse>\\r\\n<RequestId>A95C65B3-7CF4-469E-B1D5-1CA0628A6411</RequestId>\\r\\n</DeleteQuotaAlarmResponse>","errorExample":""}]',
- 'title' => '删除配额用量告警',
- 'description' => '配额告警功能已升级,本API即将废弃,本API仅可删除旧版配额用量告警,若您想删除新版配额用量告警,请您使用云监控API [DeleteMetricRules](~~2513295~~)、[DeleteMetricRuleTargets](~~2513294~~)进行操作。'."\n"
- .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
+ 'title' => '查询配额用量告警详情',
+ 'summary' => '查询目标配额告警详情。',
+ 'description' => '配额告警功能已升级,本API即将废弃,本API仅可查询旧版配额用量告警详情,若您想查询新版配额用量告警详情,请您使用云监控API [DescribeMetricRuleList](~~2513291~~)进行操作。使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UpdateQuotaAlarm' => [
- 'summary' => '修改配额告警信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaAlarm'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaAlarm\\": {\\n \\"AlarmId\\": \\"78d7e436-4b25-4897-84b5-d7b656bb****\\",\\n \\"AlarmName\\": \\"q_security-groups alarm\\",\\n \\"CreateTime\\": \\"2021-01-21T03:47:28Z\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"sms\\\\\\", \\\\\\"email\\\\\\"]\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaDimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"QuotaUsage\\": 28,\\n \\"QuotaValue\\": 804,\\n \\"Threshold\\": 29,\\n \\"ThresholdPercent\\": 50,\\n \\"ThresholdType\\": \\"used\\",\\n \\"Webhook\\": \\"https://alert.aliyun.com/callback\\"\\n },\\n \\"RequestId\\": \\"81B9D511-F3DD-43B1-9A81-1795DDB52ADF\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQuotaAlarmResponse>\\r\\n\\t<RequestId>81B9D511-F3DD-43B1-9A81-1795DDB52ADF</RequestId>\\r\\n\\t<QuotaAlarm>\\r\\n\\t\\t<AlarmId>78d7e436-4b25-4897-84b5-d7b656bb****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<QuotaValue>804</QuotaValue>\\r\\n\\t\\t<AlarmName> 安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-21T03:47:28Z</CreateTime>\\r\\n\\t\\t<QuotaDimension>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</QuotaDimension>\\r\\n\\t\\t<QuotaUsage>28</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n <ThresholdType>used</ThresholdType>\\r\\n\\t</QuotaAlarm>\\r\\n</GetQuotaAlarmResponse>\\t","errorExample":""}]',
+ ],
+ 'GetQuotaApplication' => [
+ 'summary' => '查询配额提升申请详情。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotas29QQRO'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AlarmId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警ID。'."\n"
- ."\n"
- .'> 关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~440561~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a2efa7fc-832f-47bb-8054-39e28012****',
- ],
- ],
- [
- 'name' => 'AlarmName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警名称。'."\n"
- ."\n"
- .'> 关于如何获取配额告警名称,请参见[ListQuotaAlarms](~~440561~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'rules',
- ],
- ],
- [
- 'name' => 'ThresholdType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警类型。取值:'."\n"
- ."\n"
- .'- used(默认值):已使用量告警。'."\n"
- .'- usable:剩余可用量告警。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'usable',
- 'default' => 'used',
- 'enum' => [
- 'used',
- 'usable',
- ],
- ],
- ],
- [
- 'name' => 'Threshold',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警阈值的数值。取值:'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设数值,您会收到告警通知。配额告警阈值必须大于配额的已使用量。'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设数值,您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。'."\n"
- ."\n"
- .'> 该参数与ThresholdPercent必须设置一个。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '160',
- ],
- ],
- [
- 'name' => 'ThresholdPercent',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警阈值的百分比。取值:'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设百分比,您会收到告警通知。取值范围:(50%, 100%]。'."\n"
- ."\n"
- .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设百分比,您会收到告警通知。取值范围:(0%, 50%]。'."\n"
- ."\n"
- .'> 该参数与Threshold必须设置一个',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '50',
- 'example' => '51',
- ],
- ],
- [
- 'name' => 'WebHook',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://alert.aliyun.com/callback',
- ],
+ 'schema' => ['description' => '配额提升申请ID。', 'type' => 'string', 'required' => false, 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A95C65B3-7CF4-469E-B1D5-1CA0628A6411',
+ 'QuotaApplication' => [
+ 'description' => '配额提升申请详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationId' => ['description' => '配额提升申请ID。', 'type' => 'string', 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
+ 'ApplyTime' => ['description' => '配额提升申请时间。', 'type' => 'string', 'example' => '2021-01-19T09:25:56Z'],
+ 'ApproveValue' => ['description' => '配额审批额度。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
+ 'AuditReason' => ['description' => '配额提升申请审批意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'DesireValue' => ['description' => '配额提升申请值。', 'type' => 'integer', 'format' => 'int32', 'example' => '804'],
+ 'Dimension' => ['description' => '配额维度。'."\n"
+ ."\n"
+ .'格式:`{"regionId":"地域"}`。', 'type' => 'object', 'example' => '["cn-shanghai","cn-hangzhou"]'],
+ 'EffectiveTime' => ['description' => '配额生效时间。', 'type' => 'string', 'example' => '2021-01-19 15:30:00'],
+ 'ExpireTime' => ['description' => '配额过期时间。', 'type' => 'string', 'example' => '2023-06-29 15:30:00'],
+ 'NoticeType' => ['description' => '通知类型。取值:'."\n"
+ ."\n"
+ .'- 0:无需通知。'."\n"
+ .'- 1:邮件通知。'."\n"
+ .'- 2:短信通知。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/'],
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of security groups that can be owned by the current account.'],
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'Maximum Number of Security Groups'],
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'AMOUNT'],
+ 'Reason' => ['description' => '配额提升申请原因。', 'type' => 'string', 'example' => 'Scale Out'],
+ 'Status' => ['description' => '配额提升申请的审批状态。取值:'."\n"
+ ."\n"
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。', 'type' => 'string', 'example' => 'Agree'],
+ 'QuotaCategory' => ['description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。', 'type' => 'string', 'example' => 'CommonQuota'],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BBD1D37-094C-4485-8B7D-64682F82BC18'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- [
- 'errorCode' => 'UNSUPPORTED.ALARM.TYPE',
- 'errorMessage' => 'Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.',
- ],
- [
- 'errorCode' => 'THRESHOLD.ILLEGAL',
- 'errorMessage' => 'The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].',
- ],
- [
- 'errorCode' => 'ALARM.NAME.REPEAT',
- 'errorMessage' => 'The warning name must be unique.',
- ],
- [
- 'errorCode' => 'ALARM.NOT.FOUND',
- 'errorMessage' => 'The AlarmId provided does not exist in our records.',
- ],
- [
- 'errorCode' => 'THRESHOLD.MAx.ILLEGAL',
- 'errorMessage' => 'The quota warning threshold cannot be greater than the current quota.',
- ],
+ ['errorCode' => 'QUOTA.APPLICATION.NOT.FOUND', 'errorMessage' => 'Quota application does not exist', 'description' => '配额申请不存在。'],
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A95C65B3-7CF4-469E-B1D5-1CA0628A6411\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateQuotaAlarmResponse>\\r\\n\\t<RequestId>2542826A-B67E-42C7-B1CB-2F5B52CDE9A8</RequestId>\\r\\n</UpdateQuotaAlarmResponse>","errorExample":""}]',
- 'title' => '修改配额用量告警信息',
- 'description' => '配额告警功能已升级,本API即将废弃,请您使用云监控API [PutResourceMetricRules](~~2513316~~)、[PutMetricRuleTargets](~~2513302~~)修改新版配额用量告警信息。'."\n"
- .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
+ 'title' => '查询配额提升申请详情',
+ 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListQuotaAlarms' => [
- 'summary' => '查询配额用量告警列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaApplication'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaApplication', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaApplication\\": {\\n \\"ApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"ApplyTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ApproveValue\\": 10,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"DesireValue\\": 804,\\n \\"Dimension\\": [\\n \\"cn-shanghai\\",\\n \\"cn-hangzhou\\"\\n ],\\n \\"EffectiveTime\\": \\"2021-01-19 15:30:00\\",\\n \\"ExpireTime\\": \\"2023-06-29 15:30:00\\",\\n \\"NoticeType\\": 0,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"Reason\\": \\"Scale Out\\",\\n \\"Status\\": \\"Agree\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\"\\n },\\n \\"RequestId\\": \\"7BBD1D37-094C-4485-8B7D-64682F82BC18\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaApplicationResponse>\\r\\n\\t<Status>Process</Status>\\r\\n\\t<ApplyTime>2021-11-11T03:24:39Z</ApplyTime>\\r\\n\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\r\\n\\t<RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\r\\n\\t<ProductCode>ecs</ProductCode>\\r\\n\\t<Dimension>\\r\\n\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t</Dimension>\\r\\n\\t<ApproveValue>1007</ApproveValue>\\r\\n\\t<Reason>扩容</Reason>\\r\\n\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t<QuotaName>安全组总数量上限</QuotaName>\\r\\n\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\r\\n\\t<NoticeType>0</NoticeType>\\r\\n\\t<ApplicationId>d314d6ae-867d-484c-9009-3d421a80****</ApplicationId>\\r\\n\\t<DesireValue>804</DesireValue>\\r\\n</CreateQuotaApplicationResponse>\\t","errorExample":""}]',
+ ],
+ 'GetQuotaApplicationApproval' => [
+ 'summary' => '查询配额申请单审批信息。其中包含:平均审批时间、是否支持审批提醒和审批提醒间隔时间等。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2239,268 +1513,92 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
],
'parameters' => [
[
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记开始读取数据的位置。'."\n"
- ."\n"
- .'> 不设置该参数,表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '本次读取的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~200。默认值:30。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'example' => '20',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'ProductCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
- ],
- [
- 'name' => 'AlarmName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额用量告警名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_hvnoqv alarm',
- ],
- ],
- [
- 'name' => 'QuotaActionCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> - 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。'."\n"
- .'> - 如果已设置本参数,则`ProductCode`必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_hvnoqv',
- ],
- ],
- [
- 'name' => 'QuotaDimensions',
+ 'name' => 'ApplicationId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
+ 'schema' => ['title' => '申请单 id', 'description' => '配额申请单ID。'."\n"
+ ."\n"
+ .'关于如何获取配额申请单ID,请参见[ListQuotaApplications](~~440568~~)。', 'type' => 'string', 'required' => false, 'example' => 'd314d6ae-867d-484c-9009-3d42****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '无。',
+ 'title' => 'PopResultDTO<QuotaApplicationApprovalVO>',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次请求返回的最大记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NextToken' => [
- 'description' => '用来标记当前调用返回读取到的位置。'."\n"
- ."\n"
- .'> 该参数返回为空,表示数据已读取完毕。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'QuotaAlarms' => [
- 'description' => '配额用量告警详情。',
+ 'AllowRetry' => ['description' => '是否允许重试。取值:'."\n"
+ .'- false:不允许重试。'."\n"
+ .'- true:允许重试。', 'type' => 'boolean', 'example' => 'false'],
+ 'DynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'PARAMETER.ILLEGALL'],
+ 'DynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'Parameter[%s] is required.'],
+ 'ErrorArgs' => [
+ 'description' => '错误的参数组。',
'type' => 'array',
- 'items' => [
- 'description' => '配额用量告警详情。',
- 'type' => 'object',
- 'properties' => [
- 'AlarmId' => [
- 'description' => '告警ID。',
- 'type' => 'string',
- 'example' => 'a2efa7fc-832f-47bb-8054-39e28012****',
- ],
- 'AlarmName' => [
- 'description' => '告警名称。',
- 'type' => 'string',
- 'example' => 'q_hvnoqv alarm',
- ],
- 'CreateTime' => [
- 'description' => '创建配额用量告警的时间。',
- 'type' => 'string',
- 'example' => '2020-11-27T07:23:34Z',
- ],
- 'ExceedThreshold' => [
- 'description' => '是否达到配额告警阈值。取值:'."\n"
- ."\n"
- .'- false'."\n"
- ."\n"
- .'- true',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'NotifyChannels' => [
- 'description' => '配额告警通知渠道。',
- 'type' => 'array',
- 'items' => [
- 'description' => '告警通知渠道。取值:'."\n"
- ."\n"
- .'- sms:短消息。'."\n"
- ."\n"
- .'- email:电子邮件。',
- 'type' => 'string',
- 'example' => 'sms',
- ],
- ],
- 'NotifyTarget' => [
- 'description' => '告警通知对象。'."\n"
- .'> 目前仅支持取值:accountContact。表示配置的账号联系人',
- 'type' => 'string',
- 'example' => 'accountContact',
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'config',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_hvnoqv',
- ],
- 'QuotaDimensions' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'QuotaUsage' => [
- 'description' => '已使用配额。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '73',
- ],
- 'QuotaValue' => [
- 'description' => '配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '200',
- ],
- 'Threshold' => [
- 'description' => '配额用量告警阈值的数值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '160',
- ],
- 'ThresholdPercent' => [
- 'description' => '配额用量告警阈值的百分比。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '80',
- ],
- 'ThresholdType' => [
- 'description' => '配额告警类型。取值:'."\n"
- ."\n"
- .'- used:已使用量告警。'."\n"
- .'- usable:剩余可用量告警。',
- 'type' => 'string',
- 'example' => 'used',
- ],
- 'WebHook' => [
- 'description' => 'Webhook地址。',
- 'type' => 'string',
- 'example' => 'https://www.aliyun.com/webhook',
- ],
- ],
- ],
+ 'items' => ['description' => '错误的参数。', 'type' => 'any', 'example' => 'ApplicationId'],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '87F3B755-3BD2-4C76-B36A-93247002918C',
- ],
- 'TotalCount' => [
- 'description' => '配额用量告警总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'RAM.PERMISSION.DENIED'],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to do this action or the API input parameter is invalid.'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Module' => [
+ 'description' => '返回对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApprovalHours' => ['description' => '配额申请单平均审批时间。单位:小时。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'ReminderIntervalHours' => ['description' => '配额申请单的审批提醒间隔时间。单位:小时。', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'SupportReminder' => ['title' => '是否支持审批提醒', 'description' => '配额申请单是否支持审批提醒。取值:'."\n"
+ .'- false:不支持。'."\n"
+ .'- true:支持。', 'type' => 'boolean', 'example' => 'false'],
+ 'UnsupportReminderReason' => ['description' => '配额申请单不支持审批提醒的原因说明。', 'type' => 'string', 'example' => 'can only be remind once within the interval'],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7ED584FB-ECBF-4A2A-969D-F54D25EFABF9'],
+ 'Success' => ['description' => '是否调用成功。取值:'."\n"
+ ."\n"
+ .'- true:调用成功。'."\n"
+ .'- false:调用失败。', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaAlarms\\": [\\n {\\n \\"AlarmId\\": \\"a2efa7fc-832f-47bb-8054-39e28012****\\",\\n \\"AlarmName\\": \\"q_hvnoqv alarm\\",\\n \\"CreateTime\\": \\"2020-11-27T07:23:34Z\\",\\n \\"ExceedThreshold\\": false,\\n \\"NotifyChannels\\": [\\n \\"sms\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"config\\",\\n \\"QuotaActionCode\\": \\"q_hvnoqv\\",\\n \\"QuotaDimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"QuotaUsage\\": 73,\\n \\"QuotaValue\\": 200,\\n \\"Threshold\\": 160,\\n \\"ThresholdPercent\\": 80,\\n \\"ThresholdType\\": \\"used\\",\\n \\"WebHook\\": \\"https://www.aliyun.com/webhook\\"\\n }\\n ],\\n \\"RequestId\\": \\"87F3B755-3BD2-4C76-B36A-93247002918C\\",\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListQuotaAlarmsResponse>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<QuotaAlarms>\\r\\n\\t\\t<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_hvnoqv</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<QuotaValue>200</QuotaValue>\\r\\n\\t\\t<QuotaDimensions/>\\r\\n\\t\\t<AlarmName>规则创建数量告警</AlarmName>\\r\\n\\t\\t<ProductCode>config</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2020-11-27T07:23:34Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>73</QuotaUsage>\\r\\n\\t\\t<ExceedThreshold>false</ExceedThreshold>\\r\\n\\t\\t<Threshold>160</Threshold>\\r\\n\\t</QuotaAlarms>\\r\\n\\t<QuotaAlarms>\\r\\n\\t\\t<AlarmId>3f42ae59-edd0-44ad-aed1-b7aa36ff****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_elastic-network-interfaces</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<QuotaValue>50000</QuotaValue>\\r\\n\\t\\t<QuotaDimensions>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</QuotaDimensions>\\r\\n\\t\\t<AlarmName>test123</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2020-11-27T06:51:35Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>1</QuotaUsage>\\r\\n\\t\\t<ExceedThreshold>false</ExceedThreshold>\\r\\n\\t\\t<Threshold>5</Threshold>\\r\\n\\t</QuotaAlarms>\\r\\n\\t<RequestId>87F3B755-3BD2-4C76-B36A-93247002918C</RequestId>\\r\\n\\t<MaxResults>2</MaxResults>\\r\\n</ListQuotaAlarmsResponse>\\t","errorExample":""}]',
- 'title' => '查询配额用量告警列表',
- 'description' => '配额告警功能已升级,本API即将废弃,本API仅可查询旧版配额用量告警列表,若您想查询新版配额用量告警列表,请您使用云监控API [DescribeMetricRuleList](~~2513291~~)进行操作。使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetQuotaAlarm' => [
- 'summary' => '查询目标配额告警详情。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'QUOTA.APPLICATION.NOT.FOUND', 'errorMessage' => 'Quota application does not exist', 'description' => '配额申请不存在。'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '查询配额申请单审批信息',
+ 'description' => '### 前提条件'."\n"
+ .'请您确保已创建配额提升申请。具体操作,请参见[CreateQuotaApplication](~~440566~~)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaApplicationApproval'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaApplicationApproval',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AllowRetry\\": false,\\n \\"DynamicCode\\": \\"PARAMETER.ILLEGALL\\",\\n \\"DynamicMessage\\": \\"Parameter[%s] is required.\\",\\n \\"ErrorArgs\\": [\\n \\"ApplicationId\\"\\n ],\\n \\"ErrorCode\\": \\"RAM.PERMISSION.DENIED\\",\\n \\"ErrorMsg\\": \\"You are not authorized to do this action or the API input parameter is invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Module\\": {\\n \\"ApprovalHours\\": 24,\\n \\"ReminderIntervalHours\\": 24,\\n \\"SupportReminder\\": false,\\n \\"UnsupportReminderReason\\": \\"can only be remind once within the interval\\"\\n },\\n \\"RequestId\\": \\"7ED584FB-ECBF-4A2A-969D-F54D25EFABF9\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetQuotaTemplateServiceStatus' => [
+ 'summary' => '查询配额模板的状态。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2512,158 +1610,74 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC0TSBQ'],
],
'parameters' => [
[
- 'name' => 'AlarmId',
+ 'name' => 'ResourceDirectoryId',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警ID。'."\n"
- ."\n"
- .'关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~184348~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '78d7e436-4b25-4897-84b5-d7b656bb****',
- ],
+ 'schema' => ['description' => '资源目录ID。', 'type' => 'string', 'required' => false, 'example' => 'rd-pG****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => '无。',
'type' => 'object',
'properties' => [
- 'QuotaAlarm' => [
- 'description' => '配额告警详情。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'TemplateServiceStatus' => [
+ 'description' => '配额模板的状态。',
'type' => 'object',
'properties' => [
- 'AlarmId' => [
- 'description' => '配额告警ID。',
- 'type' => 'string',
- 'example' => '78d7e436-4b25-4897-84b5-d7b656bb****',
- ],
- 'AlarmName' => [
- 'description' => '配额告警名称。',
- 'type' => 'string',
- 'example' => 'q_security-groups alarm',
- ],
- 'CreateTime' => [
- 'description' => '配额告警创建时间。',
- 'type' => 'string',
- 'example' => '2021-01-21T03:47:28Z',
- ],
- 'NotifyChannels' => [
- 'description' => '告警通知渠道。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额告警通知渠道。取值:'."\n"
- ."\n"
- .'- sms:短信。'."\n"
- ."\n"
- .'- email:邮箱。',
- 'type' => 'string',
- 'example' => '["sms", "email"]',
- ],
- ],
- 'NotifyTarget' => [
- 'description' => '配额告警通知对象。',
- 'type' => 'string',
- 'example' => 'accountContact',
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaDimension' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'QuotaUsage' => [
- 'description' => '配额用量。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '28',
- ],
- 'QuotaValue' => [
- 'description' => '配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '804',
- ],
- 'Threshold' => [
- 'description' => '配额告警阈值的数值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '29',
- ],
- 'ThresholdPercent' => [
- 'description' => '配额告警阈值的百分比。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'ThresholdType' => [
- 'description' => '配额告警类型。取值:'."\n"
- ."\n"
- .'- used:配额已使用量告警。'."\n"
- .'- usable:配额剩余可用量告警。',
- 'type' => 'string',
- 'example' => 'used',
- ],
- 'Webhook' => [
- 'description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。',
- 'type' => 'string',
- 'example' => 'https://alert.aliyun.com/callback',
- ],
+ 'ResourceDirectoryId' => ['description' => '资源目录ID。', 'type' => 'string', 'example' => 'rd-pG****'],
+ 'ServiceStatus' => ['description' => '配额模板的状态。取值:'."\n"
+ ."\n"
+ .'- -1:禁用。'."\n"
+ ."\n"
+ .'- 1:开启。'."\n"
+ ."\n"
+ .'- 0:未设置。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '81B9D511-F3DD-43B1-9A81-1795DDB52ADF',
- ],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- [
- 'errorCode' => 'ALARM.NOT.FOUND',
- 'errorMessage' => 'The AlarmId provided does not exist in our records.',
+ ['errorCode' => 'TEMPLATE.RDID.INVALID', 'errorMessage' => 'RdId invalid', 'description' => '资源ID错误'],
+ ],
+ ],
+ 'title' => '查询配额模板状态',
+ 'description' => '配额模板的默认状态为未设置(即`ServiceStatus`为`0`)。仅当配额模板的状态为开启(即`ServiceStatus`为`1`)时,您才可以正常使用配额模板的功能。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaTemplateServiceStatus'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaTemplateServiceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaAlarm\\": {\\n \\"AlarmId\\": \\"78d7e436-4b25-4897-84b5-d7b656bb****\\",\\n \\"AlarmName\\": \\"q_security-groups alarm\\",\\n \\"CreateTime\\": \\"2021-01-21T03:47:28Z\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"sms\\\\\\", \\\\\\"email\\\\\\"]\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaDimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"QuotaUsage\\": 28,\\n \\"QuotaValue\\": 804,\\n \\"Threshold\\": 29,\\n \\"ThresholdPercent\\": 50,\\n \\"ThresholdType\\": \\"used\\",\\n \\"Webhook\\": \\"https://alert.aliyun.com/callback\\"\\n },\\n \\"RequestId\\": \\"81B9D511-F3DD-43B1-9A81-1795DDB52ADF\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQuotaAlarmResponse>\\r\\n\\t<RequestId>81B9D511-F3DD-43B1-9A81-1795DDB52ADF</RequestId>\\r\\n\\t<QuotaAlarm>\\r\\n\\t\\t<AlarmId>78d7e436-4b25-4897-84b5-d7b656bb****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<QuotaValue>804</QuotaValue>\\r\\n\\t\\t<AlarmName> 安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-21T03:47:28Z</CreateTime>\\r\\n\\t\\t<QuotaDimension>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</QuotaDimension>\\r\\n\\t\\t<QuotaUsage>28</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n <ThresholdType>used</ThresholdType>\\r\\n\\t</QuotaAlarm>\\r\\n</GetQuotaAlarmResponse>\\t","errorExample":""}]',
- 'title' => '查询配额用量告警详情',
- 'description' => '配额告警功能已升级,本API即将废弃,本API仅可查询旧版配额用量告警详情,若您想查询新版配额用量告警详情,请您使用云监控API [DescribeMetricRuleList](~~2513291~~)进行操作。使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TemplateServiceStatus\\": {\\n \\"ResourceDirectoryId\\": \\"rd-pG****\\",\\n \\"ServiceStatus\\": 1\\n }\\n}","type":"json"}]',
],
'ListAlarmHistories' => [
'summary' => '查询配额告警历史记录。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2675,87 +1689,47 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC3VMZU',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记开始查询数据的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '用来标记开始查询数据的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '本次查询最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~200。默认值:30。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => '本次查询最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~200。默认值:30。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'Keyword',
'in' => 'formData',
- 'schema' => [
- 'description' => '查询关键字。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Quantity',
- ],
+ 'schema' => ['description' => '查询关键字。', 'type' => 'string', 'required' => false, 'example' => 'Quantity'],
],
[
'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '查询开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20201020',
- ],
+ 'schema' => ['description' => '查询开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20201020'],
],
[
'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '查询结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20201024',
- ],
+ 'schema' => ['description' => '查询结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20201024'],
],
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云服务名称缩写。'."\n"
- ."\n"
- .'> 关于支持配额中心的云服务,请参见[支持配额中心的云服务](~~182368~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云服务名称缩写。'."\n"
+ ."\n"
+ .'> 关于支持配额中心的云服务,请参见[支持配额中心的云服务](~~182368~~)。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'AlarmId',
'in' => 'formData',
- 'schema' => [
- 'description' => '告警ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18b3be23-b7b0-4d45-91bc-d0c331aa****',
- ],
+ 'schema' => ['description' => '告警ID。', 'type' => 'string', 'required' => false, 'example' => '18b3be23-b7b0-4d45-91bc-d0c331aa****'],
],
],
'responses' => [
@@ -2771,493 +1745,268 @@
'description' => '配额告警历史记录详情。',
'type' => 'object',
'properties' => [
- 'AlarmName' => [
- 'description' => '配额告警名称。',
- 'type' => 'string',
- 'example' => 'q_security-groups alarm',
- ],
- 'CreateTime' => [
- 'description' => '配额告警创建时间。',
- 'type' => 'string',
- 'example' => '2021-01-24T09:20:09Z',
- ],
+ 'AlarmName' => ['description' => '配额告警名称。', 'type' => 'string', 'example' => 'q_security-groups alarm'],
+ 'CreateTime' => ['description' => '配额告警创建时间。', 'type' => 'string', 'example' => '2021-01-24T09:20:09Z'],
'NotifyChannels' => [
'description' => '配额告警通知渠道。',
'type' => 'array',
- 'items' => [
- 'description' => '配额告警通知渠道。取值:'."\n"
- ."\n"
- .'- sms:短信。'."\n"
- ."\n"
- .'- email:邮件。',
- 'type' => 'string',
- 'example' => '["sms", "email"]',
- ],
- ],
- 'NotifyTarget' => [
- 'description' => '配额告警通知对象。',
- 'type' => 'string',
- 'example' => 'accountContact',
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaUsage' => [
- 'description' => '已使用配额。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '31',
- ],
- 'Threshold' => [
- 'description' => '配额告警阈值的数值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '29',
- ],
- 'ThresholdPercent' => [
- 'description' => '配额告警阈值的百分比。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '80',
- ],
+ 'items' => ['description' => '配额告警通知渠道。取值:'."\n"
+ ."\n"
+ .'- sms:短信。'."\n"
+ ."\n"
+ .'- email:邮件。', 'type' => 'string', 'example' => '["sms", "email"]'],
+ ],
+ 'NotifyTarget' => ['description' => '配额告警通知对象。', 'type' => 'string', 'example' => 'accountContact'],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaUsage' => ['description' => '已使用配额。', 'type' => 'number', 'format' => 'float', 'example' => '31'],
+ 'Threshold' => ['description' => '配额告警阈值的数值。', 'type' => 'number', 'format' => 'float', 'example' => '29'],
+ 'ThresholdPercent' => ['description' => '配额告警阈值的百分比。', 'type' => 'number', 'format' => 'float', 'example' => '80'],
],
],
],
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'NextToken' => [
- 'description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CB38DDF9-B1E0-48C1-9966-19C443C2841E',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'NextToken' => ['description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。', 'type' => 'string', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CB38DDF9-B1E0-48C1-9966-19C443C2841E'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidStartTime',
- 'errorMessage' => 'Invalid StartTime',
- ],
- [
- 'errorCode' => 'InvalidEndTime',
- 'errorMessage' => 'Invalid EndTime',
- ],
+ ['errorCode' => 'InvalidStartTime', 'errorMessage' => 'Invalid StartTime', 'description' => '查询开始时间无效。'],
+ ['errorCode' => 'InvalidEndTime', 'errorMessage' => 'Invalid EndTime', 'description' => '查询结束时间无效。'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmName\\": \\"q_security-groups alarm\\",\\n \\"CreateTime\\": \\"2021-01-24T09:20:09Z\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"sms\\\\\\", \\\\\\"email\\\\\\"]\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaUsage\\": 31,\\n \\"Threshold\\": 29,\\n \\"ThresholdPercent\\": 80\\n }\\n ],\\n \\"MaxResults\\": 4,\\n \\"NextToken\\": \\"1\\",\\n \\"RequestId\\": \\"CB38DDF9-B1E0-48C1-9966-19C443C2841E\\",\\n \\"TotalCount\\": 4\\n}","errorExample":""},{"type":"xml","example":"<ListAlarmHistoriesResponse>\\r\\n\\t<TotalCount>4</TotalCount>\\r\\n\\t<RequestId>CB38DDF9-B1E0-48C1-9966-19C443C2841E</RequestId>\\r\\n\\t<MaxResults>4</MaxResults>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-24T09:20:09Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>31</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-23T09:20:07Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>31</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-22T09:10:08Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>30</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-21T09:10:08Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>29</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n</ListAlarmHistoriesResponse>\\t","errorExample":""}]',
'title' => '查询配额用量告警历史记录',
'description' => '配额告警功能已升级,本API即将废弃,本API仅可查询旧版配额用量告警历史记录,若您想查询新版配额用量告警历史记录,请您使用云监控API [DescribeAlertLogCount](~~2513275~~)、[DescribeAlertLogList](~~2513276~~)进行操作。使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateQuotaApplication' => [
- 'summary' => '创建配额提升申请。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlarmHistories'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListAlarmHistories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmName\\": \\"q_security-groups alarm\\",\\n \\"CreateTime\\": \\"2021-01-24T09:20:09Z\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"sms\\\\\\", \\\\\\"email\\\\\\"]\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaUsage\\": 31,\\n \\"Threshold\\": 29,\\n \\"ThresholdPercent\\": 80\\n }\\n ],\\n \\"MaxResults\\": 4,\\n \\"NextToken\\": \\"1\\",\\n \\"RequestId\\": \\"CB38DDF9-B1E0-48C1-9966-19C443C2841E\\",\\n \\"TotalCount\\": 4\\n}","errorExample":""},{"type":"xml","example":"<ListAlarmHistoriesResponse>\\r\\n\\t<TotalCount>4</TotalCount>\\r\\n\\t<RequestId>CB38DDF9-B1E0-48C1-9966-19C443C2841E</RequestId>\\r\\n\\t<MaxResults>4</MaxResults>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-24T09:20:09Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>31</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-23T09:20:07Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>31</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-22T09:10:08Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>30</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n\\t<AlarmHistories>\\r\\n\\t\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<AlarmName>安全组总数量上限</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2021-01-21T09:10:08Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>29</QuotaUsage>\\r\\n\\t\\t<Threshold>29</Threshold>\\r\\n\\t</AlarmHistories>\\r\\n</ListAlarmHistoriesResponse>\\t","errorExample":""}]',
+ ],
+ 'ListDependentQuotas' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasF0DSPH',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'cloudsso'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'q_security-groups',
- ],
- ],
- [
- 'name' => 'DesireValue',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请的值。'."\n"
- ."\n"
- .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
- .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => true,
- 'example' => '804',
- ],
- ],
- [
- 'name' => 'Reason',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请的原因。'."\n"
- ."\n"
- .'> 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Scale Out',
- ],
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取目标云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'q_system-policy-per-access-configuration'],
],
- [
- 'name' => 'NoticeType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请结果是否发送通知。取值:'."\n"
- ."\n"
- .'- 0(默认值):否。'."\n"
- .'- 3:是。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- 'default' => '0',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- ],
- ],
- ],
- [
- 'name' => 'Dimensions',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '配额维度。'."\n"
- .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
- .'> 部分云产品维度必填。您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回参数`Requisite`表示该维度是否必填。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以通过[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'description' => '无。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Quotas' => [
+ 'description' => '目标配额依赖的配额列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标配额依赖的配额列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimensions' => [
+ 'description' => '目标配额依赖的配额维度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标配额依赖的配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DependentDimension' => [
+ 'description' => '目标配额依赖的配额维度所依赖的配额维度。',
+ 'type' => 'array',
+ 'items' => ['description' => '目标配额依赖的配额维度所依赖的配额维度。', 'type' => 'string', 'example' => '[]'],
+ ],
+ 'DimensionKey' => ['description' => '目标配额依赖的配额维度的Key。', 'type' => 'string', 'example' => '[]'],
+ 'DimensionValues' => [
+ 'description' => '目标配额依赖的配额维度所依赖的配额维度的Value。',
+ 'type' => 'array',
+ 'items' => ['description' => '目标配额依赖的配额维度所依赖的配额维度的Value。', 'type' => 'string', 'example' => '[]'],
+ ],
+ ],
+ ],
+ ],
+ 'ProductCode' => ['description' => '云产品名称缩写。', 'type' => 'string', 'example' => 'ram'],
+ 'QuotaActionCode' => ['description' => '目标配额依赖的配额ID。', 'type' => 'string', 'example' => 'q_laxtn4'],
+ 'Scale' => ['description' => '目标配额与依赖配额的关系比例。', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ ],
],
],
- 'required' => false,
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '920D8A47-26BB-49FA-A09F-F98D7DAA55F3'],
],
- 'required' => false,
- 'maxItems' => 5,
],
],
- [
- 'name' => 'QuotaCategory',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额类型。'."\n"
- ."\n"
- .'默认值:CommonQuota。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'FlowControl' => 'API速率配额',
- 'WhiteListLabel' => '权益配额',
- 'CommonQuota' => '通用配额',
- ],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
+ ],
+ 'title' => '查询目标配额依赖的配额列表',
+ 'summary' => '部分配额之间存在关联,关联配额最好同时提升,该接口返回某个配额关联的配额项列表。',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDependentQuotas'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListDependentQuotas',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Quotas\\": [\\n {\\n \\"Dimensions\\": [\\n {\\n \\"DependentDimension\\": [\\n \\"[]\\"\\n ],\\n \\"DimensionKey\\": \\"[]\\",\\n \\"DimensionValues\\": [\\n \\"[]\\"\\n ]\\n }\\n ],\\n \\"ProductCode\\": \\"ram\\",\\n \\"QuotaActionCode\\": \\"q_laxtn4\\",\\n \\"Scale\\": 100\\n }\\n ],\\n \\"RequestId\\": \\"920D8A47-26BB-49FA-A09F-F98D7DAA55F3\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDependentQuotasResponse>\\r\\n\\t<RequestId>B871952D-ACA9-4641-B21A-713B08A5270A</RequestId>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_fh20b0</QuotaActionCode>\\r\\n\\t\\t<ProductCode>slb</ProductCode>\\r\\n\\t</Quotas>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_3mmbsp</QuotaActionCode>\\r\\n\\t\\t<ProductCode>slb</ProductCode>\\r\\n\\t</Quotas>\\r\\n\\t<Quotas>\\r\\n\\t\\t<QuotaActionCode>q_elastic-network-interfaces</QuotaActionCode>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<DimensionKey>regionId</DimensionKey>\\r\\n\\t\\t\\t<DimensionValues>cn-shenzhen</DimensionValues>\\r\\n\\t\\t\\t<DimensionValues>cn-beijing</DimensionValues>\\r\\n\\t\\t\\t<DimensionValues>cn-hangzhou</DimensionValues>\\r\\n\\t\\t</Dimensions>\\r\\n\\t</Quotas>\\r\\n</ListDependentQuotasResponse>\\t","errorExample":""}]',
+ ],
+ 'ListProductDimensionGroups' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'AuditMode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '><notice>该参数废弃,不建议使用。></notice>'."\n"
- ."\n"
- .'配额审核模式。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'Sync',
- 'default' => 'Async',
- 'enum' => [
- 'Async',
- 'Sync',
- ],
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'EnvLanguage',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警通知的语言。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en' => '英文',
- 'zh' => '中文',
- ],
- 'example' => 'zh',
- ],
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来标记开始查询数据的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ExpireTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额失效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 当您未选择失效时间时,默认为提交时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-20T09:25:56Z',
- ],
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ .'取值范围:1~200。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '3', 'default' => '30'],
],
[
- 'name' => 'EffectiveTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额生效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 当您未选择生效时间时,默认为当前配额开始时间起99年。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-19T09:25:56Z',
- ],
+ 'name' => 'ProductCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'entconsole'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回结果。',
+ 'description' => '维度组。',
'type' => 'object',
'properties' => [
- 'ApplicationId' => [
- 'description' => '配额申请ID。',
- 'type' => 'string',
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
- ],
- 'ApplyTime' => [
- 'description' => '配额提升申请时间。',
- 'type' => 'string',
- 'example' => '2021-01-19T09:25:56Z',
- ],
- 'ApproveValue' => [
- 'description' => '配额提升申请审批通过的配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '804',
- ],
- 'AuditReason' => [
- 'description' => '配额提升申请审批意见。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- 'DesireValue' => [
- 'description' => '配额提升申请值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '804',
- ],
- 'Dimension' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效时间。',
- 'type' => 'string',
- 'example' => '2021-01-19T09:25:56Z',
- ],
- 'ExpireTime' => [
- 'description' => '配额失效时间。',
- 'type' => 'string',
- 'example' => '2021-01-20T09:25:56Z',
- ],
- 'NoticeType' => [
- 'description' => '配额提升申请结果是否通知。取值:'."\n"
- ."\n"
- .'- 0:不通知。'."\n"
- ."\n"
- .'- 3:通知。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'enumValueTitles' => [
- '不通知',
- 3 => '通知',
- ],
- 'example' => '3',
- ],
- 'ProductCode' => [
- 'description' => '云产品名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas::141339776561****:quota/ecs/q_security-groups',
- ],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of security groups that can be owned by the current account.',
- ],
- 'QuotaName' => [
- 'description' => '配额名称。',
- 'type' => 'string',
- 'example' => 'Maximum Number of Security Groups',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'AMOUNT',
- ],
- 'Reason' => [
- 'description' => '配额提升申请原因。',
- 'type' => 'string',
- 'example' => 'Scale Out',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'Status' => [
- 'description' => '配额提升申请的审批状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Cancel' => '已关闭',
- 'Agree' => '审核通过',
- 'Process' => '审核中',
- 'Disagree' => '审核拒绝',
+ 'DimensionGroups' => [
+ 'description' => '维度组。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '维度组代码。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DimensionKeys' => [
+ 'description' => '维度组的Key。',
+ 'type' => 'array',
+ 'items' => ['description' => '维度组的Key。', 'type' => 'string', 'example' => 'regionId'],
+ ],
+ 'GroupCode' => ['description' => '维度组代码。', 'type' => 'string', 'example' => 'entconsole_zjzp4d****'],
+ 'GroupName' => ['description' => '维度组名称。', 'type' => 'string', 'example' => 'Resource sharing'],
+ 'ProductCode' => ['description' => '云服务代码。', 'type' => 'string', 'example' => 'entconsole'],
+ ],
],
- 'example' => 'Process',
],
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'NextToken' => ['description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。', 'type' => 'string', 'example' => '21'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '057D210F-F2FC-5329-A536-26C16628BB09'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'ACQUIRE.LOCK.FAIL',
- 'errorMessage' => 'The request is too frequent. Please try again later.',
- ],
- [
- 'errorCode' => 'InvalidNoticeType',
- 'errorMessage' => 'Invalid NoticeType',
- ],
- [
- 'errorCode' => 'InvalidDesireValue',
- 'errorMessage' => 'Invalid DesireValue',
- ],
- [
- 'errorCode' => 'QUOTA.NOT.ADJUSTABLE',
- 'errorMessage' => 'Quota is not adjustable',
- ],
- [
- 'errorCode' => 'QUOTA.NOT.FOUND',
- 'errorMessage' => 'The quota does not exist.',
- ],
- [
- 'errorCode' => 'QUOTA.APPLICATION.PROCESS',
- 'errorMessage' => 'The quota adjustment application is being processed. Please try again later.',
- ],
- [
- 'errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL',
- 'errorMessage' => 'The applied quota value is invalid.',
- ],
- [
- 'errorCode' => 'QUOTA.APPLICATION.TIME.ERROE',
- 'errorMessage' => 'ExpireTime cannot be earlier than the current time or EffectiveTime.',
+ 'title' => '查询云产品的维度组',
+ 'summary' => '查询目标云产品的维度组。',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductDimensionGroups'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductDimensionGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"ApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"ApplyTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ApproveValue\\": 804,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"DesireValue\\": 804,\\n \\"Dimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ExpireTime\\": \\"2021-01-20T09:25:56Z\\",\\n \\"NoticeType\\": 3,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas::141339776561****:quota/ecs/q_security-groups\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"Reason\\": \\"Scale Out\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"Status\\": \\"Process\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaApplicationResponse>\\n\\t<Status>Process</Status>\\n\\t<ApplyTime>2021-11-11T03:24:39Z</ApplyTime>\\n\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\n\\t<RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n\\t<ProductCode>ecs</ProductCode>\\n\\t<Dimension>\\n\\t\\t<regionId>cn-hangzhou</regionId>\\n\\t</Dimension>\\n\\t<ApproveValue>1007</ApproveValue>\\n\\t<Reason>扩容</Reason>\\n\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\n\\t<QuotaName>安全组总数量上限</QuotaName>\\n\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\n\\t<NoticeType>0</NoticeType>\\n\\t<ApplicationId>d314d6ae-867d-484c-9009-3d421a80****</ApplicationId>\\n\\t<DesireValue>804</DesireValue>\\n</CreateQuotaApplicationResponse>\\t","errorExample":""}]',
- 'title' => '创建配额提升申请',
- 'description' => '> 创建配额提升申请后,您可以调用[ListQuotaApplications](~~440568~~)接口查看审批结果,当`Status`显示为`Agree`时,表示审批通过。',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DimensionGroups\\": [\\n {\\n \\"DimensionKeys\\": [\\n \\"regionId\\"\\n ],\\n \\"GroupCode\\": \\"entconsole_zjzp4d****\\",\\n \\"GroupName\\": \\"Resource sharing\\",\\n \\"ProductCode\\": \\"entconsole\\"\\n }\\n ],\\n \\"MaxResults\\": 3,\\n \\"NextToken\\": \\"21\\",\\n \\"RequestId\\": \\"057D210F-F2FC-5329-A536-26C16628BB09\\",\\n \\"TotalCount\\": 3\\n}","errorExample":""},{"type":"xml","example":"<ListProductDimensionGroupsResponse>\\r\\n\\t<DimensionGroups>\\r\\n\\t\\t<GroupName>OSS_Group</GroupName>\\r\\n\\t\\t<ProductCode>oss</ProductCode>\\r\\n\\t\\t<GroupCode>oss_wf1ngqmd7q</GroupCode>\\r\\n\\t\\t<DimensionKeys>chargeType</DimensionKeys>\\r\\n\\t</DimensionGroups>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>057D210F-F2FC-5329-A536-26C16628BB09</RequestId>\\r\\n\\t<MaxResults>1</MaxResults>\\r\\n</ListProductDimensionGroupsResponse>\\t","errorExample":""}]',
],
- 'GetQuotaApplication' => [
- 'summary' => '查询配额提升申请详情。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListProductQuotaDimensions' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3269,20 +2018,45 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotas29QQRO',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记开始查询数据的位置。置空表示从头开始。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~200。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '5', 'default' => '30'],
+ ],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'disk'],
+ ],
+ [
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '配额提升申请ID。',
+ 'description' => '配额种类。取值:'."\n"
+ ."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ ."\n"
+ .'- CommonQuota(默认值):通用配额。'."\n"
+ ."\n"
+ .'> 权益配额(WhiteListLabel)无配额维度。',
'type' => 'string',
'required' => false,
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
+ 'enumValueTitles' => [],
+ 'example' => 'CommonQuota',
+ 'enum' => ['FlowControl', 'CommonQuota'],
],
],
],
@@ -3292,158 +2066,105 @@
'description' => '无。',
'type' => 'object',
'properties' => [
- 'QuotaApplication' => [
- 'description' => '配额提升申请详情。',
- 'type' => 'object',
- 'properties' => [
- 'ApplicationId' => [
- 'description' => '配额提升申请ID。',
- 'type' => 'string',
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
- ],
- 'ApplyTime' => [
- 'description' => '配额提升申请时间。',
- 'type' => 'string',
- 'example' => '2021-01-19T09:25:56Z',
- ],
- 'ApproveValue' => [
- 'description' => '配额审批额度。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '10',
- ],
- 'AuditReason' => [
- 'description' => '配额提升申请审批意见。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- 'DesireValue' => [
- 'description' => '配额提升申请值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '804',
- ],
- 'Dimension' => [
- 'description' => '配额维度。'."\n"
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'NextToken' => ['description' => '用来标记返回查询数据的位置。未返回表示数据已经查询完毕。', 'type' => 'string', 'example' => '84'],
+ 'QuotaDimensions' => [
+ 'description' => '配额维度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DependentDimensions' => [
+ 'description' => '目标配额维度依赖的配额维度。',
+ 'type' => 'array',
+ 'items' => ['description' => '目标配额维度依赖的配额维度。', 'type' => 'string', 'example' => 'regionId'],
+ ],
+ 'DimensionKey' => ['description' => '配额维度的Key。取值:'."\n"
."\n"
- .'格式:`{"regionId":"地域"}`。',
- 'type' => 'object',
- 'example' => '["cn-shanghai","cn-hangzhou"]',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效时间。',
- 'type' => 'string',
- 'example' => '2021-01-19 15:30:00',
- ],
- 'ExpireTime' => [
- 'description' => '配额过期时间。',
- 'type' => 'string',
- 'example' => '2023-06-29 15:30:00',
- ],
- 'NoticeType' => [
- 'description' => '通知类型。取值:'."\n"
+ .'- regionId:地域ID。'."\n"
."\n"
- .'- 0:无需通知。'."\n"
- .'- 1:邮件通知。'."\n"
- .'- 2:短信通知。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/',
- ],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of security groups that can be owned by the current account.',
- ],
- 'QuotaName' => [
- 'description' => '配额名称。',
- 'type' => 'string',
- 'example' => 'Maximum Number of Security Groups',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'AMOUNT',
- ],
- 'Reason' => [
- 'description' => '配额提升申请原因。',
- 'type' => 'string',
- 'example' => 'Scale Out',
- ],
- 'Status' => [
- 'description' => '配额提升申请的审批状态。取值:'."\n"
+ .'- zoneId:可用区ID。'."\n"
."\n"
- .'- Disagree:拒绝。'."\n"
+ .'- chargeType:付费类型。'."\n"
."\n"
- .'- Agree:审核通过。'."\n"
+ .'- networkType:网络类型。'."\n"
."\n"
- .'- Process:审核中。'."\n"
+ .'- resourceType:资源类型。', 'type' => 'string', 'example' => 'zoneId'],
+ 'DimensionValueDetail' => [
+ 'description' => '配额维度Value的详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度value的详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DependentDimensions' => [
+ 'description' => '目标配额维度依赖的配额维度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '目标配额维度依赖的配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '目标配额维度依赖的配额维度的Key。', 'type' => 'string', 'example' => 'regionId'],
+ 'Value' => ['description' => '目标配额维度依赖的配额维度的Value。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ ],
+ ],
+ ],
+ 'Name' => ['description' => '配额维度Value的名称。', 'type' => 'string', 'example' => 'cn-hangzhou-b'],
+ 'Value' => ['description' => '配额维度Value的值。', 'type' => 'string', 'example' => 'cn-hangzhou-b'."\n"],
+ ],
+ ],
+ ],
+ 'DimensionValues' => [
+ 'description' => '配额维度value的列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '配额维度Value的列表。', 'type' => 'string', 'example' => '["cn-hangzhou-b", "cn-hangzhou-e", "cn-hangzhou-f", "cn-hangzhou-g", "cn-hangzhou-h", "cn-hangzhou-i", "cn-hangzhou-j", "cn-hangzhou-k"]'],
+ ],
+ 'Name' => ['description' => '配额维度的名称。', 'type' => 'string', 'example' => 'Zone'],
+ 'Requisite' => ['description' => '查询配额维度时是否必选。取值:'."\n"
."\n"
- .'- Cancel:已关闭。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- 'QuotaCategory' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'example' => 'CommonQuota',
+ .'- true:必选。'."\n"
+ ."\n"
+ .'- false:非必选。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7BBD1D37-094C-4485-8B7D-64682F82BC18',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7ED584FB-ECBF-4A2A-969D-F54D25EFABF9'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'QUOTA.APPLICATION.NOT.FOUND',
- 'errorMessage' => 'Quota application does not exist',
- ],
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
+ 'title' => '查询云产品支持的配额维度',
+ 'summary' => '查询目标云产品支持的配额维度。',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductQuotaDimensions'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductQuotaDimensions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"QuotaApplication\\": {\\n \\"ApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"ApplyTime\\": \\"2021-01-19T09:25:56Z\\",\\n \\"ApproveValue\\": 10,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"DesireValue\\": 804,\\n \\"Dimension\\": [\\n \\"cn-shanghai\\",\\n \\"cn-hangzhou\\"\\n ],\\n \\"EffectiveTime\\": \\"2021-01-19 15:30:00\\",\\n \\"ExpireTime\\": \\"2023-06-29 15:30:00\\",\\n \\"NoticeType\\": 0,\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"Reason\\": \\"Scale Out\\",\\n \\"Status\\": \\"Agree\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\"\\n },\\n \\"RequestId\\": \\"7BBD1D37-094C-4485-8B7D-64682F82BC18\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQuotaApplicationResponse>\\r\\n\\t<Status>Process</Status>\\r\\n\\t<ApplyTime>2021-11-11T03:24:39Z</ApplyTime>\\r\\n\\t<QuotaDescription>当前账户可拥有的安全组的最大数量</QuotaDescription>\\r\\n\\t<RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\r\\n\\t<ProductCode>ecs</ProductCode>\\r\\n\\t<Dimension>\\r\\n\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t</Dimension>\\r\\n\\t<ApproveValue>1007</ApproveValue>\\r\\n\\t<Reason>扩容</Reason>\\r\\n\\t<QuotaActionCode>q_security-groups</QuotaActionCode>\\r\\n\\t<QuotaName>安全组总数量上限</QuotaName>\\r\\n\\t<QuotaArn>acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups/</QuotaArn>\\r\\n\\t<NoticeType>0</NoticeType>\\r\\n\\t<ApplicationId>d314d6ae-867d-484c-9009-3d421a80****</ApplicationId>\\r\\n\\t<DesireValue>804</DesireValue>\\r\\n</CreateQuotaApplicationResponse>\\t","errorExample":""}]',
- 'title' => '查询配额提升申请详情',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"84\\",\\n \\"QuotaDimensions\\": [\\n {\\n \\"DependentDimensions\\": [\\n \\"regionId\\"\\n ],\\n \\"DimensionKey\\": \\"zoneId\\",\\n \\"DimensionValueDetail\\": [\\n {\\n \\"DependentDimensions\\": [\\n {\\n \\"Key\\": \\"regionId\\",\\n \\"Value\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"Name\\": \\"cn-hangzhou-b\\",\\n \\"Value\\": \\"cn-hangzhou-b\\\\n\\"\\n }\\n ],\\n \\"DimensionValues\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\", \\\\\\"cn-hangzhou-e\\\\\\", \\\\\\"cn-hangzhou-f\\\\\\", \\\\\\"cn-hangzhou-g\\\\\\", \\\\\\"cn-hangzhou-h\\\\\\", \\\\\\"cn-hangzhou-i\\\\\\", \\\\\\"cn-hangzhou-j\\\\\\", \\\\\\"cn-hangzhou-k\\\\\\"]\\"\\n ],\\n \\"Name\\": \\"Zone\\",\\n \\"Requisite\\": false\\n }\\n ],\\n \\"RequestId\\": \\"7ED584FB-ECBF-4A2A-969D-F54D25EFABF9\\",\\n \\"TotalCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<ListProductQuotaDimensionsResponse>\\n<QuotaDimensions>\\n <DimensionKey>regionId</DimensionKey>\\n <DimensionValues>cn-shenzhen</DimensionValues>\\n <DimensionValues>cn-beijing</DimensionValues>\\n <DimensionValues>cn-wulanchabu</DimensionValues>\\n <DimensionValues>ap-south-1</DimensionValues>\\n <DimensionValues>eu-west-1</DimensionValues>\\n <DimensionValues>ap-northeast-1</DimensionValues>\\n <DimensionValues>me-east-1</DimensionValues>\\n <DimensionValues>cn-chengdu</DimensionValues>\\n <DimensionValues>cn-qingdao</DimensionValues>\\n <DimensionValues>cn-shanghai</DimensionValues>\\n <DimensionValues>cn-guangzhou</DimensionValues>\\n <DimensionValues>cn-hongkong</DimensionValues>\\n <DimensionValues>ap-southeast-1</DimensionValues>\\n <DimensionValues>cn-heyuan</DimensionValues>\\n <DimensionValues>ap-southeast-2</DimensionValues>\\n <DimensionValues>ap-southeast-3</DimensionValues>\\n <DimensionValues>eu-central-1</DimensionValues>\\n <DimensionValues>cn-huhehaote</DimensionValues>\\n <DimensionValues>ap-southeast-5</DimensionValues>\\n <DimensionValues>us-east-1</DimensionValues>\\n <DimensionValues>cn-zhangjiakou</DimensionValues>\\n <DimensionValues>us-west-1</DimensionValues>\\n <DimensionValues>cn-hangzhou</DimensionValues>\\n <Name>region</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>zoneId</DimensionKey>\\n <Name>可用区ID</Name>\\n <Requisite>false</Requisite>\\n <DependentDimensions>regionId</DependentDimensions>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>chargeType</DimensionKey>\\n <DimensionValues>Spot</DimensionValues>\\n <DimensionValues>PostPaid</DimensionValues>\\n <DimensionValues>PrePaid</DimensionValues>\\n <Name>付费类型</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<QuotaDimensions>\\n <DimensionKey>networkType</DimensionKey>\\n <DimensionValues>classic</DimensionValues>\\n <DimensionValues>vpc</DimensionValues>\\n <Name>网络类型</Name>\\n <Requisite>false</Requisite>\\n</QuotaDimensions>\\n<TotalCount>4</TotalCount>\\n<RequestId>7ED584FB-ECBF-4A2A-969D-F54D25EFABF9</RequestId>\\n<MaxResults>4</MaxResults>\\n</ListProductQuotaDimensionsResponse>","errorExample":""}]',
],
- 'ListQuotaApplications' => [
- 'summary' => '查询配额提升申请列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListProductQuotas' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3452,94 +2173,71 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotas29QQRO',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记开始查询数据的位置。置空表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '是否拥有下一次查询的令牌(Token)。'."\n"
+ ."\n"
+ .'- 第一次查询和没有下一次查询时,均无需填写。'."\n"
+ .'- 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAd****'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~200。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'example' => '1',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~100。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'csk',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => true, 'example' => 'ecs'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_i5uzm3',
- ],
+ 'schema' => ['description' => '配额ID。', 'type' => 'string', 'required' => false, 'example' => 'q_security-groups'],
],
[
- 'name' => 'Status',
+ 'name' => 'KeyWord',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额的搜索关键字。'."\n"
+ .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),搜索范围:`QuotaName`,`QuotaActionCode`。', 'type' => 'string', 'required' => false, 'example' => 'security'],
+ ],
+ [
+ 'name' => 'SortField',
'in' => 'formData',
'schema' => [
- 'description' => '配额提升申请的审批状态。取值:'."\n"
- ."\n"
- .'- Disagree:拒绝。'."\n"
- ."\n"
- .'- Agree:审核通过。'."\n"
- ."\n"
- .'- Process:审核中。'."\n"
+ 'description' => '配额支持的排序方式。'."\n"
."\n"
- .'- Cancel:已关闭。'."\n"
- ."\n",
+ .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),如果不设置,则为空。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'Agree',
- 'enum' => [
- 'Agree',
- 'Disagree',
- 'Process',
- 'Cancel',
- ],
+ 'enumValueTitles' => ['TOTAL' => '按总配额用量排序', 'TIME' => '按最近更新时间排序', 'RESERVED' => '按预留配额用量排序'],
+ 'example' => 'TIME',
],
],
[
- 'name' => 'KeyWord',
+ 'name' => 'SortOrder',
'in' => 'formData',
'schema' => [
- 'description' => '配额提升申请的搜索关键字。',
+ 'description' => '配额支持的排序方式。'."\n"
+ ."\n"
+ .'> 该参数仅针对云服务器ECS规格配额(ecs-spec),如果不设置,则为空。',
'type' => 'string',
'required' => false,
- 'example' => 'Cluster',
+ 'enumValueTitles' => ['Descending' => '降序', 'Ascending' => '升序'],
+ 'example' => 'Ascending',
+ 'enum' => ['Ascending', 'Descending'],
],
],
[
@@ -3547,56 +2245,44 @@
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '配额维度。'."\n"
- .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
- .'> 部分云产品维度必填。您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回参数`Requisite`表示该维度是否必填。',
+ 'description' => '配额维度。',
'type' => 'array',
'items' => [
'description' => '配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> N的取值范围取决于对应云产品支持的维度个数。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> N的取值范围取决于对应云产品支持的维度个数。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
'required' => false,
- 'maxItems' => 5,
+ 'maxItems' => 10,
],
],
[
'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
+ 'description' => '配额种类。'."\n"
+ ."\n"
+ .'默认值:CommonQuota。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
- ],
+ 'enumValueTitles' => ['FlowControl' => 'API速率配额', 'WhiteListLabel' => '权益配额', 'CommonQuota' => '通用配额'],
+ 'example' => 'FlowControl',
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
+ [
+ 'name' => 'GroupCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '维度组代码。', 'type' => 'string', 'required' => false, 'example' => 'entconsole_w1j3ms****'],
+ ],
],
'responses' => [
200 => [
@@ -3604,202 +2290,185 @@
'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询返回的最大记录条数。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NextToken' => [
- 'description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'QuotaApplications' => [
- 'description' => '配额提升申请的详情。'."\n"
- ."\n",
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NextToken' => ['description' => '是否拥有下一次查询的令牌(Token)。'."\n"
+ ."\n"
+ .'- 如果 NextToken 为空表示没有下一次查询。'."\n"
+ .'- 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。', 'type' => 'string', 'example' => 'AAAAAd****'],
+ 'Quotas' => [
+ 'description' => '配额详情。',
'type' => 'array',
'items' => [
- 'description' => '配额提升申请的详情。',
+ 'description' => '配额详情。',
'type' => 'object',
'properties' => [
- 'ApplicationId' => [
- 'description' => '配额提升申请的ID。',
- 'type' => 'string',
- 'example' => 'b926571d-cc09-4711-b547-58a615f0****',
- ],
- 'ApplyTime' => [
- 'description' => '配额提升申请的时间。',
- 'type' => 'string',
- 'example' => '2021-01-15T09:13:53Z',
- ],
- 'ApproveValue' => [
- 'description' => '配额提升申请审批通过的配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '101',
- ],
- 'AuditReason' => [
- 'description' => '配额提升申请的审批意见。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- 'Comment' => [
- 'description' => '配额提升申请的备注。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'DesireValue' => [
- 'description' => '配额提升申请的配额值。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '101',
+ 'Adjustable' => [
+ 'description' => '配额是否可调整。',
+ 'type' => 'boolean',
+ 'enumValueTitles' => ['true' => '配额可调整', 'false' => '配额不可调整'],
+ 'example' => 'true',
],
- 'Dimension' => [
- 'description' => '配额提升申请的配额维度。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
+ 'ApplicableRange' => [
+ 'description' => '当前配额项可申请的配额值区间,用于配额申请时进行参考。',
+ 'type' => 'array',
+ 'items' => ['description' => '当前配额项可申请的配额值区间。'."\n"
+ ."\n"
+ .'排除当前用户已有区间,用于申请配额时进行参考,例如:`[1010,10000]`。', 'type' => 'number', 'format' => 'float', 'example' => '[1010,10000]'],
],
- 'EffectiveTime' => [
- 'description' => '配额提升申请的生效时间。',
+ 'ApplicableType' => [
+ 'description' => '配额调整类型。',
'type' => 'string',
- 'example' => '2021-01-15T11:46:25Z',
+ 'enumValueTitles' => ['continuous' => '连续', 'discontinuous' => '间断'],
+ 'example' => 'discontinuous',
],
- 'ExpireTime' => [
- 'description' => '配额提升申请的过期时间。',
- 'type' => 'string',
- 'example' => '2021-01-17T11:46:25Z',
+ 'ApplyReasonTips' => ['description' => '申请配额调整理由示例。', 'type' => 'string', 'example' => 'The business xxx is expected to grow by 50%.'],
+ 'Consumable' => [
+ 'description' => '是否显示“已使用”的配额。',
+ 'type' => 'boolean',
+ 'enumValueTitles' => ['true' => '显示“已使用”的配额', 'false' => '不显示“已使用”的配额'],
+ 'example' => 'true',
],
- 'NoticeType' => [
- 'description' => '配额提升申请结果是否通知。取值:'."\n"
- ."\n"
- .'- 0:否。'."\n"
- .'- 3:是。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
+ 'Dimensions' => ['description' => '配额维度。格式:`{"regionId":"地域"}`。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => '配额生效的UTC时间。', 'type' => 'string', 'example' => '2022-09-28T06:07:00Z'],
+ 'ExpireTime' => ['description' => '配额失效的UTC时间。', 'type' => 'string', 'example' => '2022-09-29T06:07:00Z'],
+ 'GlobalQuota' => [
+ 'description' => '是否为全局配额。',
+ 'type' => 'boolean',
+ 'enumValueTitles' => ['true' => '该配额项为所有Region共用', 'false' => '该配额项为每个Region独立'],
+ 'example' => 'true',
],
'Period' => [
- 'description' => '配额计算周期。'."\n",
+ 'description' => '配额计算周期。',
'type' => 'object',
'properties' => [
'PeriodUnit' => [
- 'description' => '配额计算周期的单位。取值:'."\n"
- .'- second:秒。'."\n"
- .'- minute:分钟。'."\n"
- .'- hour:小时。'."\n"
- .'- day:天。'."\n"
- .'- week:周',
+ 'description' => '配额计算周期的单位。',
'type' => 'string',
- 'example' => 'second',
- ],
- 'PeriodValue' => [
- 'description' => '配额计算周期的取值。'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'enumValueTitles' => ['week' => '周', 'hour' => '小时', 'day' => '天', 'second' => '秒', 'minute' => '分钟'],
+ 'example' => 'day',
],
+ 'PeriodValue' => ['description' => '配额计算周期的取值。', 'type' => 'integer', 'format' => 'int32', 'example' => '{}'],
],
],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'csk',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_i5uzm3',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas:*:120886317861****:quota/csk/q_i5uzm3',
- ],
+ 'ProductCode' => ['description' => '云产品名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups'],
'QuotaCategory' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota(默认值):通用配额。'."\n"
- .'- WhiteListLabel:权益配额。'."\n"
- .'- FlowControl:API速率配额。',
+ 'description' => '配额类型。',
'type' => 'string',
+ 'enumValueTitles' => ['FlowControl' => 'API速率配额', 'WhiteListLabel' => '权益配额', 'CommonQuota' => '通用配额'],
'example' => 'CommonQuota',
],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of nodes in a cluster.',
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of security groups that can be owned by the current account.'],
+ 'QuotaItems' => [
+ 'description' => '配额详情。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Quota' => ['description' => '配额值。', 'type' => 'string', 'example' => '1009'],
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'Count'],
+ 'Type' => [
+ 'description' => '配额类别。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['BaseQuota' => '保障配额', 'ReservedQuota' => '预留配额'],
+ 'example' => 'BaseQuota',
+ ],
+ 'Usage' => ['description' => '配额用量。', 'type' => 'string', 'example' => '1009'],
+ ],
+ ],
],
- 'QuotaName' => [
- 'description' => '配额名称。',
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'ecs.g5.2xlarge'],
+ 'QuotaType' => [
+ 'description' => '配额类型。',
'type' => 'string',
- 'example' => 'Maximum Number of Nodes',
+ 'enumValueTitles' => ['normal' => '普通', 'privilege' => '特权'],
+ 'example' => 'privilege',
],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'Node',
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'AMOUNT'],
+ 'SupportedRange' => [
+ 'description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。',
+ 'type' => 'array',
+ 'items' => ['description' => '当前配额项支持的配额值区间,用于配置配额模板时进行参考。'."\n"
+ ."\n"
+ .'- 当ApplicableType为continuous时,如果取值为[1009,10000],则表示取值为1009~10000中的所有数。'."\n"
+ ."\n"
+ .'- 当ApplicableType为discontinuous时,如果取值为[10,20,50,100],则表示取值仅为10、20、50和100。', 'type' => 'number', 'format' => 'float', 'example' => '[1009,10000]'],
],
- 'Reason' => [
- 'description' => '配额提升申请的原因。',
+ 'TotalQuota' => ['description' => '配额值。', 'type' => 'number', 'format' => 'float', 'example' => '200'],
+ 'TotalUsage' => ['description' => '配额用量。', 'type' => 'number', 'format' => 'float', 'example' => '1009'],
+ 'UnadjustableDetail' => [
+ 'description' => '配额不可调整原因。',
'type' => 'string',
- 'example' => 'Business expansion',
+ 'enumValueTitles' => ['limitReached' => '已达配额上限', 'nonactivated' => '未开通服务', 'applicationProcess' => '配额申请处理中'],
+ 'example' => 'applicationProcess',
],
- 'Status' => [
- 'description' => '配额提升申请的审批状态。取值:'."\n"
- ."\n"
- .'- Disagree:拒绝。'."\n"
- ."\n"
- .'- Agree:审核通过。'."\n"
- ."\n"
- .'- Process:审核中。'."\n"
+ 'UsageMetric' => [
+ 'description' => '配额用量在云监控(CloudMonitor)中的监控信息。'."\n"
."\n"
- .'- Cancel:已关闭。',
- 'type' => 'string',
- 'example' => 'Agree',
+ .'> 空表示云监控中无此配额监控数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MetricDimensions' => [
+ 'description' => 'CloudMonitor监控维度。'."\n"
+ ."\n"
+ .'格式:`key:value`键值对形式的集合,例如:'."\n"
+ .'`{"productCode":"***","metricKey":"***","regionId":"***","label":"***"}`。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'ecs', 'description' => 'CloudMonitor监控维度值。'],
+ ],
+ 'MetricName' => ['description' => 'CloudMonitor监控项名称。', 'type' => 'string', 'example' => 'Usage'],
+ 'MetricNamespace' => ['description' => 'CloudMonitor监控数据命名空间。', 'type' => 'string', 'example' => 'acs_quotas_flowcontrol'],
+ ],
],
],
],
],
- 'RequestId' => [
- 'description' => '请求ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '730925FB-0BD0-40AC-AF3A-A6C6E9716879',
- ],
- 'TotalCount' => [
- 'description' => '配额提升申请总数。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0131FD5-5397-44FE-BF5A-4B7165B813CC'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidStatus',
- 'errorMessage' => 'Invalid Status',
- ],
+ ['errorCode' => 'InvalidSortOrder', 'errorMessage' => 'Invalid SortOrder', 'description' => '参数SortOrder无效。'],
+ ['errorCode' => 'INVALID.MAX.RESULTS', 'errorMessage' => 'The maxResults parameter is invalid. Use an integer ranging from 1 to 100.', 'description' => 'maxResults参数不合法,请使用1~100范围内的整数。'],
+ ['errorCode' => 'DIMENSIONGROUP.NOT.FOUND', 'errorMessage' => 'Dimension group does not exist.', 'description' => '维度组参数不正确'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplications\\": [\\n {\\n \\"ApplicationId\\": \\"b926571d-cc09-4711-b547-58a615f0****\\",\\n \\"ApplyTime\\": \\"2021-01-15T09:13:53Z\\",\\n \\"ApproveValue\\": 101,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"Comment\\": \\"test\\",\\n \\"DesireValue\\": 101,\\n \\"Dimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2021-01-15T11:46:25Z\\",\\n \\"ExpireTime\\": \\"2021-01-17T11:46:25Z\\",\\n \\"NoticeType\\": 3,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"second\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"csk\\",\\n \\"QuotaActionCode\\": \\"q_i5uzm3\\",\\n \\"QuotaArn\\": \\"acs:quotas:*:120886317861****:quota/csk/q_i5uzm3\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of nodes in a cluster.\\",\\n \\"QuotaName\\": \\"Maximum Number of Nodes\\",\\n \\"QuotaUnit\\": \\"Node\\",\\n \\"Reason\\": \\"Business expansion\\",\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"RequestId\\": \\"730925FB-0BD0-40AC-AF3A-A6C6E9716879\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListQuotaApplicationsResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<QuotaApplications>\\r\\n\\t\\t<Status>Agree</Status>\\r\\n\\t\\t<ApplyTime>2021-01-15T09:13:53Z</ApplyTime>\\r\\n\\t\\t<QuotaDescription>集群最大节点数</QuotaDescription>\\r\\n\\t\\t<ProductCode>csk</ProductCode>\\r\\n\\t\\t<AuditReason>同意</AuditReason>\\r\\n\\t\\t<QuotaUnit>Node</QuotaUnit>\\r\\n\\t\\t<Period />\\r\\n\\t\\t<Dimension>{\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"}</Dimension>\\r\\n\\t\\t<ApproveValue>101</ApproveValue>\\r\\n\\t\\t<Reason>业务扩张</Reason>\\r\\n\\t\\t<QuotaActionCode>q_i5uzm3</QuotaActionCode>\\r\\n\\t\\t<QuotaName>集群最大节点数</QuotaName>\\r\\n\\t\\t<QuotaArn>acs:quotas:*:120886317861****:quota/csk/q_i5uzm3</QuotaArn>\\r\\n\\t\\t<NoticeType>3</NoticeType>\\r\\n\\t\\t<ApplicationId>b926571d-cc09-4711-b547-58a615f0****</ApplicationId>\\r\\n\\t\\t<DesireValue>101</DesireValue>\\r\\n\\t</QuotaApplications>\\r\\n\\t<RequestId>730925FB-0BD0-40AC-AF3A-A6C6E9716879</RequestId>\\r\\n\\t<MaxResults>1</MaxResults>\\r\\n</ListQuotaApplicationsResponse>\\t","errorExample":""}]',
- 'title' => '查询配额提升申请列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询目标云产品的配额列表',
+ 'summary' => '查询目标云产品的配额列表。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetQuotaApplicationApproval' => [
- 'summary' => '查询配额申请单审批信息。其中包含:平均审批时间、是否支持审批提醒和审批提醒间隔时间等。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductQuotas'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductQuotas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"AAAAAd****\\",\\n \\"Quotas\\": [\\n {\\n \\"Adjustable\\": true,\\n \\"ApplicableRange\\": [\\n 0\\n ],\\n \\"ApplicableType\\": \\"discontinuous\\",\\n \\"ApplyReasonTips\\": \\"The business xxx is expected to grow by 50%.\\",\\n \\"Consumable\\": true,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:07:00Z\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:07:00Z\\",\\n \\"GlobalQuota\\": true,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 0\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaArn\\": \\"acs:quotas:cn-hangzhou:120886317861****:quota/ecs/q_security-groups\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be owned by the current account.\\",\\n \\"QuotaItems\\": [\\n {\\n \\"Quota\\": \\"1009\\",\\n \\"QuotaUnit\\": \\"Count\\",\\n \\"Type\\": \\"BaseQuota\\",\\n \\"Usage\\": \\"1009\\"\\n }\\n ],\\n \\"QuotaName\\": \\"ecs.g5.2xlarge\\",\\n \\"QuotaType\\": \\"privilege\\",\\n \\"QuotaUnit\\": \\"AMOUNT\\",\\n \\"SupportedRange\\": [\\n 0\\n ],\\n \\"TotalQuota\\": 200,\\n \\"TotalUsage\\": 1009,\\n \\"UnadjustableDetail\\": \\"applicationProcess\\",\\n \\"UsageMetric\\": {\\n \\"MetricDimensions\\": {\\n \\"key\\": \\"ecs\\"\\n },\\n \\"MetricName\\": \\"Usage\\",\\n \\"MetricNamespace\\": \\"acs_quotas_flowcontrol\\"\\n }\\n }\\n ],\\n \\"RequestId\\": \\"D0131FD5-5397-44FE-BF5A-4B7165B813CC\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListProductQuotasResponse>\\n <TotalCount>4</TotalCount>\\n <RequestId>F3A3568B-B01E-4EA7-B3DD-0699B4D319F9</RequestId>\\n <NextToken>AAAAAd98/tlL5GF2aM7UMKQGM8LZesIPr0CbfxASQvHV/pwcmVKNfdBbW8OPld3NvG9Cy8+dNcyFzyUttQA3IONfBhRGpXFyiVoTgK+dupBsP2mX</NextToken>\\n <Quotas>\\n <QuotaDescription>ecs.g5.2xlarge</QuotaDescription>\\n <Consumable>true</Consumable>\\n <TotalUsage>3</TotalUsage>\\n <ProductCode>ecs-spec</ProductCode>\\n <Dimensions>\\n <regionId>cn-hangzhou</regionId>\\n <chargeType>PostPaid</chargeType>\\n <zoneId>cn-hangzhou-i</zoneId>\\n <networkType>vpc</networkType>\\n <resourceType>InstanceType</resourceType>\\n </Dimensions>\\n <QuotaUnit>AMOUNT</QuotaUnit>\\n <Period/>\\n <Adjustable>true</Adjustable>\\n <QuotaActionCode>ecs.g5.2xlarge</QuotaActionCode>\\n <QuotaName>ecs.g5.2xlarge</QuotaName>\\n <QuotaItems>\\n <Usage>0</Usage>\\n <Type>ReservedQuota</Type>\\n <Quota>0</Quota>\\n </QuotaItems>\\n <QuotaItems>\\n <Usage>0</Usage>\\n <Type>BaseQuota</Type>\\n <Quota>0</Quota>\\n </QuotaItems>\\n <QuotaArn>acs:quotas:cn-hangzhou:107992689699****:quota/ecs/ecs.g5.2xlarge/postpaid/vpc/cn-hangzhou/instancetype/cn-hangzhou-i</QuotaArn>\\n <TotalQuota>160</TotalQuota>\\n <ApplicableType>continuous</ApplicableType>\\n </Quotas>\\n <MaxResults>1</MaxResults>\\n</ListProductQuotasResponse>","errorExample":""}]',
+ ],
+ 'ListProducts' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3811,270 +2480,256 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '申请单 id',
- 'description' => '配额申请单ID。'."\n"
- ."\n"
- .'关于如何获取配额申请单ID,请参见[ListQuotaApplications](~~440568~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd314d6ae-867d-484c-9009-3d42****',
- ],
+ 'schema' => ['description' => '用来标记开始查询数据的位置。置空表示从头开始。'."\n", 'type' => 'string', 'required' => false, 'example' => '4'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~200。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '4', 'default' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PopResultDTO<QuotaApplicationApprovalVO>',
- 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'AllowRetry' => [
- 'description' => '是否允许重试。取值:'."\n"
- .'- false:不允许重试。'."\n"
- .'- true:允许重试。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DynamicCode' => [
- 'description' => '动态错误码。',
- 'type' => 'string',
- 'example' => 'PARAMETER.ILLEGALL',
- ],
- 'DynamicMessage' => [
- 'description' => '动态错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter[%s] is required.',
- ],
- 'ErrorArgs' => [
- 'description' => '错误的参数组。',
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'NextToken' => ['description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。', 'type' => 'string', 'example' => '4'],
+ 'ProductInfo' => [
+ 'description' => '云产品信息。',
'type' => 'array',
'items' => [
- 'description' => '错误的参数。',
- 'type' => 'any',
- 'example' => 'ApplicationId',
- ],
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'RAM.PERMISSION.DENIED',
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Module' => [
- 'description' => '返回对象。',
- 'type' => 'object',
- 'properties' => [
- 'ApprovalHours' => [
- 'description' => '配额申请单平均审批时间。单位:小时。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'ReminderIntervalHours' => [
- 'description' => '配额申请单的审批提醒间隔时间。单位:小时。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'SupportReminder' => [
- 'title' => '是否支持审批提醒',
- 'description' => '配额申请单是否支持审批提醒。取值:'."\n"
- .'- false:不支持。'."\n"
- .'- true:支持。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UnsupportReminderReason' => [
- 'description' => '配额申请单不支持审批提醒的原因说明。',
- 'type' => 'string',
- 'example' => 'can only be remind once within the interval',
+ 'type' => 'object',
+ 'properties' => [
+ 'CommonQuotaSupport' => ['title' => '通用配额是否支持', 'description' => '是否支持通用配额。取值:'."\n"
+ ."\n"
+ .'- support:支持。'."\n"
+ ."\n"
+ .'- unsupport:不支持。', 'type' => 'string', 'example' => 'support'],
+ 'Dynamic' => ['description' => '<notice>该参数废弃,不建议使用。></notice>'."\n"
+ ."\n"
+ .'是否支持动态调整配额。取值:'."\n"
+ ."\n"
+ .'- true'."\n"
+ ."\n"
+ .'- false', 'type' => 'boolean', 'example' => 'true'],
+ 'FlowControlSupport' => ['title' => '是否支持流程', 'description' => '是否支持API速率配额。取值:'."\n"
+ ."\n"
+ .'- support:支持。'."\n"
+ ."\n"
+ .'- unsupport:不支持。', 'type' => 'string', 'example' => 'unsupport'],
+ 'ProductCode' => ['description' => '云产品名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'ProductName' => ['description' => '云产品名称。', 'type' => 'string', 'example' => 'Elastic Compute Service (ECS)'],
+ 'ProductNameEn' => ['description' => '云产品英文名称。', 'type' => 'string', 'example' => 'Elastic Compute Service'],
+ 'SecondCategoryId' => ['description' => '产品类目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'SecondCategoryName' => ['description' => '产品类目名称。', 'type' => 'string', 'example' => 'Elastic Compute'],
+ 'SecondCategoryNameEn' => ['description' => '产品类目英文名称。', 'type' => 'string', 'example' => 'Elastic Compute'],
+ 'WhiteListLabelQuotaSupport' => ['description' => '是否支持权益配额。取值:'."\n"
+ ."\n"
+ .'- support:支持。'."\n"
+ ."\n"
+ .'- unsupport:不支持。', 'type' => 'string', 'example' => 'support'],
],
+ 'description' => '',
],
],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7ED584FB-ECBF-4A2A-969D-F54D25EFABF9',
- ],
- 'Success' => [
- 'description' => '是否调用成功。取值:'."\n"
- ."\n"
- .'- true:调用成功。'."\n"
- .'- false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1DA9C136-11BC-4C39-ADC6-B86276128072'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'QUOTA.APPLICATION.NOT.FOUND',
- 'errorMessage' => 'Quota application does not exist',
- ],
+ 'title' => '查询配额中心支持的云产品列表',
+ 'summary' => '查询配额中心支持的云产品列表。',
+ 'description' => '查询结果与[支持配额中心的云产品](~~182368~~)相同。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'],
],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AllowRetry\\": false,\\n \\"DynamicCode\\": \\"PARAMETER.ILLEGALL\\",\\n \\"DynamicMessage\\": \\"Parameter[%s] is required.\\",\\n \\"ErrorArgs\\": [\\n \\"ApplicationId\\"\\n ],\\n \\"ErrorCode\\": \\"RAM.PERMISSION.DENIED\\",\\n \\"ErrorMsg\\": \\"You are not authorized to do this action or the API input parameter is invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Module\\": {\\n \\"ApprovalHours\\": 24,\\n \\"ReminderIntervalHours\\": 24,\\n \\"SupportReminder\\": false,\\n \\"UnsupportReminderReason\\": \\"can only be remind once within the interval\\"\\n },\\n \\"RequestId\\": \\"7ED584FB-ECBF-4A2A-969D-F54D25EFABF9\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询配额申请单审批信息',
- 'description' => '### 前提条件'."\n"
- .'请您确保已创建配额提升申请。具体操作,请参见[CreateQuotaApplication](~~440566~~)。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 4,\\n \\"NextToken\\": \\"4\\",\\n \\"ProductInfo\\": [\\n {\\n \\"CommonQuotaSupport\\": \\"support\\",\\n \\"Dynamic\\": true,\\n \\"FlowControlSupport\\": \\"unsupport\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"ProductName\\": \\"Elastic Compute Service (ECS)\\",\\n \\"ProductNameEn\\": \\"Elastic Compute Service\\",\\n \\"SecondCategoryId\\": 5,\\n \\"SecondCategoryName\\": \\"Elastic Compute\\",\\n \\"SecondCategoryNameEn\\": \\"Elastic Compute\\",\\n \\"WhiteListLabelQuotaSupport\\": \\"support\\"\\n }\\n ],\\n \\"RequestId\\": \\"1DA9C136-11BC-4C39-ADC6-B86276128072\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListProductsResponse>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>云服务器ECS</ProductName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Elastic Compute Service</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>云服务器ECS规格配额</ProductName>\\r\\n\\t\\t<ProductCode>ecs-spec</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Ecs Quotas by Instance Type</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Elastic Compute</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>弹性伸缩</ProductName>\\r\\n\\t\\t<ProductCode>ess</ProductCode>\\r\\n\\t\\t<SecondCategoryName>弹性计算</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>5</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>Auto Scaling</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<ProductInfo>\\r\\n\\t\\t<SecondCategoryNameEn>Security Management</SecondCategoryNameEn>\\r\\n\\t\\t<Dynamic>true</Dynamic>\\r\\n\\t\\t<CommonQuotaSupport>support</CommonQuotaSupport>\\r\\n\\t\\t<ProductName>操作审计</ProductName>\\r\\n\\t\\t<ProductCode>actiontrail</ProductCode>\\r\\n\\t\\t<SecondCategoryName>安全管理</SecondCategoryName>\\r\\n\\t\\t<FlowControlSupport>unsupport</FlowControlSupport>\\r\\n\\t\\t<SecondCategoryId>21</SecondCategoryId>\\r\\n\\t\\t<ProductNameEn>ActionTrail</ProductNameEn>\\r\\n\\t</ProductInfo>\\r\\n\\t<TotalCount>22</TotalCount>\\r\\n\\t<RequestId>16AD05A1-10E4-4048-AD9D-03BC6B9D5CDA</RequestId>\\r\\n\\t<NextToken>4</NextToken>\\r\\n\\t<MaxResults>4</MaxResults>\\r\\n</ListProductsResponse>\\t","errorExample":""}]',
],
- 'RemindQuotaApplicationApproval' => [
- 'summary' => '查询支持审批提醒的配额申请单。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQuotaAlarms' => [
+ 'summary' => '查询配额用量告警列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ApplicationId',
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记开始读取数据的位置。'."\n"
+ ."\n"
+ .'> 不设置该参数,表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '本次读取的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~200。默认值:30。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '20', 'default' => '20'],
+ ],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProductQuotas](~~440554~~)中的`ProductCode`。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
+ ],
+ [
+ 'name' => 'AlarmName',
'in' => 'formData',
+ 'schema' => ['description' => '配额用量告警名称。', 'type' => 'string', 'required' => false, 'example' => 'q_hvnoqv alarm'],
+ ],
+ [
+ 'name' => 'QuotaActionCode',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> - 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。'."\n"
+ .'> - 如果已设置本参数,则`ProductCode`必填。', 'type' => 'string', 'required' => false, 'example' => 'q_hvnoqv'],
+ ],
+ [
+ 'name' => 'QuotaDimensions',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '申请单 id',
- 'description' => '配额申请单ID。'."\n"
- ."\n"
- .'关于如何获取配额申请单ID,请参见[ListQuotaApplications](~~440568~~)。',
- 'type' => 'string',
+ 'description' => '配额维度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额维度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '219f1ff6-6205-495f-bda7-90d2fe945e****',
+ 'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PopResultDTO<String>',
- 'description' => '返回结果。',
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'AllowRetry' => [
- 'description' => '是否允许重试。取值:'."\n"
- .'- false:不允许重试。'."\n"
- .'- true:允许重试。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DynamicCode' => [
- 'description' => '动态错误码。',
- 'type' => 'string',
- 'example' => 'PARAMETER.ILLEGALL',
- ],
- 'DynamicMessage' => [
- 'description' => '动态错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter[%s] is required.',
- ],
- 'ErrorArgs' => [
- 'description' => '错误的参数组。',
+ 'MaxResults' => ['description' => '本次请求返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NextToken' => ['description' => '用来标记当前调用返回读取到的位置。'."\n"
+ ."\n"
+ .'> 该参数返回为空,表示数据已读取完毕。', 'type' => 'string', 'example' => '1'],
+ 'QuotaAlarms' => [
+ 'description' => '配额用量告警详情。',
'type' => 'array',
'items' => [
- 'description' => '错误的参数。',
- 'type' => 'any',
- 'example' => 'ApplicationId',
+ 'description' => '配额用量告警详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AlarmId' => ['description' => '告警ID。', 'type' => 'string', 'example' => 'a2efa7fc-832f-47bb-8054-39e28012****'],
+ 'AlarmName' => ['description' => '告警名称。', 'type' => 'string', 'example' => 'q_hvnoqv alarm'],
+ 'CreateTime' => ['description' => '创建配额用量告警的时间。', 'type' => 'string', 'example' => '2020-11-27T07:23:34Z'],
+ 'ExceedThreshold' => ['description' => '是否达到配额告警阈值。取值:'."\n"
+ ."\n"
+ .'- false'."\n"
+ ."\n"
+ .'- true', 'type' => 'boolean', 'example' => 'false'],
+ 'NotifyChannels' => [
+ 'description' => '配额告警通知渠道。',
+ 'type' => 'array',
+ 'items' => ['description' => '告警通知渠道。取值:'."\n"
+ ."\n"
+ .'- sms:短消息。'."\n"
+ ."\n"
+ .'- email:电子邮件。', 'type' => 'string', 'example' => 'sms'],
+ ],
+ 'NotifyTarget' => ['description' => '告警通知对象。'."\n"
+ .'> 目前仅支持取值:accountContact。表示配置的账号联系人', 'type' => 'string', 'example' => 'accountContact'],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'config'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_hvnoqv'],
+ 'QuotaDimensions' => ['description' => '配额维度。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'QuotaUsage' => ['description' => '已使用配额。', 'type' => 'number', 'format' => 'float', 'example' => '73'],
+ 'QuotaValue' => ['description' => '配额值。', 'type' => 'number', 'format' => 'float', 'example' => '200'],
+ 'Threshold' => ['description' => '配额用量告警阈值的数值。', 'type' => 'number', 'format' => 'float', 'example' => '160'],
+ 'ThresholdPercent' => ['description' => '配额用量告警阈值的百分比。', 'type' => 'number', 'format' => 'float', 'example' => '80'],
+ 'ThresholdType' => ['description' => '配额告警类型。取值:'."\n"
+ ."\n"
+ .'- used:已使用量告警。'."\n"
+ .'- usable:剩余可用量告警。', 'type' => 'string', 'example' => 'used'],
+ 'WebHook' => ['description' => 'Webhook地址。', 'type' => 'string', 'example' => 'https://www.aliyun.com/webhook'],
+ ],
],
],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'RAM.PERMISSION.DENIED'."\n",
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Module' => [
- 'description' => '返回对象,配额申请单ID。',
- 'type' => 'string',
- 'example' => '219f1ff6-6205-495f-bda7-90d2fe945e****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'Success' => [
- 'description' => '是否调用成功。取值:'."\n"
- .'- true:调用成功。'."\n"
- .'- false:调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '87F3B755-3BD2-4C76-B36A-93247002918C'],
+ 'TotalCount' => ['description' => '配额用量告警总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'QUOTA.APPLICATION.NOT.FOUND',
- 'errorMessage' => 'Quota application does not exist',
- ],
- [
- 'errorCode' => 'REMIND.APPLICATION.LIMIT',
- 'errorMessage' => 'Quota application do not support reminders or reminder interval exceeds the limit.',
+ 'title' => '查询配额用量告警列表',
+ 'description' => '配额告警功能已升级,本API即将废弃,本API仅可查询旧版配额用量告警列表,若您想查询新版配额用量告警列表,请您使用云监控API [DescribeMetricRuleList](~~2513291~~)进行操作。使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaAlarms'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaAlarms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AllowRetry\\": false,\\n \\"DynamicCode\\": \\"PARAMETER.ILLEGALL\\",\\n \\"DynamicMessage\\": \\"Parameter[%s] is required.\\",\\n \\"ErrorArgs\\": [\\n \\"ApplicationId\\"\\n ],\\n \\"ErrorCode\\": \\"RAM.PERMISSION.DENIED\\\\n\\",\\n \\"ErrorMsg\\": \\"You are not authorized to do this action or the API input parameter is invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Module\\": \\"219f1ff6-6205-495f-bda7-90d2fe945e****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询支持审批提醒的配额申请单',
- 'description' => '> 本接口仅适用于支持配额审批提醒的申请单,即GetQuotaApplicationApproval接口中`SupportReminder`为`true`。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaAlarms\\": [\\n {\\n \\"AlarmId\\": \\"a2efa7fc-832f-47bb-8054-39e28012****\\",\\n \\"AlarmName\\": \\"q_hvnoqv alarm\\",\\n \\"CreateTime\\": \\"2020-11-27T07:23:34Z\\",\\n \\"ExceedThreshold\\": false,\\n \\"NotifyChannels\\": [\\n \\"sms\\"\\n ],\\n \\"NotifyTarget\\": \\"accountContact\\",\\n \\"ProductCode\\": \\"config\\",\\n \\"QuotaActionCode\\": \\"q_hvnoqv\\",\\n \\"QuotaDimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"QuotaUsage\\": 73,\\n \\"QuotaValue\\": 200,\\n \\"Threshold\\": 160,\\n \\"ThresholdPercent\\": 80,\\n \\"ThresholdType\\": \\"used\\",\\n \\"WebHook\\": \\"https://www.aliyun.com/webhook\\"\\n }\\n ],\\n \\"RequestId\\": \\"87F3B755-3BD2-4C76-B36A-93247002918C\\",\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListQuotaAlarmsResponse>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<QuotaAlarms>\\r\\n\\t\\t<AlarmId>a2efa7fc-832f-47bb-8054-39e28012****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_hvnoqv</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<QuotaValue>200</QuotaValue>\\r\\n\\t\\t<QuotaDimensions/>\\r\\n\\t\\t<AlarmName>规则创建数量告警</AlarmName>\\r\\n\\t\\t<ProductCode>config</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2020-11-27T07:23:34Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>73</QuotaUsage>\\r\\n\\t\\t<ExceedThreshold>false</ExceedThreshold>\\r\\n\\t\\t<Threshold>160</Threshold>\\r\\n\\t</QuotaAlarms>\\r\\n\\t<QuotaAlarms>\\r\\n\\t\\t<AlarmId>3f42ae59-edd0-44ad-aed1-b7aa36ff****</AlarmId>\\r\\n\\t\\t<QuotaActionCode>q_elastic-network-interfaces</QuotaActionCode>\\r\\n\\t\\t<NotifyChannels>sms</NotifyChannels>\\r\\n\\t\\t<NotifyChannels>email</NotifyChannels>\\r\\n\\t\\t<QuotaValue>50000</QuotaValue>\\r\\n\\t\\t<QuotaDimensions>\\r\\n\\t\\t\\t<regionId>cn-hangzhou</regionId>\\r\\n\\t\\t</QuotaDimensions>\\r\\n\\t\\t<AlarmName>test123</AlarmName>\\r\\n\\t\\t<ProductCode>ecs</ProductCode>\\r\\n\\t\\t<NotifyTarget>accountContact</NotifyTarget>\\r\\n\\t\\t<CreateTime>2020-11-27T06:51:35Z</CreateTime>\\r\\n\\t\\t<QuotaUsage>1</QuotaUsage>\\r\\n\\t\\t<ExceedThreshold>false</ExceedThreshold>\\r\\n\\t\\t<Threshold>5</Threshold>\\r\\n\\t</QuotaAlarms>\\r\\n\\t<RequestId>87F3B755-3BD2-4C76-B36A-93247002918C</RequestId>\\r\\n\\t<MaxResults>2</MaxResults>\\r\\n</ListQuotaAlarmsResponse>\\t","errorExample":""}]',
],
- 'GetQuotaTemplateServiceStatus' => [
- 'summary' => '查询配额模板的状态。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQuotaApplicationTemplates' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4083,111 +2738,87 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREquotasC0TSBQ'],
],
'parameters' => [
[
- 'name' => 'ResourceDirectoryId',
+ 'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rd-pG****',
- ],
+ 'schema' => ['title' => '产品名称', 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n"
+ ."\n"
+ .'> To query the abbreviation of an Alibaba Cloud service name, call the [ListProducts](~~440555~~) operation and check the value of `ProductCode` in the response.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'Dimensions',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '无。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'TemplateServiceStatus' => [
- 'description' => '配额模板的状态。',
- 'type' => 'object',
- 'properties' => [
- 'ResourceDirectoryId' => [
- 'description' => '资源目录ID。',
- 'type' => 'string',
- 'example' => 'rd-pG****',
- ],
- 'ServiceStatus' => [
- 'description' => '配额模板的状态。取值:'."\n"
- ."\n"
- .'- -1:禁用。'."\n"
- ."\n"
- .'- 1:开启。'."\n"
- ."\n"
- .'- 0:未设置。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
+ 'title' => '配额维度',
+ 'description' => 'The quota dimensions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the array object.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the dimension.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.'."\n"
+ ."\n"
+ .'* You must specify both Key and Value for each quota dimension.'."\n", 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => 'The value of the dimension.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.'."\n"
+ ."\n"
+ .'* You must specify both Key and Value for each quota dimension.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
+ 'required' => false,
],
+ 'required' => false,
+ 'maxItems' => 5,
],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'TEMPLATE.RDID.INVALID',
- 'errorMessage' => 'RdId invalid',
- ],
+ [
+ 'name' => 'QuotaActionCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '配额操作code', 'description' => 'The ID of the quota.'."\n", 'type' => 'string', 'required' => false, 'example' => 'q_security-groups'],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TemplateServiceStatus\\": {\\n \\"ResourceDirectoryId\\": \\"rd-pG****\\",\\n \\"ServiceStatus\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '查询配额模板状态',
- 'description' => '配额模板的默认状态为未设置(即`ServiceStatus`为`0`)。仅当配额模板的状态为开启(即`ServiceStatus`为`1`)时,您才可以正常使用配额模板的功能。',
- ],
- 'ModifyQuotaTemplateServiceStatus' => [
- 'summary' => '配额模板的默认状态为未设置。当资源目录的管理账号初次使用配额模板时,需要开启配额模板。只有资源目录的管理员账号可修改配额模版。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模版配额项ID', 'description' => 'The ID of the quota item.'."\n", 'type' => 'string', 'required' => false, 'example' => '1****'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC0TSBQ',
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大记录条数', 'description' => 'The maximum number of records that can be returned for the query. Valid values: 1 to 100. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
- ],
- 'parameters' => [
[
- 'name' => 'ServiceStatus',
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token that marks the position from which you want to start the query.'."\n"
+ ."\n"
+ .'> If you leave this parameter empty, the query starts from the beginning.'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '配额模板的状态。取值:'."\n"
+ 'description' => 'The quota type. Valid values:'."\n"
."\n"
- .'- -1:禁用。'."\n"
- .'- 1:开启。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ .'* CommonQuota: general quota.'."\n"
+ .'* WhiteListLabel: whitelist quota.'."\n"
+ .'* FlowControl: API rate limit.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'WhiteListLabel', 'FlowControl'],
],
],
],
@@ -4195,167 +2826,195 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '无。',
+ 'description' => 'None.'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'TemplateServiceStatus' => [
- 'description' => '配额模板的状态。',
- 'type' => 'object',
- 'properties' => [
- 'ResourceDirectoryId' => [
- 'description' => '资源目录ID。',
- 'type' => 'string',
- 'example' => 'rd-pG****',
- ],
- 'ServiceStatus' => [
- 'description' => '配额模板的状态。取值:'."\n"
+ 'MaxResults' => ['description' => 'The maximum number of records returned for the query.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'NextToken' => ['description' => 'The token that marks the position at which the query ends.'."\n"
+ ."\n"
+ .'> An empty value indicates that all data is returned.'."\n", 'type' => 'string', 'example' => '1'],
+ 'QuotaApplicationTemplates' => [
+ 'description' => 'The information about quota templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about a quota template.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicableRange' => [
+ 'description' => 'None.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The range of the quota value that can be requested for the quota item.'."\n"
+ ."\n"
+ .'> This parameter is deprecated. For more information about the range, see the value of `SupportedRange` in the response of the [GetProductQuota](~~GetProductQuota~~) or [ListProductQuotas](~~ListProductQuotas~~) operation.'."\n"
+ ."\n"
+ .'* If the value of `ApplicableType` is `continuous` and the value of this parameter is `[802,1000]`, the range contains all integers from 802 to 1000.'."\n"
+ .'* If the value of `ApplicableType` is `discontinuous` and the value of this parameter is `[10,20,50,100]`, the range contains only 10,20,50, and 100.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '[802,1000]'],
+ ],
+ 'ApplicableType' => ['description' => 'The type of the adjustable value. Valid values:'."\n"
+ ."\n"
+ .'* continuous'."\n"
+ .'* discontinuous'."\n", 'type' => 'string', 'example' => 'continuous'],
+ 'DesireValue' => ['description' => 'The requested value of the quota.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '802'],
+ 'Dimensions' => ['description' => 'The quota dimensions.'."\n"
."\n"
- .'- -1:禁用。'."\n"
- .'- 1:开启。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ .'Format: {"regionId":"Region"}.'."\n", 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => 'The start time of the validity period of the quota. The value is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-09-28T06:07:00Z'],
+ 'EnvLanguage' => ['description' => 'The language of the quota alert notification. Valid values:'."\n"
+ ."\n"
+ .'* zh: Chinese'."\n"
+ .'* en: English'."\n", 'type' => 'string', 'example' => 'zh'],
+ 'ExpireTime' => ['description' => 'The end time of the validity period of the quota. The value is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-09-29T06:07:00Z'],
+ 'Id' => ['description' => 'The ID of the quota template.'."\n", 'type' => 'string', 'example' => '1****'],
+ 'NoticeType' => ['description' => 'Indicates whether Quota Center sends a notification about the application result. Valid values:'."\n"
+ ."\n"
+ .'* 0: no'."\n"
+ .'* 3: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Period' => [
+ 'description' => 'The calculation cycle of the quota.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['description' => 'The unit of the calculation cycle. Valid values:'."\n"
+ ."\n"
+ .'* second'."\n"
+ .'* minute'."\n"
+ .'* hour'."\n"
+ .'* day'."\n"
+ .'* week'."\n", 'type' => 'string', 'example' => 'day'],
+ 'PeriodValue' => ['description' => 'The value of the calculation cycle.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'ProductCode' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => 'The ID of the quota.'."\n", 'type' => 'string', 'example' => 'q_security-groups'],
+ 'QuotaCategory' => ['description' => 'The type of the quota. Valid values:'."\n"
+ ."\n"
+ .'* CommonQuota: general quota'."\n"
+ .'* FlowControl: API rate limit'."\n"
+ .'* WhiteListLabel: privilege'."\n", 'type' => 'string', 'example' => 'CommonQuota'],
+ 'QuotaDescription' => ['description' => 'The description of the quota.'."\n", 'type' => 'string', 'example' => 'The maximum number of security groups that can be created by the current account.'."\n"],
+ 'QuotaName' => ['description' => 'The name of the quota.'."\n", 'type' => 'string', 'example' => 'Maximum Number of Security Groups'."\n"],
],
],
],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'TotalCount' => ['description' => 'The total number of records returned for the query.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
+ ['errorCode' => 'TEMPLATE.ITEM.NOT.FOUND', 'errorMessage' => 'Quota template item does not exist.', 'description' => '配额模板项不存在'],
+ ],
+ ],
+ 'title' => '查询配额模板列表',
+ 'summary' => '管理账号查询配额模板列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationTemplates'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TemplateServiceStatus\\": {\\n \\"ResourceDirectoryId\\": \\"rd-pG****\\",\\n \\"ServiceStatus\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyQuotaTemplateServiceStatusResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <TemplateServiceStatus>\\n <ServiceStatus>1</ServiceStatus>\\n <ResourceDirectoryId>rd-pG****</ResourceDirectoryId>\\n </TemplateServiceStatus>\\n</ModifyQuotaTemplateServiceStatusResponse>","errorExample":""}]',
- 'title' => '修改配额模板状态',
- 'description' => '### 前提条件'."\n"
- ."\n"
- .'请确保您已开通资源目录。具体操作,请参见[EnableResourceDirectory](~~604185~~)。'."\n"
- ."\n"
- .'### 使用说明'."\n"
- .'当配额模板的状态`ServiceStatus`为`0`(未设置)或`-1`(禁用)时,您可以先将其修改为`1`(开启),再调用[CreateTemplateQuotaItem](~~450615~~)接口创建配额模板。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplicationTemplates\\": [\\n {\\n \\"ApplicableRange\\": [\\n 0\\n ],\\n \\"ApplicableType\\": \\"continuous\\",\\n \\"DesireValue\\": 802,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:07:00Z\\",\\n \\"EnvLanguage\\": \\"zh\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:07:00Z\\",\\n \\"Id\\": \\"1****\\",\\n \\"NoticeType\\": 0,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be created by the current account.\\\\n\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\\\n\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 40\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
- 'CreateTemplateQuotaItem' => [
- 'summary' => '管理账号创建配额模板后,如果资源目录新增成员,则配额模板自动为新增的成员提交配额提升申请,已有成员无变化。通过配额模板,您一次可以申请提升多个配额项,提升整个组织的配额管理效率和自动化水平。只有资源目录的管理员账号可创建配额模版。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQuotaApplications' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasVP27J0',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotas29QQRO'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记开始查询数据的位置。置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~200。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '1', 'default' => '20'],
+ ],
+ [
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '云服务名称缩写。',
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。', 'type' => 'string', 'required' => false, 'example' => 'csk'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '配额ID。',
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'q_security-groups',
- ],
+ 'schema' => ['description' => '配额ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'q_i5uzm3'],
],
[
- 'name' => 'DesireValue',
+ 'name' => 'Status',
'in' => 'formData',
'schema' => [
- 'title' => '配额申请的值。',
- 'description' => '配额申请的值。'."\n"
+ 'description' => '配额提升申请的审批状态。取值:'."\n"
."\n"
- .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
- .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => true,
- 'example' => '804',
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。'."\n"
+ ."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Agree',
+ 'enum' => ['Agree', 'Disagree', 'Process', 'Cancel'],
],
],
[
- 'name' => 'NoticeType',
+ 'name' => 'KeyWord',
'in' => 'formData',
- 'schema' => [
- 'title' => '配额申请结果是否发送通知',
- 'description' => '配额申请结果是否发送通知。取值:'."\n"
- .'- 0(默认值):否。'."\n"
- .'- 3:是。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '配额提升申请的搜索关键字。', 'type' => 'string', 'required' => false, 'example' => 'Cluster'],
],
[
'name' => 'Dimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '配额维度。',
- 'description' => '配额维度。',
+ 'description' => '配额维度。'."\n"
+ .'配额项的属性,维度(Dimensions)+配额ID(QuotaActionCode)确定唯一的配额项。'."\n"
+ .'> 部分云产品维度必填。您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回参数`Requisite`表示该维度是否必填。',
'type' => 'array',
'items' => [
'description' => '配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> `Dimensions.N.Key`和`Dimensions.N.Value`必须同时设置。N的取值范围取决于对应云产品支持的维度个数,您可以从[ListProductQuotaDimensions](~~ListProductQuotaDimensions~~)查询云产品支持的配额维度,返回数组长度就是N。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
@@ -4364,360 +3023,319 @@
],
],
[
- 'name' => 'EnvLanguage',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额告警通知的语言。取值:'."\n"
- ."\n"
- .'- zh(默认值):中文。'."\n"
- .'- en:英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'EffectiveTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额生效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 数据为空表示立即生效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-19T09:25:56Z',
- ],
- ],
- [
- 'name' => 'ExpireTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额失效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 数据为空表示未设定UTC失效时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-20T09:25:56Z',
- ],
- ],
- [
'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
'description' => '配额种类。取值:'."\n"
.'- CommonQuota:通用配额。'."\n"
- .'- WhiteListLabel:权益配额。'."\n"
- .'- FlowControl:API速率配额。',
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'WhiteListLabel',
- 'FlowControl',
- ],
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '无。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '配额模板ID。',
- 'type' => 'string',
- 'example' => '1****',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
+ 'MaxResults' => ['description' => '本次查询返回的最大记录条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NextToken' => ['description' => '用来标记返回查询数据的位置。空表示数据已经查询完毕。'."\n"
+ ."\n", 'type' => 'string', 'example' => '1'],
+ 'QuotaApplications' => [
+ 'description' => '配额提升申请的详情。'."\n"
+ ."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额提升申请的详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationId' => ['description' => '配额提升申请的ID。', 'type' => 'string', 'example' => 'b926571d-cc09-4711-b547-58a615f0****'],
+ 'ApplyTime' => ['description' => '配额提升申请的时间。', 'type' => 'string', 'example' => '2021-01-15T09:13:53Z'],
+ 'ApproveValue' => ['description' => '配额提升申请审批通过的配额值。', 'type' => 'number', 'format' => 'float', 'example' => '101'],
+ 'AuditReason' => ['description' => '配额提升申请的审批意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'Comment' => ['description' => '配额提升申请的备注。', 'type' => 'string', 'example' => 'test'],
+ 'DesireValue' => ['description' => '配额提升申请的配额值。', 'type' => 'number', 'format' => 'float', 'example' => '101'],
+ 'Dimension' => ['description' => '配额提升申请的配额维度。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => '配额提升申请的生效时间。', 'type' => 'string', 'example' => '2021-01-15T11:46:25Z'],
+ 'ExpireTime' => ['description' => '配额提升申请的过期时间。', 'type' => 'string', 'example' => '2021-01-17T11:46:25Z'],
+ 'NoticeType' => ['description' => '配额提升申请结果是否通知。取值:'."\n"
+ ."\n"
+ .'- 0:否。'."\n"
+ .'- 3:是。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Period' => [
+ 'description' => '配额计算周期。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['description' => '配额计算周期的单位。取值:'."\n"
+ .'- second:秒。'."\n"
+ .'- minute:分钟。'."\n"
+ .'- hour:小时。'."\n"
+ .'- day:天。'."\n"
+ .'- week:周', 'type' => 'string', 'example' => 'second'],
+ 'PeriodValue' => ['description' => '配额计算周期的取值。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ ],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'csk'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_i5uzm3'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas:*:120886317861****:quota/csk/q_i5uzm3'],
+ 'QuotaCategory' => ['description' => '配额种类。取值:'."\n"
+ .'- CommonQuota(默认值):通用配额。'."\n"
+ .'- WhiteListLabel:权益配额。'."\n"
+ .'- FlowControl:API速率配额。', 'type' => 'string', 'example' => 'CommonQuota'],
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of nodes in a cluster.'],
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'Maximum Number of Nodes'],
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'Node'],
+ 'Reason' => ['description' => '配额提升申请的原因。', 'type' => 'string', 'example' => 'Business expansion'],
+ 'Status' => ['description' => '配额提升申请的审批状态。取值:'."\n"
+ ."\n"
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。', 'type' => 'string', 'example' => 'Agree'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => '730925FB-0BD0-40AC-AF3A-A6C6E9716879'],
+ 'TotalCount' => ['description' => '配额提升申请总数。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
- ],
- [
- 'errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL',
- 'errorMessage' => 'DesirValue less than or equal to the current quota value, or that is not within the adjustable range.',
- ],
- [
- 'errorCode' => 'QUOTA.NOT.ADJUSTABLE',
- 'errorMessage' => 'Quota is not adjustable',
+ ['errorCode' => 'InvalidStatus', 'errorMessage' => 'Invalid Status', 'description' => '参数Status无效。'],
+ ],
+ ],
+ 'title' => '查询配额提升申请列表',
+ 'summary' => '查询配额提升申请列表。',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplications'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</CreateTemplateQuotaItemResponse>","errorExample":""}]',
- 'title' => '创建配额模板',
- 'description' => '### 前提条件'."\n"
- .'请确保配额模板的状态为已开启(即`ServiceStatus`为`1`)。'."\n"
- ."\n"
- .'调用[GetQuotaTemplateServiceStatus](~~450407~~)接口查询配额模板的状态,当配额模板的状态`ServiceStatus`为`0`(未设置)或`-1`(禁用)时,需要调用[ModifyQuotaTemplateServiceStatus](~~450406~~)接口将配额模板的状态修改为`1`(开启)。'."\n"
- ."\n"
- .'### 使用说明'."\n"
- .'创建配额模板后,您可以调用[ListQuotaApplicationsForTemplate](~~2584864~~)接口查看审批结果,当`Status`显示为`Agree`时,表示审批通过。',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 1,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplications\\": [\\n {\\n \\"ApplicationId\\": \\"b926571d-cc09-4711-b547-58a615f0****\\",\\n \\"ApplyTime\\": \\"2021-01-15T09:13:53Z\\",\\n \\"ApproveValue\\": 101,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"Comment\\": \\"test\\",\\n \\"DesireValue\\": 101,\\n \\"Dimension\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2021-01-15T11:46:25Z\\",\\n \\"ExpireTime\\": \\"2021-01-17T11:46:25Z\\",\\n \\"NoticeType\\": 3,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"second\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"csk\\",\\n \\"QuotaActionCode\\": \\"q_i5uzm3\\",\\n \\"QuotaArn\\": \\"acs:quotas:*:120886317861****:quota/csk/q_i5uzm3\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of nodes in a cluster.\\",\\n \\"QuotaName\\": \\"Maximum Number of Nodes\\",\\n \\"QuotaUnit\\": \\"Node\\",\\n \\"Reason\\": \\"Business expansion\\",\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"RequestId\\": \\"730925FB-0BD0-40AC-AF3A-A6C6E9716879\\",\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<ListQuotaApplicationsResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<QuotaApplications>\\r\\n\\t\\t<Status>Agree</Status>\\r\\n\\t\\t<ApplyTime>2021-01-15T09:13:53Z</ApplyTime>\\r\\n\\t\\t<QuotaDescription>集群最大节点数</QuotaDescription>\\r\\n\\t\\t<ProductCode>csk</ProductCode>\\r\\n\\t\\t<AuditReason>同意</AuditReason>\\r\\n\\t\\t<QuotaUnit>Node</QuotaUnit>\\r\\n\\t\\t<Period />\\r\\n\\t\\t<Dimension>{\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"}</Dimension>\\r\\n\\t\\t<ApproveValue>101</ApproveValue>\\r\\n\\t\\t<Reason>业务扩张</Reason>\\r\\n\\t\\t<QuotaActionCode>q_i5uzm3</QuotaActionCode>\\r\\n\\t\\t<QuotaName>集群最大节点数</QuotaName>\\r\\n\\t\\t<QuotaArn>acs:quotas:*:120886317861****:quota/csk/q_i5uzm3</QuotaArn>\\r\\n\\t\\t<NoticeType>3</NoticeType>\\r\\n\\t\\t<ApplicationId>b926571d-cc09-4711-b547-58a615f0****</ApplicationId>\\r\\n\\t\\t<DesireValue>101</DesireValue>\\r\\n\\t</QuotaApplications>\\r\\n\\t<RequestId>730925FB-0BD0-40AC-AF3A-A6C6E9716879</RequestId>\\r\\n\\t<MaxResults>1</MaxResults>\\r\\n</ListQuotaApplicationsResponse>\\t","errorExample":""}]',
],
- 'ModifyTemplateQuotaItem' => [
- 'summary' => '管理账号修改配额模板后,修改结果仅对资源目录中管理账号新增的成员生效,已有成员无变化。只有资源目录的管理员账号可修改配额模版。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQuotaApplicationsDetailForTemplate' => [
+ 'summary' => '查询资源目录中成员配额提升申请详情。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC0TSBQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotas29QQRO'],
],
'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'AliyunUid',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额模板ID。'."\n"
- .'关于如何获取配额模板ID,请参见[ListQuotaApplicationTemplates](~~450403~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1****',
- ],
+ 'schema' => ['description' => '配额提升申请的阿里云账号(主账号)。', 'type' => 'string', 'required' => false, 'example' => '135048337611****'],
],
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_security-groups',
- ],
+ 'schema' => ['description' => '配额ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c5.large'],
],
[
- 'name' => 'Dimensions',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '配额维度。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
- ],
- [
- 'name' => 'DesireValue',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请的值。'."\n"
- ."\n"
- .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
- .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '804',
- ],
+ 'schema' => ['title' => 'Agree, Disagree, Process, Cancel', 'description' => '配额提升申请的审批状态。取值:'."\n"
+ ."\n"
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。', 'type' => 'string', 'required' => false, 'example' => 'Agree'],
],
[
- 'name' => 'NoticeType',
+ 'name' => 'BatchQuotaApplicationId',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请结果是否发送通知。取值:'."\n"
- ."\n"
- .'- 0(默认值):否。'."\n"
- .'- 3:是。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '配额申请批次ID。', 'type' => 'string', 'required' => false, 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'."\n"],
],
[
- 'name' => 'EnvLanguage',
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'description' => '配额告警通知的语言。取值:'."\n"
- ."\n"
- .'- zh(默认值):中文。'."\n"
- .'- en:英文。',
+ 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
+ 'description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。',
'type' => 'string',
'required' => false,
- 'example' => 'zh',
+ 'enumValueTitles' => [],
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
[
- 'name' => 'EffectiveTime',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额生效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 数据为空表示立即生效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-19T09:25:56Z',
- ],
+ 'schema' => ['description' => '用来标记开始查询数据的位置。'."\n"
+ ."\n"
+ .'> 不设置该参数,表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '4'],
],
[
- 'name' => 'ExpireTime',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额失效的UTC时间。'."\n"
- .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 数据为空表示未设定UTC失效时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-20T09:25:56Z',
- ],
- ],
- [
- 'name' => 'QuotaCategory',
- 'in' => 'query',
- 'schema' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota(默认值):通用配额。'."\n"
- .'- WhiteListLabel:权益配额。'."\n"
- .'- FlowControl:API速率配额。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CommonQuota',
- 'enum' => [
- 'WhiteListLabel',
- 'CommonQuota',
- 'FlowControl',
- ],
- ],
+ 'schema' => ['description' => '本次查询的最大记录条数。'."\n"
+ ."\n"
+ .'取值范围:1~100。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '无。',
+ 'title' => 'ResultList<QuotaBatchApplicationVo>',
+ 'description' => '配额申请详情列表。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '配额模板ID。',
- 'type' => 'string',
- 'example' => '1****',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
+ 'MaxResults' => ['description' => '本次查询的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'NextToken' => ['description' => '用来标记开始查询数据的位置。', 'type' => 'string', 'example' => '1'],
+ 'QuotaApplications' => [
+ 'description' => '配额申请详情列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '配额申请详情列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AliyunUid' => ['description' => '阿里云账号(主账号)。', 'type' => 'string', 'example' => '175376458581****'],
+ 'ApplicationId' => ['description' => '配额提升申请的ID。', 'type' => 'string', 'example' => 'b926571d-cc09-4711-b547-58a615f0****'],
+ 'ApplyTime' => ['description' => '配额提升申请的UTC时间。', 'type' => 'string', 'example' => '2021-01-15T09:13:53Z'],
+ 'ApproveValue' => ['description' => '配额提升申请审批通过的配额值。', 'type' => 'number', 'format' => 'double', 'example' => '101'],
+ 'AuditReason' => ['description' => '配额提升申请的审批意见。', 'type' => 'string', 'example' => 'Agree'],
+ 'BatchQuotaApplicationId' => ['description' => '配额申请批次ID。', 'type' => 'string', 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
+ 'DesireValue' => ['description' => '配额提升申请的配额值。', 'type' => 'number', 'format' => 'double', 'example' => '60'],
+ 'EffectiveTime' => ['description' => '配额生效的UTC时间。', 'type' => 'string', 'example' => '2021-01-15T11:46:25Z'],
+ 'EnvLanguage' => ['description' => '配额告警通知的语言。取值:'."\n"
+ ."\n"
+ .'- zh:中文。'."\n"
+ .'- en:英文。', 'type' => 'string', 'example' => 'zh'],
+ 'ExpireTime' => ['description' => '配额失效的UTC时间。', 'type' => 'string', 'example' => '2021-01-17T11:46:25Z'],
+ 'NoticeType' => ['description' => '配额提升申请结果是否通知。取值:'."\n"
+ ."\n"
+ .'- 0:否。'."\n"
+ .'- 3:是。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'Period' => [
+ 'description' => '配额计算周期。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PeriodUnit' => ['title' => '配额计算周期单位', 'description' => '配额计算周期单位。', 'type' => 'string', 'example' => 'second'],
+ 'PeriodValue' => ['title' => '配额计算周期值', 'description' => '配额计算周期值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'ecs'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'ecs.n1.large'],
+ 'QuotaArn' => ['description' => '配额ARN。', 'type' => 'string', 'example' => 'acs:quotas:*:120886317861****:quota/csk/q_i5uzm3'],
+ 'QuotaCategory' => ['description' => '配额种类。取值:'."\n"
+ .'- CommonQuota(默认值):通用配额。'."\n"
+ .'- WhiteListLabel:权益配额。'."\n"
+ .'- FlowControl:API速率配额。', 'type' => 'string', 'example' => 'CommonQuota'],
+ 'QuotaDescription' => ['description' => '配额描述。', 'type' => 'string', 'example' => 'The maximum number of nodes in a cluster'],
+ 'QuotaDimension' => [
+ 'description' => '配额维度。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"regionId":"cn-hangzhou"}', 'description' => '配额维度。'."\n"
+ ."\n"
+ .'格式:`{"regionId":"cn-hangzhou"}`。'],
+ ],
+ 'QuotaName' => ['description' => '配额名称。', 'type' => 'string', 'example' => 'Maximum Number of Nodes'],
+ 'QuotaUnit' => ['description' => '配额单位。', 'type' => 'string', 'example' => 'GiB'],
+ 'Reason' => ['description' => '配额提升申请的原因。', 'type' => 'string', 'example' => 'Maximum Number of Nodes'],
+ 'Status' => ['description' => '配额提升申请的审批状态。取值:'."\n"
+ ."\n"
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。', 'type' => 'string', 'example' => 'Agree'],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求ID。'."\n"
+ ."\n", 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TEMPLATE.NOT.FOUND',
- 'errorMessage' => 'Quota template does not exist.',
- ],
- [
- 'errorCode' => 'UNSUPPORT.UPDATE.PRODUCTCODE.QUOTACODE',
- 'errorMessage' => 'Modification of product name, quota code and dimension data is not supported',
- ],
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
- ],
- [
- 'errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL',
- 'errorMessage' => 'DesirValue less than or equal to the current quota value, or that is not within the adjustable range.',
- ],
- [
- 'errorCode' => 'UNSUPPORT.UPDATE.DIMENSIONS',
- 'errorMessage' => 'The Quota dimension don\'t support be modified when you update quota template.',
- ],
- [
- 'errorCode' => 'TEMPLATE.ITEM.NOT.FOUND',
- 'errorMessage' => 'Quota template item does not exist.',
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ],
+ ],
+ 'title' => '查询配额模板批量配额申请详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationsDetailForTemplate'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationsDetailForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</ModifyTemplateQuotaItemResponse>","errorExample":""}]',
- 'title' => '修改配额模板',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplications\\": [\\n {\\n \\"AliyunUid\\": \\"175376458581****\\",\\n \\"ApplicationId\\": \\"b926571d-cc09-4711-b547-58a615f0****\\",\\n \\"ApplyTime\\": \\"2021-01-15T09:13:53Z\\",\\n \\"ApproveValue\\": 101,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"DesireValue\\": 60,\\n \\"EffectiveTime\\": \\"2021-01-15T11:46:25Z\\",\\n \\"EnvLanguage\\": \\"zh\\",\\n \\"ExpireTime\\": \\"2021-01-17T11:46:25Z\\",\\n \\"NoticeType\\": 3,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"second\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"ecs.n1.large\\",\\n \\"QuotaArn\\": \\"acs:quotas:*:120886317861****:quota/csk/q_i5uzm3\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of nodes in a cluster\\",\\n \\"QuotaDimension\\": {\\n \\"key\\": \\"{\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"}\\"\\n },\\n \\"QuotaName\\": \\"Maximum Number of Nodes\\",\\n \\"QuotaUnit\\": \\"GiB\\",\\n \\"Reason\\": \\"Maximum Number of Nodes\\",\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 9\\n}","type":"json"}]',
],
- 'ListQuotaApplicationTemplates' => [
- 'summary' => '管理账号查询配额模板列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListQuotaApplicationsForTemplate' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4729,319 +3347,168 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC0TSBQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotas29QQRO'],
],
'parameters' => [
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品名称',
- 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n"
- ."\n"
- .'> To query the abbreviation of an Alibaba Cloud service name, call the [ListProducts](~~440555~~) operation and check the value of `ProductCode` in the response.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => false, 'example' => 'ecs-spec'],
],
[
- 'name' => 'Dimensions',
+ 'name' => 'QuotaActionCode',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '配额维度',
- 'description' => 'The quota dimensions.'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => 'The information about the array object.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => 'The key of the dimension.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.'."\n"
- ."\n"
- .'* You must specify both Key and Value for each quota dimension.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => 'The value of the dimension.'."\n"
- ."\n"
- .'> '."\n"
- ."\n"
- .'* The value range of N varies based on the number of dimensions that are supported by the related Alibaba Cloud service.'."\n"
- ."\n"
- .'* You must specify both Key and Value for each quota dimension.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
+ 'schema' => ['description' => '配额ID。'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.g5.2xlarge'],
],
[
- 'name' => 'QuotaActionCode',
+ 'name' => 'BatchQuotaApplicationId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配额操作code',
- 'description' => 'The ID of the quota.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'q_security-groups',
- ],
+ 'schema' => ['description' => '配额申请批次ID。', 'type' => 'string', 'required' => false, 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
],
[
- 'name' => 'Id',
+ 'name' => 'QuotaCategory',
'in' => 'formData',
'schema' => [
- 'title' => '模版配额项ID',
- 'description' => 'The ID of the quota item.'."\n",
+ 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
+ 'description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。',
'type' => 'string',
'required' => false,
- 'example' => '1****',
+ 'enumValueTitles' => [],
+ 'example' => 'CommonQuota',
+ 'enum' => ['CommonQuota', 'FlowControl', 'WhiteListLabel'],
],
],
[
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用来标记开始读取数据的位置。'."\n"
+ ."\n"
+ .'> 不设置该参数,表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '4'],
+ ],
+ [
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大记录条数',
- 'description' => 'The maximum number of records that can be returned for the query. Valid values: 1 to 100. Default value: 30.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => '单次请求返回结果的最大条数。'."\n"
+ ."\n"
+ .'取值范围:1~100。默认值:30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The token that marks the position from which you want to start the query.'."\n"
- ."\n"
- .'> If you leave this parameter empty, the query starts from the beginning.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'ApplyStartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '配额申请开始的UTC时间。'."\n"
+ ."\n"
+ .'> `ApplyStartTime`和`ApplyEndTime`之间的时间间隔必须小于等于7天。如果未设置这两个参数,则配额申请时间为最近7天。', 'type' => 'string', 'required' => false, 'example' => '2023-05-22T16:00:00Z'."\n"],
],
[
- 'name' => 'QuotaCategory',
+ 'name' => 'ApplyEndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => 'The quota type. Valid values:'."\n"
- ."\n"
- .'* CommonQuota: general quota.'."\n"
- .'* WhiteListLabel: whitelist quota.'."\n"
- .'* FlowControl: API rate limit.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'WhiteListLabel',
- 'FlowControl',
- ],
- ],
+ 'schema' => ['description' => '配额申请结束的UTC时间。'."\n"
+ ."\n"
+ .'> `ApplyStartTime`和`ApplyEndTime`之间的时间间隔必须小于等于7天。如果未设置这两个参数,则配额申请时间为最近7天。', 'type' => 'string', 'required' => false, 'example' => '2023-05-22T16:00:00Z'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'None.'."\n",
+ 'title' => 'PopResultDTO<ResultList<QuotaBatchApplicationVo>>',
+ 'description' => '无。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => 'The maximum number of records returned for the query.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'NextToken' => [
- 'description' => 'The token that marks the position at which the query ends.'."\n"
- ."\n"
- .'> An empty value indicates that all data is returned.'."\n",
- 'type' => 'string',
- 'example' => '1',
- ],
- 'QuotaApplicationTemplates' => [
- 'description' => 'The information about quota templates.'."\n",
+ 'MaxResults' => ['description' => '本次查询的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'NextToken' => ['description' => '用来标记开始读取数据的位置。', 'type' => 'string', 'example' => '1'],
+ 'QuotaBatchApplications' => [
+ 'description' => '配额申请历史列表。',
'type' => 'array',
'items' => [
- 'description' => 'The information about a quota template.'."\n",
+ 'description' => '配额申请历史列表。',
'type' => 'object',
'properties' => [
- 'ApplicableRange' => [
- 'description' => 'None.'."\n",
+ 'AliyunUids' => [
+ 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。',
'type' => 'array',
- 'items' => [
- 'description' => 'The range of the quota value that can be requested for the quota item.'."\n"
- ."\n"
- .'> This parameter is deprecated. For more information about the range, see the value of `SupportedRange` in the response of the [GetProductQuota](~~GetProductQuota~~) or [ListProductQuotas](~~ListProductQuotas~~) operation.'."\n"
- ."\n"
- .'* If the value of `ApplicableType` is `continuous` and the value of this parameter is `[802,1000]`, the range contains all integers from 802 to 1000.'."\n"
- .'* If the value of `ApplicableType` is `discontinuous` and the value of this parameter is `[10,20,50,100]`, the range contains only 10,20,50, and 100.'."\n",
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '[802,1000]',
- ],
- ],
- 'ApplicableType' => [
- 'description' => 'The type of the adjustable value. Valid values:'."\n"
- ."\n"
- .'* continuous'."\n"
- .'* discontinuous'."\n",
- 'type' => 'string',
- 'example' => 'continuous',
- ],
- 'DesireValue' => [
- 'description' => 'The requested value of the quota.'."\n",
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '802',
+ 'items' => ['description' => '配额申请的资源目录成员的阿里云账号(主账号)。', 'type' => 'string', 'example' => '14468026070****'],
],
- 'Dimensions' => [
- 'description' => 'The quota dimensions.'."\n"
- ."\n"
- .'Format: {"regionId":"Region"}.'."\n",
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'EffectiveTime' => [
- 'description' => 'The start time of the validity period of the quota. The value is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-28T06:07:00Z',
- ],
- 'EnvLanguage' => [
- 'description' => 'The language of the quota alert notification. Valid values:'."\n"
- ."\n"
- .'* zh: Chinese'."\n"
- .'* en: English'."\n",
- 'type' => 'string',
- 'example' => 'zh',
- ],
- 'ExpireTime' => [
- 'description' => 'The end time of the validity period of the quota. The value is displayed in UTC.'."\n",
- 'type' => 'string',
- 'example' => '2022-09-29T06:07:00Z',
- ],
- 'Id' => [
- 'description' => 'The ID of the quota template.'."\n",
- 'type' => 'string',
- 'example' => '1****',
- ],
- 'NoticeType' => [
- 'description' => 'Indicates whether Quota Center sends a notification about the application result. Valid values:'."\n"
- ."\n"
- .'* 0: no'."\n"
- .'* 3: yes'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Period' => [
- 'description' => 'The calculation cycle of the quota.'."\n",
- 'type' => 'object',
- 'properties' => [
- 'PeriodUnit' => [
- 'description' => 'The unit of the calculation cycle. Valid values:'."\n"
+ 'ApplyTime' => ['description' => '配额提升申请的UTC时间。', 'type' => 'string', 'example' => '2022-09-23T02:38:18Z'],
+ 'AuditStatusVos' => [
+ 'description' => '不同审批状态的申请单数量。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '不同审批状态的申请单数量。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['description' => '审批单数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'Status' => ['title' => 'Agree, Disagree, Process, Cancel', 'description' => '配额提升申请的审批状态。取值:'."\n"
."\n"
- .'* second'."\n"
- .'* minute'."\n"
- .'* hour'."\n"
- .'* day'."\n"
- .'* week'."\n",
- 'type' => 'string',
- 'example' => 'day',
- ],
- 'PeriodValue' => [
- 'description' => 'The value of the calculation cycle.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ .'- Disagree:拒绝。'."\n"
+ ."\n"
+ .'- Agree:审核通过。'."\n"
+ ."\n"
+ .'- Process:审核中。'."\n"
+ ."\n"
+ .'- Cancel:已关闭。', 'type' => 'string', 'example' => 'Agree'],
],
],
],
- 'ProductCode' => [
- 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n",
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => 'The ID of the quota.'."\n",
- 'type' => 'string',
- 'example' => 'q_security-groups',
- ],
- 'QuotaCategory' => [
- 'description' => 'The type of the quota. Valid values:'."\n"
- ."\n"
- .'* CommonQuota: general quota'."\n"
- .'* FlowControl: API rate limit'."\n"
- .'* WhiteListLabel: privilege'."\n",
- 'type' => 'string',
- 'example' => 'CommonQuota',
- ],
- 'QuotaDescription' => [
- 'description' => 'The description of the quota.'."\n",
- 'type' => 'string',
- 'example' => 'The maximum number of security groups that can be created by the current account.'."\n",
- ],
- 'QuotaName' => [
- 'description' => 'The name of the quota.'."\n",
- 'type' => 'string',
- 'example' => 'Maximum Number of Security Groups'."\n",
- ],
+ 'BatchQuotaApplicationId' => ['description' => '配额申请批次ID。', 'type' => 'string', 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'],
+ 'DesireValue' => ['description' => '配额申请的值。', 'type' => 'number', 'format' => 'double', 'example' => '105'],
+ 'Dimensions' => ['description' => '配额维度。'."\n"
+ ."\n"
+ .'格式:{"regionId":"cn-hangzhou"}。', 'type' => 'object', 'example' => '{"regionId":"cn-hangzhou"}'],
+ 'EffectiveTime' => ['description' => '配额生效的UTC时间。', 'type' => 'string', 'example' => '2023-05-22T16:00:00Z'],
+ 'ExpireTime' => ['description' => '配额失效的UTC时间。', 'type' => 'string', 'example' => '2024-05-14T02:08:56Z'],
+ 'ProductCode' => ['description' => '云服务名称缩写。', 'type' => 'string', 'example' => 'vpc'],
+ 'QuotaActionCode' => ['description' => '配额ID。', 'type' => 'string', 'example' => 'q_fhoz4k'],
+ 'QuotaCategory' => ['description' => '配额种类。取值:'."\n"
+ .'- CommonQuota:通用配额。'."\n"
+ .'- FlowControl:API速率配额。'."\n"
+ .'- WhiteListLabel:权益配额。', 'type' => 'string', 'example' => 'CommonQuota'],
+ 'Reason' => ['description' => '配额提升申请的原因。', 'type' => 'string', 'example' => 'Business expansion'],
],
],
],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of records returned for the query.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '40',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'TotalCount' => ['description' => '本次请求返回的全部记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '67'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TEMPLATE.ITEM.NOT.FOUND',
- 'errorMessage' => 'Quota template item does not exist.',
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ],
+ ],
+ 'title' => '查询配额模板批量配额申请历史',
+ 'summary' => '查询配额模板批量申请成员配额的申请历史。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationsForTemplate'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationsForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplicationTemplates\\": [\\n {\\n \\"ApplicableRange\\": [\\n 0\\n ],\\n \\"ApplicableType\\": \\"continuous\\",\\n \\"DesireValue\\": 802,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2022-09-28T06:07:00Z\\",\\n \\"EnvLanguage\\": \\"zh\\",\\n \\"ExpireTime\\": \\"2022-09-29T06:07:00Z\\",\\n \\"Id\\": \\"1****\\",\\n \\"NoticeType\\": 0,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"day\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"q_security-groups\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of security groups that can be created by the current account.\\\\n\\",\\n \\"QuotaName\\": \\"Maximum Number of Security Groups\\\\n\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 40\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
- 'title' => '查询配额模板列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaBatchApplications\\": [\\n {\\n \\"AliyunUids\\": [\\n \\"14468026070****\\"\\n ],\\n \\"ApplyTime\\": \\"2022-09-23T02:38:18Z\\",\\n \\"AuditStatusVos\\": [\\n {\\n \\"Count\\": 4,\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"DesireValue\\": 105,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2023-05-22T16:00:00Z\\",\\n \\"ExpireTime\\": \\"2024-05-14T02:08:56Z\\",\\n \\"ProductCode\\": \\"vpc\\",\\n \\"QuotaActionCode\\": \\"q_fhoz4k\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"Reason\\": \\"Business expansion\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 67\\n}","type":"json"}]',
],
- 'DeleteTemplateQuotaItem' => [
- 'summary' => '管理账号删除配额模板后,如果资源目录新增成员,则配额模板不再自动为新增的成员提交配额提升申请。只有资源目录的管理员账号可删除配额模版。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ModifyQuotaTemplateServiceStatus' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5050,26 +3517,19 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasC0TSBQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC0TSBQ'],
],
'parameters' => [
[
- 'name' => 'Id',
+ 'name' => 'ServiceStatus',
'in' => 'formData',
- 'schema' => [
- 'title' => '配额项ID',
- 'description' => '配额模板ID。'."\n"
- ."\n"
- .'关于如何获取配额模板ID,请参见[ListQuotaApplicationTemplates](~~450403~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1****',
- ],
+ 'schema' => ['description' => '配额模板的状态。取值:'."\n"
+ ."\n"
+ .'- -1:禁用。'."\n"
+ .'- 1:开启。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
],
'responses' => [
@@ -5079,16 +3539,17 @@
'description' => '无。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '配额模板ID。',
- 'type' => 'string',
- 'example' => '1****',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'TemplateServiceStatus' => [
+ 'description' => '配额模板的状态。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceDirectoryId' => ['description' => '资源目录ID。', 'type' => 'string', 'example' => 'rd-pG****'],
+ 'ServiceStatus' => ['description' => '配额模板的状态。取值:'."\n"
+ ."\n"
+ .'- -1:禁用。'."\n"
+ .'- 1:开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
],
],
@@ -5096,28 +3557,43 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RAM.PERMISSION.DENIED',
- 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.',
- ],
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ],
+ ],
+ 'title' => '修改配额模板状态',
+ 'summary' => '配额模板的默认状态为未设置。当资源目录的管理账号初次使用配额模板时,需要开启配额模板。只有资源目录的管理员账号可修改配额模版。',
+ 'description' => '### 前提条件'."\n"
+ ."\n"
+ .'请确保您已开通资源目录。具体操作,请参见[EnableResourceDirectory](~~604185~~)。'."\n"
+ ."\n"
+ .'### 使用说明'."\n"
+ .'当配额模板的状态`ServiceStatus`为`0`(未设置)或`-1`(禁用)时,您可以先将其修改为`1`(开启),再调用[CreateTemplateQuotaItem](~~450615~~)接口创建配额模板。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyQuotaTemplateServiceStatus'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:ModifyQuotaTemplateServiceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</DeleteTemplateQuotaItemResponse>","errorExample":""}]',
- 'title' => '删除配额模板',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TemplateServiceStatus\\": {\\n \\"ResourceDirectoryId\\": \\"rd-pG****\\",\\n \\"ServiceStatus\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyQuotaTemplateServiceStatusResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <TemplateServiceStatus>\\n <ServiceStatus>1</ServiceStatus>\\n <ResourceDirectoryId>rd-pG****</ResourceDirectoryId>\\n </TemplateServiceStatus>\\n</ModifyQuotaTemplateServiceStatusResponse>","errorExample":""}]',
],
- 'CreateQuotaApplicationsForTemplate' => [
- 'summary' => '当您将配额项加入配额模板时,仅资源目录中新增的成员会自动提交配额提升申请,已有成员无变化。如果您需要通过配额模板为已有成员提升配额,则可以批量选择配额模板为资源目录中的多个成员提交配额提升申请。只有资源目录的管理员账号可批量创建配额申请。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ModifyTemplateQuotaItem' => [
+ 'summary' => '管理账号修改配额模板后,修改结果仅对资源目录中管理账号新增的成员生效,已有成员无变化。只有资源目录的管理员账号可修改配额模版。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5126,974 +3602,855 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotasRRW33P',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREquotasC0TSBQ'],
],
'parameters' => [
[
- 'name' => 'QuotaCategory',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
- 'description' => '配额类型。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
- ],
- ],
+ 'schema' => ['description' => '配额模板ID。'."\n"
+ .'关于如何获取配额模板ID,请参见[ListQuotaApplicationTemplates](~~450403~~)。', 'type' => 'string', 'required' => true, 'example' => '1****'],
],
[
'name' => 'ProductCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '产品code',
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs-spec',
- ],
+ 'schema' => ['description' => '云产品的缩写名称。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'QuotaActionCode',
'in' => 'formData',
- 'schema' => [
- 'title' => 'quota的code',
- 'description' => '配额ID。'."\n"
- ."\n"
- .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ecs.g5.2xlarge',
- ],
+ 'schema' => ['description' => '配额ID。'."\n"
+ ."\n"
+ .'> 关于如何获取云产品的配额ID,请参见[ListProductQuotas](~~440554~~)中的`QuotaActionCode`。', 'type' => 'string', 'required' => false, 'example' => 'q_security-groups'],
],
[
'name' => 'Dimensions',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'title' => '配额维度',
'description' => '配额维度。',
'type' => 'array',
'items' => [
'description' => '配额维度。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '配额维度的Key。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'regionId',
- ],
- 'Value' => [
- 'description' => '配额维度的Value。'."\n"
- ."\n"
- .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
- .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'Key' => ['description' => '配额维度的Key。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'regionId'],
+ 'Value' => ['description' => '配额维度的Value。'."\n"
+ ."\n"
+ .'> - N的取值范围取决于云产品支持的维度个数。'."\n"
+ .'> - 当`ProductCode`为`ecs`、`ecs-spec`、`actiontrail`、`ess`等时,配额维度的Key和Value必须同时设置。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
'required' => false,
],
'required' => false,
- 'maxItems' => 10,
+ 'maxItems' => 5,
],
],
[
'name' => 'DesireValue',
'in' => 'formData',
- 'schema' => [
- 'title' => '申请的配额量',
- 'description' => '配额申请的值。'."\n"
- ."\n"
- .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
- .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => true,
- 'example' => '12',
- ],
- ],
- [
- 'name' => 'Reason',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '申请理由',
- 'description' => '配额申请的原因。'."\n"
- ."\n"
- .'> 配额申请由各云服务的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Scale Out',
- ],
+ 'schema' => ['description' => '配额申请的值。'."\n"
+ ."\n"
+ .'> - 根据[ListProductQuotas](~~440554~~)中目标配额的`TotalUsage`(配额用量)和`ApplicableRange`(配额项可申请范围)来设置配额申请值。'."\n"
+ .'> - 配额申请由各云产品的技术支持进行审批。如果您想增加通过几率,请在配额申请时填写合理的申请数值和详尽的申请理由。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '804'],
],
[
'name' => 'NoticeType',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请结果是否发送通知。取值:'."\n"
- ."\n"
- .'- 0(默认值):否。'."\n"
- .'- 3:是。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '配额申请结果是否发送通知。取值:'."\n"
+ ."\n"
+ .'- 0(默认值):否。'."\n"
+ .'- 3:是。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'EnvLanguage',
'in' => 'formData',
- 'schema' => [
- 'title' => '环境 语种,如',
- 'description' => '配额申请结果通知的语言。取值:'."\n"
- ."\n"
- .'- zh(默认值):中文。'."\n"
- .'- en:英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '配额告警通知的语言。取值:'."\n"
+ ."\n"
+ .'- zh(默认值):中文。'."\n"
+ .'- en:英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'EffectiveTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '生效时间',
- 'description' => '配额生效的UTC时间。该参数仅适用于权益配额(WhiteListLabel)。'."\n"
- .' '."\n"
- .'>如果当前账号不选择生效时间,则默认为提交时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-19T09:25:56Z',
- ],
+ 'schema' => ['description' => '配额生效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 数据为空表示立即生效。', 'type' => 'string', 'required' => false, 'example' => '2021-01-19T09:25:56Z'],
],
[
'name' => 'ExpireTime',
'in' => 'formData',
+ 'schema' => ['description' => '配额失效的UTC时间。'."\n"
+ .'该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
+ ."\n"
+ .'> 数据为空表示未设定UTC失效时间。', 'type' => 'string', 'required' => false, 'example' => '2021-01-20T09:25:56Z'],
+ ],
+ [
+ 'name' => 'QuotaCategory',
+ 'in' => 'query',
'schema' => [
- 'title' => '过期时间(UTC 格式)',
- 'description' => '配额失效的UTC时间。该参数仅适用于权益配额(WhiteListLabel)。 '."\n"
- ."\n"
- .'> 如果当前账号未选择失效时间,则失效时间为当前配额生效时间开始起99年。',
+ 'description' => '配额种类。取值:'."\n"
+ .'- CommonQuota(默认值):通用配额。'."\n"
+ .'- WhiteListLabel:权益配额。'."\n"
+ .'- FlowControl:API速率配额。',
'type' => 'string',
'required' => false,
- 'example' => '2021-01-20T09:25:56Z',
+ 'example' => 'CommonQuota',
+ 'enum' => ['WhiteListLabel', 'CommonQuota', 'FlowControl'],
],
],
- [
- 'name' => 'AliyunUids',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '批量调整账号',
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。'."\n"
- ."\n"
- .'> 单次最多只支持为50个成员批量申请提升配额。关于资源目录的成员,请参见[ListAccounts](~~604207~~)。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '135048337611****'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => '无。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '配额模板ID。', 'type' => 'string', 'example' => '1****'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'TEMPLATE.NOT.FOUND', 'errorMessage' => 'Quota template does not exist.', 'description' => '配额模板信息不存在。'],
+ ['errorCode' => 'UNSUPPORT.UPDATE.PRODUCTCODE.QUOTACODE', 'errorMessage' => 'Modification of product name, quota code and dimension data is not supported', 'description' => '不支持产品名称、配额Code和维度修改'],
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
+ ['errorCode' => 'TEMPLATE.NOT.RD.MA', 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ['errorCode' => 'QUOTA.DESIREVALUE.ILLEGAL', 'errorMessage' => 'DesirValue less than or equal to the current quota value, or that is not within the adjustable range.', 'description' => '申请值小于等于当前配额值或申请值不在配额项可调整的范围内。'],
+ ['errorCode' => 'UNSUPPORT.UPDATE.DIMENSIONS', 'errorMessage' => 'The Quota dimension don\'t support be modified when you update quota template.', 'description' => '配额模板变更不支持配额维度的修改'],
+ ['errorCode' => 'TEMPLATE.ITEM.NOT.FOUND', 'errorMessage' => 'Quota template item does not exist.', 'description' => '配额模板项不存在'],
+ ],
+ ],
+ 'title' => '修改配额模板',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTemplateQuotaItem'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quotas:ModifyTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
],
- 'required' => true,
- 'maxItems' => 100,
],
],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"1****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTemplateQuotaItemResponse>\\n <RequestId>D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053</RequestId>\\n <Id>1****</Id>\\n</ModifyTemplateQuotaItemResponse>","errorExample":""}]',
+ ],
+ 'RemindQuotaApplicationApproval' => [
+ 'summary' => '查询支持审批提醒的配额申请单。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREquotasVP27J0'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApplicationId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '申请单 id', 'description' => '配额申请单ID。'."\n"
+ ."\n"
+ .'关于如何获取配额申请单ID,请参见[ListQuotaApplications](~~440568~~)。', 'type' => 'string', 'required' => false, 'example' => '219f1ff6-6205-495f-bda7-90d2fe945e****'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO<String>',
- 'description' => '提交申请返回结果。',
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'AliyunUids' => [
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)。',
- 'type' => 'string',
- 'example' => '135048337611****',
- ],
- ],
- 'BatchQuotaApplicationId' => [
- 'description' => '配额申请批次ID。',
- 'type' => 'string',
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
- ],
- 'FailResults' => [
- 'description' => '配额申请失败的资源目录成员的阿里云账号(主账号)和失败原因列表。',
+ 'AllowRetry' => ['description' => '是否允许重试。取值:'."\n"
+ .'- false:不允许重试。'."\n"
+ .'- true:允许重试。', 'type' => 'boolean', 'example' => 'false'],
+ 'DynamicCode' => ['description' => '动态错误码。', 'type' => 'string', 'example' => 'PARAMETER.ILLEGALL'],
+ 'DynamicMessage' => ['description' => '动态错误信息。', 'type' => 'string', 'example' => 'Parameter[%s] is required.'],
+ 'ErrorArgs' => [
+ 'description' => '错误的参数组。',
'type' => 'array',
- 'items' => [
- 'description' => '配额申请失败的资源目录成员的阿里云账号(主账号)和失败原因列表。',
- 'type' => 'object',
- 'properties' => [
- 'AliyunUid' => [
- 'description' => '配额申请失败的资源目录成员的阿里云账号(主账号)。',
- 'type' => 'string',
- 'example' => '135048337611****',
- ],
- 'Reason' => [
- 'description' => '失败原因。',
- 'type' => 'string',
- 'example' => 'The quota adjustment application is being processed. Please try again later.',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3',
+ 'items' => ['description' => '错误的参数。', 'type' => 'any', 'example' => 'ApplicationId'],
],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'RAM.PERMISSION.DENIED'."\n"],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'You are not authorized to do this action or the API input parameter is invalid.'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Module' => ['description' => '返回对象,配额申请单ID。', 'type' => 'string', 'example' => '219f1ff6-6205-495f-bda7-90d2fe945e****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053'],
+ 'Success' => ['description' => '是否调用成功。取值:'."\n"
+ .'- true:调用成功。'."\n"
+ .'- false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'QUOTA.APPLICATION.TIME.ERROE',
- 'errorMessage' => 'ExpireTime cannot be earlier than the current time or EffectiveTime.',
- ],
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
- ],
- [
- 'errorCode' => 'QUOTA.APPLICATION.PROCESS',
- 'errorMessage' => 'The quota adjustment application is being processed. Please try again later.',
+ ['errorCode' => 'QUOTA.APPLICATION.NOT.FOUND', 'errorMessage' => 'Quota application does not exist', 'description' => '配额申请不存在。'],
+ ['errorCode' => 'REMIND.APPLICATION.LIMIT', 'errorMessage' => 'Quota application do not support reminders or reminder interval exceeds the limit.', 'description' => '配额申请单不支持催单或催单间隔超过限制。'],
+ ],
+ ],
+ 'title' => '查询支持审批提醒的配额申请单',
+ 'description' => '> 本接口仅适用于支持配额审批提醒的申请单,即GetQuotaApplicationApproval接口中`SupportReminder`为`true`。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemindQuotaApplicationApproval'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:RemindQuotaApplicationApproval',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AliyunUids\\": [\\n \\"135048337611****\\"\\n ],\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"FailResults\\": [\\n {\\n \\"AliyunUid\\": \\"135048337611****\\",\\n \\"Reason\\": \\"The quota adjustment application is being processed. Please try again later.\\"\\n }\\n ],\\n \\"RequestId\\": \\"8FF8CAF0-29D9-4F11-B6A4-FD2CBCA016D3\\"\\n}","type":"json"}]',
- 'title' => '通过配额模板批量申请成员配额',
- 'description' => '### 使用限制'."\n"
- .'单次申请的配额项不超过10个。',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AllowRetry\\": false,\\n \\"DynamicCode\\": \\"PARAMETER.ILLEGALL\\",\\n \\"DynamicMessage\\": \\"Parameter[%s] is required.\\",\\n \\"ErrorArgs\\": [\\n \\"ApplicationId\\"\\n ],\\n \\"ErrorCode\\": \\"RAM.PERMISSION.DENIED\\\\n\\",\\n \\"ErrorMsg\\": \\"You are not authorized to do this action or the API input parameter is invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Module\\": \\"219f1ff6-6205-495f-bda7-90d2fe945e****\\",\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListQuotaApplicationsDetailForTemplate' => [
- 'summary' => '查询资源目录中成员配额提升申请详情。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateQuotaAlarm' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotas29QQRO',
- ],
+ 'abilityTreeNodes' => ['FEATUREquotasC3VMZU'],
],
'parameters' => [
[
- 'name' => 'AliyunUid',
+ 'name' => 'AlarmId',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额提升申请的阿里云账号(主账号)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '135048337611****',
- ],
+ 'schema' => ['description' => '配额告警ID。'."\n"
+ ."\n"
+ .'> 关于如何获取配额告警ID,请参见[ListQuotaAlarms](~~440561~~)。', 'type' => 'string', 'required' => true, 'example' => 'a2efa7fc-832f-47bb-8054-39e28012****'],
],
[
- 'name' => 'ProductCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs',
- ],
- ],
- [
- 'name' => 'QuotaActionCode',
+ 'name' => 'AlarmName',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.c5.large',
- ],
+ 'schema' => ['description' => '配额告警名称。'."\n"
+ ."\n"
+ .'> 关于如何获取配额告警名称,请参见[ListQuotaAlarms](~~440561~~)。', 'type' => 'string', 'required' => true, 'example' => 'rules'],
],
[
- 'name' => 'Status',
+ 'name' => 'ThresholdType',
'in' => 'formData',
'schema' => [
- 'title' => 'Agree, Disagree, Process, Cancel',
- 'description' => '配额提升申请的审批状态。取值:'."\n"
- ."\n"
- .'- Disagree:拒绝。'."\n"
- ."\n"
- .'- Agree:审核通过。'."\n"
- ."\n"
- .'- Process:审核中。'."\n"
+ 'description' => '配额告警类型。取值:'."\n"
."\n"
- .'- Cancel:已关闭。',
+ .'- used(默认值):已使用量告警。'."\n"
+ .'- usable:剩余可用量告警。',
'type' => 'string',
'required' => false,
- 'example' => 'Agree',
+ 'example' => 'usable',
+ 'default' => 'used',
+ 'enum' => ['used', 'usable'],
],
],
[
- 'name' => 'BatchQuotaApplicationId',
+ 'name' => 'Threshold',
'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请批次ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****'."\n",
- ],
+ 'schema' => ['description' => '配额告警阈值的数值。取值:'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设数值,您会收到告警通知。配额告警阈值必须大于配额的已使用量。'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设数值,您会收到告警通知。配额告警阈值必须小于配额的剩余可用量。'."\n"
+ ."\n"
+ .'> 该参数与ThresholdPercent必须设置一个。', 'type' => 'number', 'format' => 'float', 'required' => false, 'minimum' => '1', 'example' => '160'],
],
[
- 'name' => 'QuotaCategory',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
- ],
- ],
- ],
- [
- 'name' => 'NextToken',
+ 'name' => 'ThresholdPercent',
'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记开始查询数据的位置。'."\n"
- ."\n"
- .'> 不设置该参数,表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4',
- ],
+ 'schema' => ['description' => '配额告警阈值的百分比。取值:'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`used`时,如果配额的已使用量大于等于预设百分比,您会收到告警通知。取值范围:(50%, 100%]。'."\n"
+ ."\n"
+ .'- 当`ThresholdType`选择`usable`时,如果配额的剩余可用量小于等于预设百分比,您会收到告警通知。取值范围:(0%, 50%]。'."\n"
+ ."\n"
+ .'> 该参数与Threshold必须设置一个', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '50', 'example' => '51'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'WebHook',
'in' => 'formData',
- 'schema' => [
- 'description' => '本次查询的最大记录条数。'."\n"
- ."\n"
- .'取值范围:1~100。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => '配额中心将告警信息通过HTTP协议的POST请求发送到指定公网的URL地址。', 'type' => 'string', 'required' => false, 'example' => 'https://alert.aliyun.com/callback'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ResultList<QuotaBatchApplicationVo>',
- 'description' => '配额申请详情列表。',
'type' => 'object',
'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询的最大记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'NextToken' => [
- 'description' => '用来标记开始查询数据的位置。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'QuotaApplications' => [
- 'description' => '配额申请详情列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额申请详情列表。',
- 'type' => 'object',
- 'properties' => [
- 'AliyunUid' => [
- 'description' => '阿里云账号(主账号)。',
- 'type' => 'string',
- 'example' => '175376458581****',
- ],
- 'ApplicationId' => [
- 'description' => '配额提升申请的ID。',
- 'type' => 'string',
- 'example' => 'b926571d-cc09-4711-b547-58a615f0****',
- ],
- 'ApplyTime' => [
- 'description' => '配额提升申请的UTC时间。',
- 'type' => 'string',
- 'example' => '2021-01-15T09:13:53Z',
- ],
- 'ApproveValue' => [
- 'description' => '配额提升申请审批通过的配额值。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '101',
- ],
- 'AuditReason' => [
- 'description' => '配额提升申请的审批意见。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- 'BatchQuotaApplicationId' => [
- 'description' => '配额申请批次ID。',
- 'type' => 'string',
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
- ],
- 'DesireValue' => [
- 'description' => '配额提升申请的配额值。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '60',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效的UTC时间。',
- 'type' => 'string',
- 'example' => '2021-01-15T11:46:25Z',
- ],
- 'EnvLanguage' => [
- 'description' => '配额告警通知的语言。取值:'."\n"
- ."\n"
- .'- zh:中文。'."\n"
- .'- en:英文。',
- 'type' => 'string',
- 'example' => 'zh',
- ],
- 'ExpireTime' => [
- 'description' => '配额失效的UTC时间。',
- 'type' => 'string',
- 'example' => '2021-01-17T11:46:25Z',
- ],
- 'NoticeType' => [
- 'description' => '配额提升申请结果是否通知。取值:'."\n"
- ."\n"
- .'- 0:否。'."\n"
- .'- 3:是。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'Period' => [
- 'description' => '配额计算周期。'."\n",
- 'type' => 'object',
- 'properties' => [
- 'PeriodUnit' => [
- 'title' => '配额计算周期单位',
- 'description' => '配额计算周期单位。',
- 'type' => 'string',
- 'example' => 'second',
- ],
- 'PeriodValue' => [
- 'title' => '配额计算周期值',
- 'description' => '配额计算周期值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'ecs',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'ecs.n1.large',
- ],
- 'QuotaArn' => [
- 'description' => '配额ARN。',
- 'type' => 'string',
- 'example' => 'acs:quotas:*:120886317861****:quota/csk/q_i5uzm3',
- ],
- 'QuotaCategory' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota(默认值):通用配额。'."\n"
- .'- WhiteListLabel:权益配额。'."\n"
- .'- FlowControl:API速率配额。',
- 'type' => 'string',
- 'example' => 'CommonQuota',
- ],
- 'QuotaDescription' => [
- 'description' => '配额描述。',
- 'type' => 'string',
- 'example' => 'The maximum number of nodes in a cluster',
- ],
- 'QuotaDimension' => [
- 'description' => '配额维度。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"regionId":"cn-hangzhou"}',
- 'description' => '配额维度。'."\n"
- ."\n"
- .'格式:`{"regionId":"cn-hangzhou"}`。',
- ],
- ],
- 'QuotaName' => [
- 'description' => '配额名称。',
- 'type' => 'string',
- 'example' => 'Maximum Number of Nodes',
- ],
- 'QuotaUnit' => [
- 'description' => '配额单位。',
- 'type' => 'string',
- 'example' => 'GiB',
- ],
- 'Reason' => [
- 'description' => '配额提升申请的原因。',
- 'type' => 'string',
- 'example' => 'Maximum Number of Nodes',
- ],
- 'Status' => [
- 'description' => '配额提升申请的审批状态。取值:'."\n"
- ."\n"
- .'- Disagree:拒绝。'."\n"
- ."\n"
- .'- Agree:审核通过。'."\n"
- ."\n"
- .'- Process:审核中。'."\n"
- ."\n"
- .'- Cancel:已关闭。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A95C65B3-7CF4-469E-B1D5-1CA0628A6411'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
+ ['errorCode' => 'RAM.PERMISSION.DENIED', 'errorMessage' => 'You are not authorized to do this action or the API input parameter is invalid.', 'description' => '没有权限或者参数非法'],
+ ['errorCode' => 'UNSUPPORTED.ALARM.TYPE', 'errorMessage' => 'Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.', 'description' => '统一告警不支持告警类型为已使用量告警,并且不支持配额告警阈值类型为数值'],
+ ['errorCode' => 'THRESHOLD.ILLEGAL', 'errorMessage' => 'The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].', 'description' => 'ThresholdPercent和Threshold不能同时为空或者ThresholdPercent需要在 (0,100]的范围内。'],
+ ['errorCode' => 'ALARM.NAME.REPEAT', 'errorMessage' => 'The warning name must be unique.', 'description' => '预警名称不可重复。'],
+ ['errorCode' => 'ALARM.NOT.FOUND', 'errorMessage' => 'The AlarmId provided does not exist in our records.', 'description' => '配额预警不存在。'],
+ ['errorCode' => 'THRESHOLD.MAx.ILLEGAL', 'errorMessage' => 'The quota warning threshold cannot be greater than the current quota.', 'description' => '配额预警阈值不能大于当前配额。'],
+ ],
+ ],
+ 'title' => '修改配额用量告警信息',
+ 'summary' => '修改配额告警信息。',
+ 'description' => '配额告警功能已升级,本API即将废弃,请您使用云监控API [PutResourceMetricRules](~~2513316~~)、[PutMetricRuleTargets](~~2513302~~)修改新版配额用量告警信息。'."\n"
+ .'使用API对新版配额告警进行操作的更多信息,请参见[使用API管理新版配额告警](~~2863234~~)。',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateQuotaAlarm'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quotas:UpdateQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaApplications\\": [\\n {\\n \\"AliyunUid\\": \\"175376458581****\\",\\n \\"ApplicationId\\": \\"b926571d-cc09-4711-b547-58a615f0****\\",\\n \\"ApplyTime\\": \\"2021-01-15T09:13:53Z\\",\\n \\"ApproveValue\\": 101,\\n \\"AuditReason\\": \\"Agree\\",\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"DesireValue\\": 60,\\n \\"EffectiveTime\\": \\"2021-01-15T11:46:25Z\\",\\n \\"EnvLanguage\\": \\"zh\\",\\n \\"ExpireTime\\": \\"2021-01-17T11:46:25Z\\",\\n \\"NoticeType\\": 3,\\n \\"Period\\": {\\n \\"PeriodUnit\\": \\"second\\",\\n \\"PeriodValue\\": 1\\n },\\n \\"ProductCode\\": \\"ecs\\",\\n \\"QuotaActionCode\\": \\"ecs.n1.large\\",\\n \\"QuotaArn\\": \\"acs:quotas:*:120886317861****:quota/csk/q_i5uzm3\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"QuotaDescription\\": \\"The maximum number of nodes in a cluster\\",\\n \\"QuotaDimension\\": {\\n \\"key\\": \\"{\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\"}\\"\\n },\\n \\"QuotaName\\": \\"Maximum Number of Nodes\\",\\n \\"QuotaUnit\\": \\"GiB\\",\\n \\"Reason\\": \\"Maximum Number of Nodes\\",\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 9\\n}","type":"json"}]',
- 'title' => '查询配额模板批量配额申请详情',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A95C65B3-7CF4-469E-B1D5-1CA0628A6411\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateQuotaAlarmResponse>\\r\\n\\t<RequestId>2542826A-B67E-42C7-B1CB-2F5B52CDE9A8</RequestId>\\r\\n</UpdateQuotaAlarmResponse>","errorExample":""}]',
],
- 'ListQuotaApplicationsForTemplate' => [
- 'summary' => '查询配额模板批量申请成员配额的申请历史。',
- 'methods' => [
- 'post',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => 'quotas-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => 'quotas-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => 'quotas-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'quotas.aliyuncs.com', 'endpoint' => 'quotas.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => '500', 'message' => 'Service error. Please contact the technical support team if the error persists after retrying.', 'http_code' => 400, 'description' => '服务异常,请重试,重试后无法解决请联系技术支持团队。'],
+ ['code' => 'ACQUIRE.LOCK.FAIL', 'message' => 'The request is too frequent. Please try again later.', 'http_code' => 400, 'description' => '访问频繁,请稍后重试。'],
+ ['code' => 'ALARM.NAME.REPEAT', 'message' => 'The warning name must be unique.', 'http_code' => 400, 'description' => '预警名称不可重复。'],
+ ['code' => 'ALARM.NOT.FOUND', 'message' => 'The AlarmId provided does not exist in our records.', 'http_code' => 400, 'description' => '配额预警不存在。'],
+ ['code' => 'Alert.Name.Repeat', 'message' => 'The alert name must not be duplicated.', 'http_code' => 400, 'description' => '预警名称不可重复'],
+ ['code' => 'Alert.Not.Found', 'message' => 'The quota alert does not exist.', 'http_code' => 400, 'description' => '配额预警不存在'],
+ ['code' => 'BUSINESS.ERROR', 'message' => 'Internal error, please try again or contact the technical staff for help.', 'http_code' => 400, 'description' => '业务异常,请重试或联系技术人员寻求帮助。'],
+ ['code' => 'CATEGORY.NOT.SUPPORTED', 'message' => 'Quota category does not supported yet.', 'http_code' => 400, 'description' => '配额类型不支持'],
+ ['code' => 'DIMENSIONGROUP.NOT.FOUND', 'message' => 'Dimension group does not exist.', 'http_code' => 400, 'description' => '维度组参数不正确'],
+ ['code' => 'INVALID.APPLY.TIME', 'message' => 'The query time is out of range, please query data for up to 7 days at most.', 'http_code' => 400, 'description' => '查询时间超范围,请最多查询7天的数据。'],
+ ['code' => 'INVALID.MA.RESULTS', 'message' => 'The maxResults parameter is invalid. Use an integer ranging from 1 to 100.', 'http_code' => 400, 'description' => 'maxResults参数不合法,请使用1~100范围内的整数。'],
+ ['code' => 'INVALID.MAX.RESULTS', 'message' => 'The maxResults parameter is invalid. Use an integer ranging from 1 to 100.', 'http_code' => 400, 'description' => 'maxResults参数不合法,请使用1~100范围内的整数。'],
+ ['code' => 'InvalidAccessKeyId', 'message' => 'The AccessKey Id you provided is not exist.', 'http_code' => 404, 'description' => '无效的AccessKey'],
+ ['code' => 'InvalidAccessKeyId.Inactive', 'message' => 'The specified AccessKey is disabled. Only enabled AccessKey can be used.', 'http_code' => 400, 'description' => 'AccessKey被禁用。请检查AccessKey是否正常可用。请使用状态为启用的AccessKey。'],
+ ['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'The Access Key ID provided does not exist in our records.', 'http_code' => 404, 'description' => '无效的AccessKey'],
+ ['code' => 'InvalidDesireValue', 'message' => 'Invalid DesireValue', 'http_code' => 400, 'description' => '参数 DesireValue 无效。'],
+ ['code' => 'InvalidEndTime', 'message' => 'Invalid EndTime', 'http_code' => 400, 'description' => '查询结束时间无效。'],
+ ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => '参数MaxResults无效。'],
+ ['code' => 'InvalidNoticeType', 'message' => 'Invalid NoticeType', 'http_code' => 400, 'description' => '参数NoticeType无效。'],
+ ['code' => 'InvalidQuotaCategory', 'message' => 'The QuotaCategory is invalid.', 'http_code' => 400, 'description' => '参数QuotaCategory无效。'],
+ ['code' => 'InvalidSecurityToken.Expired', 'message' => 'The security token expires. Check your security token. We recommend that you apply for a security token again.', 'http_code' => 400, 'description' => 'SecurityToken过期,请检查SecurityToken,建议重新申请SecurityToken。'],
+ ['code' => 'InvalidSortOrder', 'message' => 'Invalid SortOrder', 'http_code' => 400, 'description' => '参数SortOrder无效。'],
+ ['code' => 'InvalidStartTime', 'message' => 'Invalid StartTime', 'http_code' => 400, 'description' => '查询开始时间无效。'],
+ ['code' => 'InvalidStatus', 'message' => 'Invalid Status', 'http_code' => 400, 'description' => '参数Status无效。'],
+ ['code' => 'InvalidThreshold', 'message' => 'The Threshold is invalid.', 'http_code' => 400, 'description' => '参数Threshold无效。'],
+ ['code' => 'InvalidThresholdType', 'message' => 'The ThresholdType is invalid.', 'http_code' => 400, 'description' => '参数ThresholdType无效。'],
+ ['code' => 'InvalidTimeStamp.Expired', 'message' => 'Specified time stamp or date value is expired.', 'http_code' => 400, 'description' => '用户时间和服务器时间不在15分钟内请检查您的时间戳设置,确认时间戳和服务器时间的差值是否在15分钟内。'],
+ ['code' => 'MissingAccessKeyId', 'message' => 'AccessKeyId is mandatory for this action', 'http_code' => 400, 'description' => '缺少AccessKey。'],
+ ['code' => 'MissingProductCode', 'message' => 'ProductCode is missing', 'http_code' => 400, 'description' => '请求ProductCode缺失。'],
+ ['code' => 'MissingQuotaActionCode', 'message' => 'QuotaActionCode Is Miss', 'http_code' => 400, 'description' => '参数QuotaActionCode缺失。'],
+ ['code' => 'NOT.RD.ACCOUNT', 'message' => '配额申请的阿里云账号存在不是该资源目录的成员的账号', 'http_code' => 400, 'description' => '配额申请的阿里云账号存在不是该资源目录的成员的账号'],
+ ['code' => 'NOT.RD.ACCOUNT', 'message' => 'The account that needs to apply for a quota is not a member account of the Resource Directory (RD).', 'http_code' => 400, 'description' => '需要申请配额的账号不是该资源目录(RD)的成员账号。'],
+ ['code' => 'PARAMETER.ILLEGALL', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '参数错误。'],
+ ['code' => 'QUOTA.ALARM.MAX', 'message' => 'Quota alarm have reached the upper limit of 100', 'http_code' => 400, 'description' => '已达配额预警数上限。'],
+ ['code' => 'Quota.Alert.Max', 'message' => 'The maximum number of quota alerts is exceeded.', 'http_code' => 400, 'description' => '已达配额预警数上限。'],
+ ['code' => 'QUOTA.APPLICATION.NOT.FOUND', 'message' => 'The quota adjustment application does not exist.', 'http_code' => 400, 'description' => '配额调整申请不存在'],
+ ['code' => 'QUOTA.APPLICATION.NOT.FOUND', 'message' => 'Quota application does not exist', 'http_code' => 400, 'description' => '配额申请不存在。'],
+ ['code' => 'QUOTA.APPLICATION.PROCESS', 'message' => 'The quota adjustment application is being processed. Please try again later.', 'http_code' => 400, 'description' => '配额申请调整处理中,暂不能提交申请。'],
+ ['code' => 'QUOTA.APPLICATION.TIME.ERROE', 'message' => 'ExpireTime cannot be earlier than the current time or EffectiveTime.', 'http_code' => 400, 'description' => '失效时间不能早于当前时间或生效时间'],
+ ['code' => 'QUOTA.DESIREVALUE.ILLEGAL', 'message' => 'DesirValue less than or equal to the current quota value, or that is not within the adjustable range.', 'http_code' => 400, 'description' => '申请值小于等于当前配额值或申请值不在配额项可调整的范围内。'],
+ ['code' => 'QUOTA.DIMENSION.MISS', 'message' => 'The specified parameter is invalid. Please try again later.', 'http_code' => 400, 'description' => '配额输入参数异常,请稍后重新提交申请。'],
+ ['code' => 'QUOTA.DIMENSION.MISS', 'message' => 'The entered quota dimension is incomplete,Please complete the dimension.', 'http_code' => 400, 'description' => '配额维度输入不完整,请补全维度。'],
+ ['code' => 'QUOTA.DIMENSION.UNSUPPORT', 'message' => 'The entered quota dimension key is not supported.', 'http_code' => 400, 'description' => '输入的配额维度key不支持。'],
+ ['code' => 'QUOTA.DIMENSION.VALUE.UNSUPPORT', 'message' => 'The entered quota dimension value is not supported.', 'http_code' => 400, 'description' => '输入的配额维度值不支持。'],
+ ['code' => 'QUOTA.IS.OFFLINE.QUIET.PERIOD', 'message' => 'This quota is offline quiet period. Do not support creating alarm or templates and applying for quotas.', 'http_code' => 400, 'description' => '该配额为下市静默期,不支持配额申请,创建告警和模版。'],
+ ['code' => 'QUOTA.NOT.ADJUSTABLE', 'message' => 'The quota cannot be adjusted.', 'http_code' => 400, 'description' => '配额不可调整。'],
+ ['code' => 'QUOTA.NOT.ADJUSTABLE', 'message' => 'Quota is not adjustable', 'http_code' => 400, 'description' => '配额不可调整。'],
+ ['code' => 'QUOTA.NOT.FOUND', 'message' => 'The quota does not exist.', 'http_code' => 400, 'description' => '配额不存在。'],
+ ['code' => 'Quota.Not.Support.Alert', 'message' => 'You cannot create an alert for the specified quota.', 'http_code' => 400, 'description' => '该配额项不支持创建预警'],
+ ['code' => 'QUOTA.OFFLINE', 'message' => 'The quota has been offline.', 'http_code' => 400, 'description' => '该配额已下市。'],
+ ['code' => 'QUOTA.UNSUPPORT.ALARM', 'message' => 'Quotas without values or without usage display are not supported for configuring alerts.', 'http_code' => 400, 'description' => '查询不到配额值或没有用量信息的配额项不支持创建告警'],
+ ['code' => 'RAM.PERMISSION.DENIED', 'message' => 'You do not have access.', 'http_code' => 400, 'description' => '您没有权限访问。'],
+ ['code' => 'RAM.PERMISSION.DENIED', 'message' => 'You are not authorized to do this action or the API input parameter is invalid.', 'http_code' => 400, 'description' => '没有权限或者参数非法'],
+ ['code' => 'RAM.VERIFICATION.ERROR', 'message' => 'Verify permission service network error, please try again later.', 'http_code' => 400, 'description' => '验权服务网络抖动,请稍后重试当前请求'],
+ ['code' => 'RD.NOT.EXIST', 'message' => 'Resource directory is not exist.', 'http_code' => 400, 'description' => '请求账号无对应资源目录信息'],
+ ['code' => 'RD.REMOTE.ERROR', 'message' => 'Resource directory service exception, please try again later.', 'http_code' => 400, 'description' => '资源目录服务异常,请稍后重试。'],
+ ['code' => 'REMIND.APPLICATION.LIMIT', 'message' => 'Quota application do not support reminders or reminder interval exceeds the limit.', 'http_code' => 400, 'description' => '配额申请单不支持催单或催单间隔超过限制。'],
+ ['code' => 'REMOTE.REQUEST.ERROR', 'message' => 'Service error. Please contact the technical support team if the error persists after retrying.', 'http_code' => 400, 'description' => '服务异常,请重试,重试后无法解决请联系技术支持团队。'],
+ ['code' => 'RISK.USER.RISK', 'message' => 'The account is at risk, please contact customer service or submit a ticket to solve it.', 'http_code' => 400, 'description' => '账户存在风险,请联系客服或提交工单解决。'],
+ ['code' => 'SignatureDoesNotMatch', 'message' => 'The signature we calculated does not match the one you provided. Please refer to the API reference about authentication for details.', 'http_code' => 400, 'description' => '无效的签名。'],
+ ['code' => 'SYSTEM.ERROR', 'message' => 'Service error. Please contact the technical support team if the error persists after retrying.', 'http_code' => 400, 'description' => '服务异常,请重试,重试后无法解决请联系技术支持团队。'],
+ ['code' => 'TEMPLATE.ITEM.NOT.FOUND', 'message' => 'Quota template item does not exist.', 'http_code' => 400, 'description' => '配额模板项不存在'],
+ ['code' => 'TEMPLATE.NOT.FOUND', 'message' => 'Quota template does not exist.', 'http_code' => 400, 'description' => '配额模板信息不存在。'],
+ ['code' => 'TEMPLATE.NOT.RD.MA', 'message' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.', 'http_code' => 400, 'description' => '当前账号非RD的MA主账号,没有操作配额模板权限'],
+ ['code' => 'TEMPLATE.RDID.INVALID', 'message' => 'RdId invalid', 'http_code' => 400, 'description' => '资源ID错误'],
+ ['code' => 'THRESHOLD.ILLEGAL', 'message' => 'The alarm Threshold or ThresholdPercent is either empty or ThresholdPercent not in (0,100].', 'http_code' => 400, 'description' => 'ThresholdPercent和Threshold不能同时为空或者ThresholdPercent需要在 (0,100]的范围内。'],
+ ['code' => 'THRESHOLD.MAx.ILLEGAL', 'message' => 'The quota warning threshold cannot be greater than the current quota.', 'http_code' => 400, 'description' => '配额预警阈值不能大于当前配额。'],
+ ['code' => 'THRESHOLD.MIN.ILLEGAL', 'message' => 'The quota warning threshold cannot be smaller than the currently consumed quota', 'http_code' => 400, 'description' => '配额预警阈值不能小于当前已消耗。'],
+ ['code' => 'Throttling.User', 'message' => 'Request was denied due to user flow control.', 'http_code' => 400, 'description' => '由于请求频次达到阈值,请求被拒绝,请稍后重试。'],
+ ['code' => 'UNSUPPORT.UPDATE.DIMENSIONS', 'message' => 'The Quota dimension don\'t support be modified when you update quota template.', 'http_code' => 400, 'description' => '配额模板变更不支持配额维度的修改'],
+ ['code' => 'UNSUPPORT.UPDATE.PRODUCTCODE.QUOTACODE', 'message' => 'Modification of product name, quota code and dimension data is not supported', 'http_code' => 400, 'description' => '不支持产品名称、配额Code和维度修改'],
+ ['code' => 'UNSUPPORTED.ALARM.TYPE', 'message' => 'Unified alarm does not support alarm types for used quantity alarms, and does not support numerical threshold types of quota alarms.', 'http_code' => 400, 'description' => '统一告警不支持告警类型为已使用量告警,并且不支持配额告警阈值类型为数值'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlarmHistories'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationTemplates'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProductQuotaDimension'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductQuotaDimensions'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTemplateQuotaItem'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaApplication'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaTemplateServiceStatus'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaApplication'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplateQuotaItem'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDependentQuotas'],
+ ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplications'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaAlarm'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemindQuotaApplicationApproval'],
+ ['threshold' => '4', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplateQuotaItem'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaApplicationsForTemplate'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaAlarms'],
+ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProductQuota'],
+ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductQuotas'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyQuotaTemplateServiceStatus'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationsForTemplate'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQuotaAlarm'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteQuotaAlarm'],
+ ['threshold' => '3', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductDimensionGroups'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateQuotaAlarm'],
+ ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQuotaApplicationApproval'],
+ ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotaApplicationsDetailForTemplate'],
+ ],
+ 'product' => ['code' => 'quotas', 'title' => '配额中心'],
+ ],
+ 'ram' => [
+ 'productCode' => 'Quotas',
+ 'productName' => '配额中心',
+ 'ramCodes' => ['quotas'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteTemplateQuotaItem',
+ 'description' => '删除配额模板',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'quotas:DeleteTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetQuotaAlarm',
+ 'description' => '查询配额用量告警详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ListProductQuotaDimensions',
+ 'description' => '查询云产品支持的配额维度',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductQuotaDimensions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListQuotaApplications',
+ 'description' => '查询配额提升申请列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplications',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListQuotaApplicationsDetailForTemplate',
+ 'description' => '查询配额模板批量配额申请详情',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREquotas29QQRO',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationsDetailForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'ProductCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '云产品的缩写名称。'."\n"
- ."\n"
- .'> 关于如何获取云产品的缩写名称,请参见[ListProducts](~~440555~~)中的`ProductCode`。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs-spec',
+ [
+ 'apiName' => 'ModifyTemplateQuotaItem',
+ 'description' => '修改配额模板',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quotas:ModifyTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
],
],
- [
- 'name' => 'QuotaActionCode',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额ID。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ecs.g5.2xlarge',
+ ],
+ [
+ 'apiName' => 'RemindQuotaApplicationApproval',
+ 'description' => '查询支持审批提醒的配额申请单',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:RemindQuotaApplicationApproval',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'BatchQuotaApplicationId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请批次ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
+ ],
+ [
+ 'apiName' => 'GetProductQuotaDimension',
+ 'description' => '查询目标云产品支持的配额维度详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetProductQuotaDimension',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'QuotaCategory',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'CommonQuota, FlowControl, WhiteListLabel',
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CommonQuota',
- 'enum' => [
- 'CommonQuota',
- 'FlowControl',
- 'WhiteListLabel',
- ],
+ ],
+ [
+ 'apiName' => 'ListProductQuotas',
+ 'description' => '查询目标云产品的配额列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductQuotas',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*'],
],
],
- [
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用来标记开始读取数据的位置。'."\n"
- ."\n"
- .'> 不设置该参数,表示从头开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4',
+ ],
+ [
+ 'apiName' => 'DeleteQuotaAlarm',
+ 'description' => '删除配额用量告警',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'quotas:DeleteQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
],
],
- [
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '单次请求返回结果的最大条数。'."\n"
- ."\n"
- .'取值范围:1~100。默认值:30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
+ ],
+ [
+ 'apiName' => 'CreateQuotaApplicationsForTemplate',
+ 'description' => '通过配额模板批量申请成员配额',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaApplicationsForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'ApplyStartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请开始的UTC时间。'."\n"
- ."\n"
- .'> `ApplyStartTime`和`ApplyEndTime`之间的时间间隔必须小于等于7天。如果未设置这两个参数,则配额申请时间为最近7天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-05-22T16:00:00Z'."\n",
+ ],
+ [
+ 'apiName' => 'ListQuotaApplicationsForTemplate',
+ 'description' => '查询配额模板批量配额申请历史',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationsForTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'ApplyEndTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '配额申请结束的UTC时间。'."\n"
- ."\n"
- .'> `ApplyStartTime`和`ApplyEndTime`之间的时间间隔必须小于等于7天。如果未设置这两个参数,则配额申请时间为最近7天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-05-22T16:00:00Z'."\n",
+ ],
+ [
+ 'apiName' => 'GetProductQuota',
+ 'description' => '查询目标云产品的配额详情',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'quotas:GetProductQuota',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'PopResultDTO<ResultList<QuotaBatchApplicationVo>>',
- 'description' => '无。',
- 'type' => 'object',
- 'properties' => [
- 'MaxResults' => [
- 'description' => '本次查询的最大记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'NextToken' => [
- 'description' => '用来标记开始读取数据的位置。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'QuotaBatchApplications' => [
- 'description' => '配额申请历史列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额申请历史列表。',
- 'type' => 'object',
- 'properties' => [
- 'AliyunUids' => [
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '配额申请的资源目录成员的阿里云账号(主账号)。',
- 'type' => 'string',
- 'example' => '14468026070****',
- ],
- ],
- 'ApplyTime' => [
- 'description' => '配额提升申请的UTC时间。',
- 'type' => 'string',
- 'example' => '2022-09-23T02:38:18Z',
- ],
- 'AuditStatusVos' => [
- 'description' => '不同审批状态的申请单数量。',
- 'type' => 'array',
- 'items' => [
- 'description' => '不同审批状态的申请单数量。',
- 'type' => 'object',
- 'properties' => [
- 'Count' => [
- 'description' => '审批单数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'Status' => [
- 'title' => 'Agree, Disagree, Process, Cancel',
- 'description' => '配额提升申请的审批状态。取值:'."\n"
- ."\n"
- .'- Disagree:拒绝。'."\n"
- ."\n"
- .'- Agree:审核通过。'."\n"
- ."\n"
- .'- Process:审核中。'."\n"
- ."\n"
- .'- Cancel:已关闭。',
- 'type' => 'string',
- 'example' => 'Agree',
- ],
- ],
- ],
- ],
- 'BatchQuotaApplicationId' => [
- 'description' => '配额申请批次ID。',
- 'type' => 'string',
- 'example' => 'd314d6ae-867d-484c-9009-3d421a80****',
- ],
- 'DesireValue' => [
- 'description' => '配额申请的值。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '105',
- ],
- 'Dimensions' => [
- 'description' => '配额维度。'."\n"
- ."\n"
- .'格式:{"regionId":"cn-hangzhou"}。',
- 'type' => 'object',
- 'example' => '{"regionId":"cn-hangzhou"}',
- ],
- 'EffectiveTime' => [
- 'description' => '配额生效的UTC时间。',
- 'type' => 'string',
- 'example' => '2023-05-22T16:00:00Z',
- ],
- 'ExpireTime' => [
- 'description' => '配额失效的UTC时间。',
- 'type' => 'string',
- 'example' => '2024-05-14T02:08:56Z',
- ],
- 'ProductCode' => [
- 'description' => '云服务名称缩写。',
- 'type' => 'string',
- 'example' => 'vpc',
- ],
- 'QuotaActionCode' => [
- 'description' => '配额ID。',
- 'type' => 'string',
- 'example' => 'q_fhoz4k',
- ],
- 'QuotaCategory' => [
- 'description' => '配额种类。取值:'."\n"
- .'- CommonQuota:通用配额。'."\n"
- .'- FlowControl:API速率配额。'."\n"
- .'- WhiteListLabel:权益配额。',
- 'type' => 'string',
- 'example' => 'CommonQuota',
- ],
- 'Reason' => [
- 'description' => '配额提升申请的原因。',
- 'type' => 'string',
- 'example' => 'Business expansion',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053',
- ],
- 'TotalCount' => [
- 'description' => '本次请求返回的全部记录条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '67',
- ],
- ],
+ [
+ 'apiName' => 'ListQuotaAlarms',
+ 'description' => '查询配额用量告警列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaAlarms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'TEMPLATE.NOT.RD.MA',
- 'errorMessage' => 'The requested account is not the MA master account of RD and does not have permission to operate quota templates.',
+ [
+ 'apiName' => 'CreateTemplateQuotaItem',
+ 'description' => '创建配额模板',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateTemplateQuotaItem',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetQuotaTemplateServiceStatus',
+ 'description' => '查询配额模板状态',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaTemplateServiceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyQuotaTemplateServiceStatus',
+ 'description' => '修改配额模板状态',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'quotas:ModifyQuotaTemplateServiceStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetQuotaApplicationApproval',
+ 'description' => '查询配额申请单审批信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaApplicationApproval',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateQuotaApplication',
+ 'description' => '创建配额提升申请',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaApplication', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAlarmHistories',
+ 'description' => '查询配额用量告警历史记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListAlarmHistories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateQuotaAlarm',
+ 'description' => '修改配额用量告警信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'quotas:UpdateQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetQuotaApplication',
+ 'description' => '查询配额提升申请详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:GetQuotaApplication',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaApplication', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateQuotaAlarm',
+ 'description' => '创建配额用量告警',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'quotas:CreateQuotaAlarm',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListProductDimensionGroups',
+ 'description' => '查询云产品的维度组',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListProductDimensionGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDependentQuotas',
+ 'description' => '查询目标配额依赖的配额列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'quotas:ListDependentQuotas',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListQuotaApplicationTemplates',
+ 'description' => 'ListQuotaApplicationTemplates',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'quotas:ListQuotaApplicationTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Quotas', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MaxResults\\": 30,\\n \\"NextToken\\": \\"1\\",\\n \\"QuotaBatchApplications\\": [\\n {\\n \\"AliyunUids\\": [\\n \\"14468026070****\\"\\n ],\\n \\"ApplyTime\\": \\"2022-09-23T02:38:18Z\\",\\n \\"AuditStatusVos\\": [\\n {\\n \\"Count\\": 4,\\n \\"Status\\": \\"Agree\\"\\n }\\n ],\\n \\"BatchQuotaApplicationId\\": \\"d314d6ae-867d-484c-9009-3d421a80****\\",\\n \\"DesireValue\\": 105,\\n \\"Dimensions\\": {\\n \\"regionId\\": \\"cn-hangzhou\\"\\n },\\n \\"EffectiveTime\\": \\"2023-05-22T16:00:00Z\\",\\n \\"ExpireTime\\": \\"2024-05-14T02:08:56Z\\",\\n \\"ProductCode\\": \\"vpc\\",\\n \\"QuotaActionCode\\": \\"q_fhoz4k\\",\\n \\"QuotaCategory\\": \\"CommonQuota\\",\\n \\"Reason\\": \\"Business expansion\\"\\n }\\n ],\\n \\"RequestId\\": \\"D47B3A10-CDAC-5412-B2EE-EC9A3DBE9053\\",\\n \\"TotalCount\\": 67\\n}","type":"json"}]',
- 'title' => '查询配额模板批量配额申请历史',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'quotas.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'quotas.aliyuncs.com',
],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'quotas.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'TemplateQuota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ['validationType' => 'always', 'resourceType' => 'QuotaAlarm', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/*'],
+ ['validationType' => 'always', 'resourceType' => 'Quota', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
+ ['validationType' => 'always', 'resourceType' => 'QuotaApplication', 'arn' => 'acs:quotas:{#regionId}:{#accountId}:quota/{#ProductCode}/{#QuotaActionCode}'],
],
],
];