查询指定站点与业务类型的实时日志投递剩余配额。
接口说明
使用此接口可以查询指定阿里云用户下,特定站点与业务类型的实时日志投递服务剩余配额数量。这对于监控与管理您的日志投递容量至关重要,确保日志能够顺利推送至目标存储端,避免因配额不足导致的数据丢失或延迟。
参数注意事项:
BusinessType
是必填项,需指定业务类型以获取相应的配额信息。SiteId
需要是有效的站点 ID,且格式应为整数,确保与您在阿里云上配置的站点相对应。
响应内容:
- 接口成功响应将返回投递配额数量(
FreeQuota
),以及请求标识(RequestId
),站点 ID(SiteId
)和业务类型(BusinessType
)作为确认和记录使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
esa:GetSiteLogDeliveryQuota | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BusinessType | string | 是 | 实时日志类型,取值:
| dcdn_log_access_l1 |
SiteId | long | 是 | 站点 ID,可通过调用 ListSites 接口获取。 | 123456**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4C14840EF0EAAB6D97CDE0C5F6554ACE",
"FreeQuota": 3,
"BusinessType": "dcdn_log_access_l1",
"SiteId": 0
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
400 | InternalError | An internal exception occurred, please try again later. | 触发内部异常,请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 错误码发生变更 | 查看变更详情 |