文档

GetDasProServiceUsage - 查询SQL洞察存储空间使用情况

更新时间:

调用GetDasProServiceUsage接口,查询数据库实例SQL洞察存储空间的使用情况。

接口说明

  • 当前支持的数据库请参见 DAS 企业版使用说明

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetDasProServiceUsageRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

说明 非必填,输入目标数据库实例 ID 后,在调用 API 接口时,系统会自动获取用户 ID。
196278346919****
InstanceIdstring

数据库实例 ID。

rm-2ze8g2am97624****

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

7172BECE-588A-5961-8126-C216E16B****
Dataobject

返回数据。

storageFreeQuotaInMBdouble

赠送的 SQL 洞察数据存储空间,单位为 MB。

5120
ipstring

数据库实例的地址。

rm-2ze8g2am97624****.mysql.****.com
userIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

196278346919****
expireTimelong

数据库实例企业版到期时间,格式为 Unix 时间戳,单位为毫秒。

1648742400000
instanceIdstring

数据库实例 ID。

rm-2ze8g2am97624****
storageUsedlong

数据库实例已使用的 SQL 洞察数据存储空间,单位为 Byte。

35903498
enginestring

数据库引擎。

MySQL
instanceAliasstring

数据库实例名称。

TESTDB01
portinteger

端口号。

3306
vpcIdstring

VPC ID。

vpc-2zentqj1sk4qmolci****
commodityInstanceIdstring

DAS 企业版 ID。

daspro-cn-v0h1l6i****
startTimelong

开启企业版的时间,格式为 Unix 时间戳,单位为毫秒。

1646100892000
isSpareboolean

数据库实例的企业版是否过期:

  • true:过期。
  • false:未过期。
false
regionstring

数据库实例所属的地域。

cn-shanghai
serviceUnitIdstring

服务单元 ID。

4
sqlRetentionstring

SQL 洞察数据存储时长,单位为天。

180
migrationPredictRemainingTimelong

旧版 SQL 洞察和审计迁移到新版的预计剩余时间,单位为毫秒。

注意 仅当进行旧版 SQL 洞察和审计迁移到新版操作时,返回此参数。

60000
Codelong

返回的状态码。

200
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "Data": {
    "storageFreeQuotaInMB": 5120,
    "ip": "rm-2ze8g2am97624****.mysql.****.com",
    "userId": "196278346919****",
    "expireTime": 1648742400000,
    "instanceId": "rm-2ze8g2am97624****",
    "storageUsed": 35903498,
    "engine": "MySQL",
    "instanceAlias": "TESTDB01",
    "port": 3306,
    "vpcId": "vpc-2zentqj1sk4qmolci****",
    "commodityInstanceId": "daspro-cn-v0h1l6i****",
    "startTime": 1646100892000,
    "isSpare": false,
    "region": "cn-shanghai",
    "serviceUnitId": "4",
    "sqlRetention": "180",
    "migrationPredictRemainingTime": 60000
  },
  "Code": 200,
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈