DescribeDrdsInstance - 查询 DRDS 实例详情

更新时间:
复制 MD 格式

调用DescribeDrdsInstance接口查询实例详情。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

drds:DescribeDrdsInstance

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

DrdsInstanceId

string

是

实例 ID。

drdshbga1138****

RegionId

string

否

地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Success

boolean

请求是否成功。

true

RequestId

string

请求 ID。

B4F76641-BA45-4320-BE7C-9C62CFDAC9B2

Data

object

实例详情列表。

Type

string

实例类型,独享实例 PRIVATE,共享实例 PUBLIC。

PRIVATE

Status

string

实例状态。

RUN

CreateTime

integer

实例创建的时间戳。

1568620311000

VersionAction

string

实例版本可用操作。

Upgradeable

StorageType

string

存储实例类型。

RDS

NetworkType

string

网络类型,经典网络 CLASSIC,VPC 网络为 VPC。

CLASSIC

Label

string

实例标签:

  • 普通实例: NORMAL

  • 高可用实例: HA

  • VPC 实例:VPC

NORMAL

MysqlVersion

integer

实例支持的 MySQL 版本。

5

InstanceSpec

string

实例规格。

drds.sn2.4c16g.8C32G

VpcCloudInstanceId

string

VPC 集群中的实例 ID。

drdssen12****

Description

string

实例描述。

drds_test

Version

integer

实例版本,目前为空。

0

ExpireDate

integer

实例过期的时间戳。

4724323200000

MasterInstanceId

string

主实例 ID。

说明

当实例类型为只读实例时,才会返回该参数。

drdssen1243as

CommodityCode

string

商品代码。

drdsPost

MachineType

string

实例机器类型,固定为 ecs。

ecs

InstanceSeries

string

实例规格系列。

drds.sn2.4c16g

ProductVersion

string

产品版本。

5.3.*

RegionId

string

地域 ID。

cn-hangzhou

ResourceGroupId

string

资源组 ID,可以为空。

NULL

DrdsInstanceId

string

实例 ID。

drdssen1243as

ZoneId

string

可用区 ID。

cn-hangzhou-e

InstRole

string

实例角色,取值如下:

  • 主实例: MASTER

  • 分析型只读实例:SLAVE

  • 并发型只读实例:SLAVE_FLOW

MASTER

OrderInstanceId

string

购买的实例 ID。

drdssen12****

Vips

object

Vip

array<object>

VIP 列表。

object

Type

string

VIP 类型,内网 intranet,外网 internet

intranet

VpcId

string

VPC 的 ID。

vpc-bp**********

VswitchId

string

虚拟交换机的 ID。

vsw-bp***********

Dns

string

VIP 绑定的域名。

drdssen1243as.drds.aliyuncs.com

Port

string

VIP 开放端口。

3306

ExpireDays

integer

VIP 过期剩余天数。

0

RemoveWeight

boolean

ReadOnlyDBInstanceIds

object

ReadOnlyDBInstanceId

array

只读实例 ID 列表。

string

只读实例 ID 列表。

drdssen12****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "B4F76641-BA45-4320-BE7C-9C62CFDAC9B2",
  "Data": {
    "Type": "PRIVATE",
    "Status": "RUN",
    "CreateTime": 1568620311000,
    "VersionAction": "Upgradeable",
    "StorageType": "RDS",
    "NetworkType": "CLASSIC",
    "Label": "NORMAL",
    "MysqlVersion": 5,
    "InstanceSpec": "drds.sn2.4c16g.8C32G",
    "VpcCloudInstanceId": "drdssen12****",
    "Description": "drds_test",
    "Version": 0,
    "ExpireDate": 4724323200000,
    "MasterInstanceId": "drdssen1243as",
    "CommodityCode": "drdsPost",
    "MachineType": "ecs",
    "InstanceSeries": "drds.sn2.4c16g",
    "ProductVersion": "5.3.*",
    "RegionId": "cn-hangzhou",
    "ResourceGroupId": "NULL",
    "DrdsInstanceId": "drdssen1243as",
    "ZoneId": "cn-hangzhou-e",
    "InstRole": "MASTER",
    "OrderInstanceId": "drdssen12****",
    "Vips": {
      "Vip": [
        {
          "Type": "intranet",
          "VpcId": "vpc-bp**********",
          "VswitchId": "vsw-bp***********",
          "Dns": "drdssen1243as.drds.aliyuncs.com",
          "Port": "3306",
          "ExpireDays": 0,
          "RemoveWeight": true
        }
      ]
    },
    "ReadOnlyDBInstanceIds": {
      "ReadOnlyDBInstanceId": [
        "drdssen12****"
      ]
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 ActionUnauthorized The specified action is not available for you
400 InternalError The request processing has failed due to some unknown error. 请求失败,内部错误
404 InvalidDRDSInstanceId.NotFound The DrdsInstanceId provided does not exist in our records.
404 DrdsInstance.NotExists The DRDS instance does not exist. drds实例不存在

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

变更历史

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