调用GetDasProServiceUsage接口,查询数据库实例DAS企业版 V1或企业版 V2存储空间的使用情况。
接口说明
当前支持的数据库请参见 DAS 企业版使用说明。
使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
该接口仅适用于 DAS 企业版 V1、V2。
推荐使用 DescribeSqlLogStatistic 接口,查询 DAS 企业版的数据统计信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hdm:GetDasProServiceUsage |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UserId |
string |
否 |
用户 ID,即创建数据库实例的阿里云主账号 ID。 说明
非必填,输入目标数据库实例 ID 后,在调用 API 接口时,系统会自动获取用户 ID。 |
196278346919**** |
| InstanceId |
string |
是 |
数据库实例 ID。 |
rm-2ze8g2am97624**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
| RequestId |
string |
请求 ID。 |
7172BECE-588A-5961-8126-C216E16B**** |
| Data |
object |
返回数据。 |
{ "storageFreeQuotaInMB": 5120, "ip": "rm-2ze8g2am97624****.mysql.****.com", "custinsId": 12448331, "userId": "196278346919****", "uuid": "hdm_b0ae36343407609bf3e8df8709d8****", "expireTime": 1924963200000, "instanceId": "rm-2ze8g2am97624****", "storageUsed": 10773752667393, "engine": "MySQL", "instanceAlias": "TESTDB01_PROD", "port": 3310, "vpcId": "hdm_****", "commodityInstanceId": "daspro-****", "startTime": 1606381940000, "isSpare": false, "region": "cn-shanghai", "serviceUnitId": "5", "sqlRetention": 30 } |
| storageFreeQuotaInMB |
number |
赠送的 SQL 洞察数据存储空间,单位为 MB。 |
5120 |
| ip |
string |
数据库实例的地址。 |
rm-2ze8g2am97624****.mysql.****.com |
| userId |
string |
用户 ID,即创建数据库实例的阿里云主账号 ID。 |
196278346919**** |
| expireTime |
integer |
数据库实例企业版到期时间,格式为 Unix 时间戳,单位为毫秒。 |
1648742400000 |
| instanceId |
string |
数据库实例 ID。 |
rm-2ze8g2am97624**** |
| storageUsed |
integer |
数据库实例已使用的 SQL 洞察数据存储空间,单位为 Byte。 |
35903498 |
| engine |
string |
数据库引擎。 |
MySQL |
| instanceAlias |
string |
数据库实例名称。 |
TESTDB01 |
| port |
integer |
端口号。 |
3306 |
| vpcId |
string |
VPC ID。 |
vpc-2zentqj1sk4qmolci**** |
| commodityInstanceId |
string |
DAS 企业版 ID。 |
daspro-cn-v0h1l6i**** |
| startTime |
integer |
开启企业版的时间,格式为 Unix 时间戳,单位为毫秒。 |
1646100892000 |
| isSpare |
boolean |
数据库实例的企业版是否过期:
|
false |
| region |
string |
数据库实例所属的地域。 |
cn-shanghai |
| serviceUnitId |
string |
服务单元 ID。 |
4 |
| sqlRetention |
string |
SQL 洞察数据存储时长,单位为天。 |
180 |
| migrationPredictRemainingTime |
integer |
旧版 SQL 洞察和审计迁移到新版的预计剩余时间,单位为毫秒。 重要 仅当进行旧版 SQL 洞察和审计迁移到新版操作时,返回此参数。
|
60000 |
| Code |
integer |
返回的状态码。 |
200 |
| Success |
boolean |
请求是否执行成功:
|
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
| 403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。