全部产品
Search

搜索本产品

    数据库自治服务 DAS：UpdateAutoResourceOptimizeRulesAsync - 设置空间碎片自动回收功能的配置参数

    文档中心

    数据库自治服务 DAS：UpdateAutoResourceOptimizeRulesAsync - 设置空间碎片自动回收功能的配置参数

    更新时间：Dec 23, 2024

    调用UpdateAutoResourceOptimizeRulesAsync接口，采用异步方式，批量设置指定数据库实例空间碎片自动回收功能的配置参数。

    接口说明

    说明 异步调用后不会立即返回完整结果，首先需要调用该接口获取 ResultId，然后使用返回数据的 ResultId，重新发起调用，直到 isFinish 取值为 true 时，返回完整结果。即获取一次完整数据，至少需要调用该接口两次。

    使用该接口需满足以下前提条件：

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

    • 数据库实例类型为 RDS MySQL 高可用系列。

    • 数据库实例已开启 DAS 企业版，您可以调用 DescribeInstanceDasPro 查询。

    • 数据库实例的 CPU 规格不小于 4 核，且innodb_file_per_table参数值为 ON。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ConsoleContextstring否

    备用参数。

    		None
    InstanceIdsstring是

    数据库实例 ID。

    说明 数据格式为 JSONArray，例如['实例 ID1','实例 ID2']，实例 ID 间用英文逗号（,）分隔。
    		['rm-2ze8g2am97624****','rm-2ze9xrhze0709****']
    TableSpaceSizedouble是

    触发空间碎片自动回收单个物理表的最小空间，取值范围：5~100，单位为 GB。

    		10
    TableFragmentationRatiodouble是

    触发空间碎片自动回收单个物理表的碎片率，取值范围：0.10~0.99。

    		0.2
    ResultIdstring否

    异步请求的 ID。

    说明 异步调用后不会立即返回完整结果，首先需要调用该接口获取 ResultId，然后使用返回数据的 ResultId，重新发起调用，直到 isFinish 取值为 true 时，返回完整结果。即获取一次完整数据，至少需要调用该接口两次。
    		async__507044db6c4eadfa2dab9b084e80****

    返回参数

    名称类型描述示例值
    object
    Codelong

    返回的状态码。

    		200
    Messagestring

    请求返回消息。

    说明 请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。
    		Successful
    Dataobject

    返回的数据。

    Failboolean

    请求是否失败：

    • true：是。

    • false：否。

    		false
    ConfigResponseobject

    批量设置的返回数据。

    说明 异步请求完成时（即 isFinish 取值为 true 时）才会返回该数据。
    TotalInstanceCountlong

    总数据库实例数量。

    		2
    ConfigSuccessInstanceCountlong

    设置成功的数据库实例数量。

    		1
    ConfigFailInstanceCountlong

    设置失败的数据库实例数量。

    		1
    ConfigSuccessInstanceListarray<object>

    设置成功的数据库实例列表。

    configSuccessInstanceListobject
    ConfigSuccessboolean

    设置是否成功：

    • true：是。

    • false：否。

    		true
    InstanceIdstring

    数据库实例 ID。

    		rm-2ze8g2am97624****
    ConfigFailInstanceListarray<object>

    设置失败的数据库实例列表。

    configFailInstanceListobject
    ConfigSuccessboolean

    设置是否成功：

    • true：是。

    • false：否。

    		false
    InstanceIdstring

    数据库实例 ID。

    		rm-2ze9xrhze0709****
    ErrorMessagestring

    错误信息。

    		Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON
    ResultIdstring

    异步请求的 ID。

    		async__20ee808e72257f16a4fe024057ca****
    IsFinishboolean

    异步请求是否执行完成：

    • true：是。

    • false：否。

    		true
    Statestring

    异步请求的执行状态：

    • RUNNING：正在运行。

    • SUCCESS：成功。

    • FAIL：失败。

    		SUCCESS
    Completeboolean

    异步请求是否执行完成：

    • true：是。

    • false：否。

    		true
    Timestamplong

    执行时间，格式为 Unix 时间戳，单位为毫秒。

    		1645668213000
    RequestIdstring

    请求 ID。

    		9CB97BC4-6479-55D0-B9D0-EA925AFE****
    Successboolean

    请求是否执行成功：

    • true：执行成功。

    • false：执行失败。

    		true

    示例

    正常返回示例

    JSON格式

    {
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Fail": false,
    "ConfigResponse": {
      "TotalInstanceCount": 2,
      "ConfigSuccessInstanceCount": 1,
      "ConfigFailInstanceCount": 1,
      "ConfigSuccessInstanceList": [
        {
          "ConfigSuccess": true,
          "InstanceId": "rm-2ze8g2am97624****"
        }
      ],
      "ConfigFailInstanceList": [
        {
          "ConfigSuccess": false,
          "InstanceId": "rm-2ze9xrhze0709****",
          "ErrorMessage": "Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON"
        }
      ]
    },
    "ResultId": "async__20ee808e72257f16a4fe024057ca****",
    "IsFinish": true,
    "State": "SUCCESS",
    "Complete": true,
    "Timestamp": 1645668213000
  },
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "Success": true
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-11-17OpenAPI 错误码发生变更查看变更详情