API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(quotas/2020-05-10)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

产品配额

API

标题

API概述

GetProductQuota 查询目标云产品的配额详情 查询目标云产品的配额详情。
GetProductQuotaDimension 查询目标云产品支持的配额维度详情 查询目标云产品支持的配额维度详情。
ListProductDimensionGroups 查询云产品的维度组 查询目标云产品的维度组。
ListProductQuotaDimensions 查询云产品支持的配额维度 查询目标云产品支持的配额维度。
ListProductQuotas 查询目标云产品的配额列表 查询目标云产品的配额列表。
ListDependentQuotas 查询目标配额依赖的配额列表 部分配额之间存在关联,关联配额最好同时提升,该接口返回某个配额关联的配额项列表。

配额告警

API

标题

API概述

CreateQuotaAlarm 创建配额用量告警 创建配额告警。
DeleteQuotaAlarm 删除配额用量告警 删除配额用量告警。
UpdateQuotaAlarm 修改配额用量告警信息 修改配额告警信息。
ListQuotaAlarms 查询配额用量告警列表 查询配额用量告警列表。
GetQuotaAlarm 查询配额用量告警详情 查询目标配额告警详情。
ListAlarmHistories 查询配额用量告警历史记录 查询配额告警历史记录。

配额提升申请

API

标题

API概述

CreateQuotaApplication 创建配额提升申请 创建配额提升申请。
GetQuotaApplication 查询配额提升申请详情 查询配额提升申请详情。
ListQuotaApplications 查询配额提升申请列表 查询配额提升申请列表。
GetQuotaApplicationApproval 查询配额申请单审批信息 查询配额申请单审批信息。其中包含:平均审批时间、是否支持审批提醒和审批提醒间隔时间等。
RemindQuotaApplicationApproval 查询支持审批提醒的配额申请单 查询支持审批提醒的配额申请单。

配额模板

API

标题

API概述

GetQuotaTemplateServiceStatus 查询配额模板状态 查询配额模板的状态。
ModifyQuotaTemplateServiceStatus 修改配额模板状态 配额模板的默认状态为未设置。当资源目录的管理账号初次使用配额模板时,需要开启配额模板。只有资源目录的管理员账号可修改配额模版。
CreateTemplateQuotaItem 创建配额模板 管理账号创建配额模板后,如果资源目录新增成员,则配额模板自动为新增的成员提交配额提升申请,已有成员无变化。通过配额模板,您一次可以申请提升多个配额项,提升整个组织的配额管理效率和自动化水平。只有资源目录的管理员账号可创建配额模版。
ModifyTemplateQuotaItem 修改配额模板 管理账号修改配额模板后,修改结果仅对资源目录中管理账号新增的成员生效,已有成员无变化。只有资源目录的管理员账号可修改配额模版。
ListQuotaApplicationTemplates ListQuotaApplicationTemplates Queries quota templates by using the management account of a resource directory.
DeleteTemplateQuotaItem 删除配额模板 管理账号删除配额模板后,如果资源目录新增成员,则配额模板不再自动为新增的成员提交配额提升申请。只有资源目录的管理员账号可删除配额模版。
CreateQuotaApplicationsForTemplate 通过配额模板批量申请成员配额 当您将配额项加入配额模板时,仅资源目录中新增的成员会自动提交配额提升申请,已有成员无变化。如果您需要通过配额模板为已有成员提升配额,则可以批量选择配额模板为资源目录中的多个成员提交配额提升申请。只有资源目录的管理员账号可批量创建配额申请。
ListQuotaApplicationsDetailForTemplate 查询配额模板批量配额申请详情 查询资源目录中成员配额提升申请详情。
ListQuotaApplicationsForTemplate 查询配额模板批量配额申请历史 查询配额模板批量申请成员配额的申请历史。

其他

API

标题

API概述

GetQuotaUtilizationOverview 获取配额使用率概览 获取配额使用率概览
ListProducts 查询配额中心支持的云产品列表 查询配额中心支持的云产品列表。
ListQuotaUtilizationReport 列举配额使用率报告 列举配额使用率报告
StartQuotaUtilizationReport 启动配额使用率报告刷新 发起配额使用率报告查询,本api只对通用配额生效