首页 数据库自治服务 DAS API参考指南 API目录 专业版管理 GetDasProServiceUsage - 查询SQL洞察存储空间使用情况

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

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

接口说明

  • 当前支持的数据库请参见DAS专业版使用说明
  • 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。

调试

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

调试

授权信息

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

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

请求参数

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

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

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

数据库实例ID。

rm-2ze8g2am97624****

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

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

请求ID。

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

返回数据。

object
storageFreeQuotaInMBnumber

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

5120
ipstring

数据库实例的地址。

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

内部标识ID。

57369374
userIdstring

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

196278346919****
uuidstring

数据库实例的唯一标识符号。

hdm_b0ae36343407609bf3e8df8709d8****
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
Codelong

返回的状态码。

200
Successboolean

请求是否执行成功:

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

示例

正常返回示例

JSON格式

{
    "Message": "Successful",
    "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
    "Data": [
        {
            "storageFreeQuotaInMB": 5120,
            "ip": "rm-2ze8g2am97624****.mysql.****.com",
            "custinsId": 57369374,
            "userId": "196278346919****",
            "uuid": "hdm_b0ae36343407609bf3e8df8709d8****",
            "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"
        }
    ],
    "Code": 200,
    "Success": true
}

XML格式

<GetDasProServiceUsageResponse>
    <Message>Successful</Message>
    <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>
    <Data>
        <storageFreeQuotaInMB>5120</storageFreeQuotaInMB>
        <ip>rm-2ze8g2am97624****.mysql.****.com</ip>
        <custinsId>57369374</custinsId>
        <userId>196278346919****</userId>
        <uuid>hdm_b0ae36343407609bf3e8df8709d8****</uuid>
        <expireTime>1648742400000</expireTime>
        <instanceId>rm-2ze8g2am97624****</instanceId>
        <storageUsed>35903498</storageUsed>
        <engine>MySQL</engine>
        <instanceAlias>TESTDB01</instanceAlias>
        <port>3306</port>
        <vpcId>vpc-2zentqj1sk4qmolci****</vpcId>
        <commodityInstanceId>daspro-cn-v0h1l6i****</commodityInstanceId>
        <startTime>1646100892000</startTime>
        <isSpare>false</isSpare>
        <region>cn-shanghai</region>
        <serviceUnitId>4</serviceUnitId>
        <sqlRetention>180</sqlRetention>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</GetDasProServiceUsageResponse>

错误码

Http code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误

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

阿里云首页 数据库自治服务 DAS 相关技术圈