文档

SetDBInstancePlanStatus - 启用或禁用计划

更新时间:

启用或禁用AnalyticDB PostgreSQL版实例的计划。

调试

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

授权信息

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

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

请求参数

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

计划 ID。

说明 您可以调用 DescribeDBInstancePlans 接口查看计划的详细信息,包括计划 ID。
1234
PlanStatusstring

设置计划的状态,取值如下:

  • disable:禁用计划。
  • enable:启用计划。
disable
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****

返回参数

名称类型描述示例值
object
Statusstring

API 执行状态。

执行成功则返回 success;执行失败则不返回该参数。

success
ErrorMessagestring

错误信息。

只会在 API 执行失败时返回该参数。

****
PlanIdstring

计划 ID。

1234
RequestIdstring

请求 ID。

34b32a0a-08ef-4a87-b6be-cdd988888888

示例

正常返回示例

JSON格式

{
  "Status": "success",
  "ErrorMessage": "****",
  "PlanId": "1234",
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd988888888"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-25新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈