调用CreateStorageAnalysisTask接口,创建空间分析任务,获取数据库及表的空间使用数据。
接口说明
- 本接口仅适用于 RDS MySQL、PolarDB MySQL 版和 MongoDB 实例。
- 对于 RDS MySQL 和 PolarDB MySQL 版实例,本接口对应于旧版空间分析功能,该接口生成的任务无法在 DAS 控制台新版空间分析页面查看。如有需要查看任务及结果,请调用接口获取数据后自行保存。
- 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
- 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
hdm:CreateStorageAnalysisTask | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | rm-2ze1jdv45i7l6**** |
NodeId | string | 否 | 节点 ID。 对于 MongoDB 实例,通过该参数指定节点进行空间分析。调用 DescribeRoleZoneInfo 接口,可以查询 MongoDB 实例各个节点的详细信息。
注意 对于 MongoDB 副本集实例,不传入此参数时,调用该接口会默认分析唯一的 Hidden 节点。对于 MongoDB 分片集群实例,推荐传入此参数,指定目标节点。 | d-bp1872fa24d5**** |
DbName | string | 否 | 数据库名。传入该参数时,分析指定数据库的空间使用情况。 | testdb01 |
TableName | string | 否 | 表名。传入该参数时,分析指定数据库中指定表的空间使用情况。传入该参数时,必须同时传入 DbName,指定该表所属的数据库。 | test_table |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "Successful",
"Data": {
"TaskId": "910f83f4b96df0524ddc5749f61539f8",
"CreateTaskSuccess": false,
"ErrorMessage": "unknown error"
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。