AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 SelectDB 版 开发参考 API参考 API目录 实例管理 DescribeDBInstanceAttribute - 查询实例详情

DescribeDBInstanceAttribute - 查询实例详情

更新时间：
产品详情
我的收藏

查询实例详情。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

selectdb:DescribeDBInstanceAttribute

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
DBInstanceId

string

是

实例 ID。

selectdb-cn-7213cjv****
RegionId

string

是

地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

06758CAB-1204-5852-A471-29C87D5C1D0F
Status

string

实例的状态，取值说明：

  • CREATING：创建中。

  • ACTIVE：运行中。

  • RESOURCE_CHANGING：变配中。

  • ORDER_PREPARING：订单确认中。

  • READONLY_RESOURCE_CHANGING：资源变配中（实例写入锁定）。

  • DELETING：删除中。

ACTIVE
SubDomain

string

可用区。

cn-beijing-h-aliyun
GmtModified

string

实例修改时间（例如重启，申请公网等操作）。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。

2023-08-17T09:58Z
LockMode

integer

实例锁定模式，取值为 lock，实例自动过期或欠费。

lock
LockReason

string

实例锁定原因。

nolock
ResourceCpu

integer

资源 CPU 数量。

8
StorageSize

integer

存储空间大小。

400
ObjectStoreSize

integer

存储空间。

0
MaintainStarttime

string

实例可维护时间段的开始时间。

预留参数，暂不返回
MaintainEndtime

string

实例可维护时间段的结束时间。

预留参数，暂不返回

DBClusterList

array<object>

实例所属集群列表信息。

object

集群列表。

DbInstanceName

string

实例名称。

实例测试
DbClusterId

string

集群 ID。

selectdb-cn-h033cjs****-be
DbClusterName

string

集群名称。

test01
Status

string

集群的状态，取值说明：

  • CREATING：创建中。

  • ACTIVATION：运行中。

  • RESOURCE_CHANGING：变配中。

  • ORDER_PREPARING：订单确认中。

  • READONLY_RESOURCE_CHANGING：资源变配中（实例写入锁定）。

  • DELETING：删除中。

ACTIVATION
CreatedTime

string

集群的创建时间。

2023-08-14T09:24:13Z
DbClusterClass

string

集群规格，取值说明：

  • selectdb.xlarge：4 核 16GB。

  • selectdb.2xlarge： 8 核 32GB。

  • selectdb.4xlarge：16 核 64GB。

  • selectdb.8xlarge：32 核 128GB。

  • selectdb.16xlarge：64 核 256GB。

  • selectdb.24xlarge：96 核 384GB。

  • selectdb.32xlarge：128 核 512GB。

selectdb.2xlarge
CpuCores

integer

CPU 核数。

8
Memory

integer

内存大小。

64
CacheStorageType

string

缓存空间类型。

cloud_essd
PerformanceLevel

string

性能级别。

PL1
CacheStorageSizeGB

string

缓存空间，单位：GB。

200
StartTime

string

集群启动时间。

2023-08-14T09:24:13Z
ChargeType

string

集群的付费类型。取值：

  • Postpaid：后付费（按量付费）

  • Prepaid：预付费（包年包月）

Prepaid
ModifiedTime

string

修改时间。

2024-07-02T16:35:44+08:00
ScalingRulesEnable

boolean

是否开启分时弹性策略。

false
ZoneId

string

可用区 ID。

cn-hangzhou-k
VSwitchId

string

交换机 ID。

vsw-t4n8x7jcc8rknon85tqoa
SubDomain

string

子域。

预留参数，暂不返回。
ClusterBinding

string

绑定的目标集群。

selectdb-cn-7213cjv****-be
ClusterNodeType

string

ClusterNodeCount

integer

ScaleMax

number

ScaleMin

number

Engine

string

数据库类型。

selectdb
EngineVersion

string

数据库版本。

2.4
EngineMinorVersion

string

实例的内核小版本号。

3.0.1
DBInstanceId

string

实例 ID。

selectdb-cn-7213cjv****
Description

string

实例备注信息。

test
CreateTime

string

创建时间。

2023-08-14T03:00:42Z
CanUpgradeVersions

array

信息列表。

string

信息列表。

test
ChargeType

string

实例的付费类型。取值：

  • Postpaid：后付费（按量付费）

  • Prepaid：预付费（包年包月）

Prepaid
ExpireTime

string

实例到期时间。

2023-09-17T00:00Z
ResourceGroupId

string

实例所属的资源组 ID。

rg-aekzbck4asz3dsa
Tags

array<object>

实例标签列表信息。

object

实例标签列表。

TagKey

string

标签键。

testKey
TagValue

string

标签值。

testValue
RegionId

string

地域 ID。

cn-beijing
ZoneId

string

实例可用区 ID

cn-beijing-h
VpcId

string

实例 VPC ID。

vpc-bp175iuvg8nxqraf2****
VSwitchId

string

交换机 ID。

vsw-bp18iztwqrs8qj2nc6nyu
DeployScheme

string

实例部署模式

multi_az
MultiZone

array<object>

多可用区配置。

说明

  • 当 DeployScheme 为 multi_az 时，该参数有效。

object

多可用区列表。

ZoneId

string

可用区 ID。

cn-hangzhou-k
VSwitchIds

array

交换机 ID 列表。

string

交换机 ID。

vsw-bp10dbralpn4bzmgkkh8f
Cidr

string

前缀列表条目的 CIDR 地址块信息。

113.88.14.211/32
AvailableIpCount

integer

可用区下可用 IP。

4096
Serverless

boolean

示例

正常返回示例

JSON格式

{
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F",
  "Status": "ACTIVE",
  "SubDomain": "cn-beijing-h-aliyun",
  "GmtModified": "2023-08-17T09:58Z",
  "LockMode": 0,
  "LockReason": "nolock",
  "ResourceCpu": 8,
  "StorageSize": 400,
  "ObjectStoreSize": 0,
  "MaintainStarttime": "预留参数，暂不返回",
  "MaintainEndtime": "预留参数，暂不返回\n",
  "DBClusterList": [
    {
      "DbInstanceName": "实例测试",
      "DbClusterId": "selectdb-cn-h033cjs****-be",
      "DbClusterName": "test01",
      "Status": "ACTIVATION",
      "CreatedTime": "2023-08-14T09:24:13Z",
      "DbClusterClass": "selectdb.2xlarge",
      "CpuCores": 8,
      "Memory": 64,
      "CacheStorageType": "cloud_essd",
      "PerformanceLevel": "PL1",
      "CacheStorageSizeGB": "200",
      "StartTime": "2023-08-14T09:24:13Z",
      "ChargeType": "Prepaid",
      "ModifiedTime": "2024-07-02T16:35:44+08:00",
      "ScalingRulesEnable": false,
      "ZoneId": "cn-hangzhou-k",
      "VSwitchId": "vsw-t4n8x7jcc8rknon85tqoa",
      "SubDomain": "预留参数，暂不返回。",
      "ClusterBinding": "selectdb-cn-7213cjv****-be",
      "ClusterNodeType": "",
      "ClusterNodeCount": 0,
      "ScaleMax": 0,
      "ScaleMin": 0
    }
  ],
  "Engine": "selectdb",
  "EngineVersion": "2.4",
  "EngineMinorVersion": "3.0.1",
  "DBInstanceId": "selectdb-cn-7213cjv****",
  "Description": "test",
  "CreateTime": "2023-08-14T03:00:42Z",
  "CanUpgradeVersions": [
    "test"
  ],
  "ChargeType": "Prepaid",
  "ExpireTime": "2023-09-17T00:00Z",
  "ResourceGroupId": "rg-aekzbck4asz3dsa",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ],
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-h",
  "VpcId": "vpc-bp175iuvg8nxqraf2****",
  "VSwitchId": "vsw-bp18iztwqrs8qj2nc6nyu",
  "DeployScheme": "multi_az",
  "MultiZone": [
    {
      "ZoneId": "cn-hangzhou-k",
      "VSwitchIds": [
        "vsw-bp10dbralpn4bzmgkkh8f"
      ],
      "Cidr": "113.88.14.211/32",
      "AvailableIpCount": 4096
    }
  ],
  "Serverless": true
}

错误码

HTTP status code

错误码

错误信息

描述
400 DocumentConvertFailed.ExceedFileSizeLimit The conversion has been failed, exceed file size limit. 文档转换失败，文件大小超过系统限额。
400 Forbidden User not authorized to operate on the specified resource, or this API does not support RAM. 子账号权限不足，请先获取授权。
400 InvalidDBName The specified database name is not allowed. 数据库名称不符合要求，请确认数据名称是否正确。
400 CreateOrderFailed Failed to create order. 创建订单失败。
403 DBClusterNotSupported The requested operation can not be performed while the cluster is not sale. 当集群未运行时，无法执行请求的操作。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 当前实例状态不支持此操作。
403 InstanceEngineType.NotSupport The instance engine and type does not support operations. 操作失败，实例引擎和类型不支持该操作。
403 InvalidDBInstanceState.NotSupport The specified instance state does't support this operation. 指定的实例状态不支持此操作。
403 MoneyLessThan100 The Account Monet less Than 100. 当前阿里云账号余额不足100，请充值。
403 OperationDenied.DBNameAndAccountPrivilegeCount The operation is not permitted due to count of database or account privilege. 操作失败，数据库与权限的数量不一致。
403 InsufficientResourceCapacity The resource is out of usage. 资源不足，请您稍后再试。
404 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records. SelectDB实例不存在。
404 InvalidClusterInstance.NotFound Specified cluster instance does not exist. SelectDB实例不存在。
404 DBInstanceLocked The current instance lock mode does not support this operation. 操作失败，当前实例已锁定。
404 IncorrectVswitchId The specified parameter VSwitchId is not valid. 交换机参数无效。
404 InvalidApi.NotFound Specified api is not found, please check your url and method.
404 InvalidDBInstance.NotFound The specified instance is not found. 没有找到指定的实例，请检查实例的正确性。
404 InvalidDBInstanceClass.NotFound The specified instance classic does not exist. 当前选择的配置或规格不存在或已停售，请重新选择。
404 InvalidRegionId.NotFound The provided RegionId does not exist in our records. 操作失败，输入的地域及可用区不存在。
404 QueryPrice.Failed The inquiry failed. Contact Alibaba Cloud customer service representatives. 询价失败，请联系客服同学。

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

变更历史

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

上一篇：DescribeDBInstances - 查询实例下一篇：ResetAccountPassword - 重置账号密码