文档

DescribeDBInstanceAttribute - 查询实例详情

更新时间:
一键部署

查询指定云数据库SelectDB版实例的详细信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

selectdb-cn-7213cjv****
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

实例的状态,取值说明:

  • CREATING:创建中。

  • ACTIVATION:运行中。

  • RESOURCE_CHANGING:变配中。

  • ORDER_PREPARING:订单确认中。

  • READONLY_RESOURCE_CHANGING:资源变配中(实例写入锁定)。

  • DELETING:删除中。

ACTIVATION
SubDomainstring

可用区。

cn-beijing-h-aliyun
GmtModifiedstring

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

2023-08-17T09:58Z
LockModelong

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

lock
LockReasonstring

实例锁定原因。

nolock
ResourceCpulong

资源 CPU 数量。

8
StorageSizelong

存储空间大小。

400
ObjectStoreSizelong

存储空间。

0
MaintainStarttimestring

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

预留参数,暂不返回
MaintainEndtimestring

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

预留参数,暂不返回
DBClusterListobject []

实例列表信息。

DbInstanceNamestring

实例名称。

实例测试
DbClusterIdstring

集群 ID。

selectdb-cn-h033cjs****-be
DbClusterNamestring

集群名称。

test01
Statusstring

实例的状态,取值说明:

  • CREATING:创建中。

  • ACTIVATION:运行中。

  • RESOURCE_CHANGING:变配中。

  • ORDER_PREPARING:订单确认中。

  • READONLY_RESOURCE_CHANGING:资源变配中(实例写入锁定)。

  • DELETING:删除中。

ACTIVATION
CreatedTimestring

实例的创建时间。

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

集群规格,取值说明:

  • selectdb.xlarge:4 核 32GB。
  • selectdb.2xlarge: 8 核 64GB。
  • selectdb.4xlarge:16 核 128GB。
  • selectdb.8xlarge:32 核 256GB。
  • selectdb.16xlarge:64 核 512GB。
  • selectdb.24xlarge:96 核 768GB。
  • selectdb.32xlarge:128 核 1024GB。
selectdb.2xlarge
CpuCoreslong

CPU 核数。

8
Memorylong

内存大小。

64
CacheStorageTypestring

缓存空间类型。

cloud_essd
PerformanceLevelstring

性能级别。

PL1
CacheStorageSizeGBstring

缓存空间,单位:GB。

200
StartTimestring

开始时间。

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

实例的付费类型。取值:

  • Postpaid:后付费(按量付费)

  • Prepaid:预付费(包年包月)

Prepaid
Enginestring

数据库类型。

selectdb
EngineVersionstring

数据库版本。

2.4
EngineMinorVersionstring

实例的内核小版本号。

3.0.1
DBInstanceIdstring

实例 ID。

selectdb-cn-7213cjv****
Descriptionstring

实例备注信息。

test
CreateTimestring

创建时间。

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

信息列表。

string

信息列表。

test
ChargeTypestring

实例的付费类型。取值:

  • Postpaid:后付费(按量付费)

  • Prepaid:预付费(包年包月)

Prepaid
ExpireTimestring

实例到期时间。

2023-09-17T00:00Z
ResourceGroupIdstring

实例所属的资源组 ID

rg-aekzbck4asz3dsa

示例

正常返回示例

JSON格式

{
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F",
  "Status": "ACTIVATION",
  "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"
    }
  ],
  "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"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-03-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈