PauseInstance - 暂停实例

暂停AnalyticDB PostgreSQL版实例。

接口说明

  • 实例付费类型需为按量付费类型。
  • 仅支持 Serverless 手动调度模式和存储弹性模式实例
  • 仅支持暂停运行状态为运行中的 AnalyticDB PostgreSQL 版实例。
说明 请确保在使用该接口前,已充分了解 AnalyticDB PostgreSQL 版产品的收费方式价格

调试

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

授权信息

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

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

请求参数

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

实例 ID。

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

返回参数

名称类型描述示例值
object

返回参数列表。

RequestIdstring

请求 ID。

34b32a0a-08ef-4a87-b6be-cdd9********
Statusboolean

API 执行状态,取值如下:

  • false:执行失败。
  • true:执行成功。
true
ErrorMessagestring

错误信息。

只会在 Status 参数返回值为 false 时返回该参数。

*******
DBInstanceIdstring

实例 ID。

gp-bp12ga6v69h86****

示例

正常返回示例

JSON格式

{
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd9********",
  "Status": true,
  "ErrorMessage": "*******",
  "DBInstanceId": "gp-bp12ga6v69h86****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史