ModifyDasOpsConfig - 开启/关闭DAS运维服务

更新时间:
复制 MD 格式

修改运维服务配置项

接口说明

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

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

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

  • 使用该接口默认开启当前支持的最新版本。DAS 企业版各个版本支持的数据库和地域请参见 DAS 产品系列及支持的功能。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:ModifyDasOpsConfig

update

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

数据库实例 ID。

dds-uf6079bda570****

Enable

boolean

否

是否开启 DAS 运维服务:

  • true:是。

  • false:否,注意,关闭只会关闭功能,但是不会退订,如需退订请前往退订管理。

true

Filters

array<object>

否

预留参数。

object

否

预留参数。

Value

string

否

预留参数。

select

Key

string

否

过滤参数。

说明

支持的过滤参数及其取值请参考请求参数补充说明。

None

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回消息。

Successful

RequestId

string

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****

Success

string

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

Data

object

SqlLogConfig

CommodityInstanceId

string

运维服务实例 ID

pc-2zelo5v5u0678jx04

EndTime

integer

结束时间,格式为 Unix 时间戳,单位为毫秒。

1608888296000

StartTime

integer

运维服务开始时间,格式为 Unix 时间戳,单位为毫秒。

1672531200000

OrderId

integer

订单 ID。

285412912420536

ChargeType

string

支付类型

prepay

Enable

boolean

是否开启运维服务功能(包含经济版)

true

OpsEnable

boolean

是否开启运维服务

EcoEnable

boolean

是否开启经济版

true

Status

string

任务状态。

  • INIT:待调度。

  • RUNNING:运行中。

  • FAILED:失败。

  • CANCELED:已取消。

  • COMPLETED:完成。

说明

当任务处于 COMPLETED 时,可以查看任务的结果。

COMPLETED

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "CommodityInstanceId": "pc-2zelo5v5u0678jx04",
    "EndTime": 1608888296000,
    "StartTime": 1672531200000,
    "OrderId": 285412912420536,
    "ChargeType": "prepay",
    "Enable": true,
    "OpsEnable": true,
    "EcoEnable": true,
    "Status": "COMPLETED"
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
403 NoPermission You are not authorized to do this action. 没有权限执行该操作

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

变更历史

更多信息,参考变更详情。