文档

ListInstances - 获取实例信息列表

更新时间:

调用ListInstances接口,获取实例信息列表。

调试

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

授权信息

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

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

请求参数

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

租户 ID,可通过调用接口 GetUserActiveTenant 获取该参数的值。

3***
SearchKeystring

搜索关键字。

test
DbTypestring

数据库类型,取值请参见 DbType 参数说明

MySQL
EnvTypestring

环境类型,取值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT 环境
  • uat:UAT 环境
  • pet:压测环境
  • stag:STAG 环境
product
InstanceSourcestring

实例来源,取值如下:

  • PUBLIC_OWN:代表公网自建实例
  • RDS:代表 RDS 实例
  • ECS_OWN:代表 ECS 自建实例
  • VPC_IDC:代表 VPC IDC 自建实例
RDS
NetTypestring

实例网络类型,取值如下:

  • CLASSIC:经典网络
  • VPC:VPC 网络
VPC
InstanceStatestring

实例状态,取值如下:

  • NORMAL:正常使用
  • DISABLE:禁用
NORMAL
PageNumberinteger

第几页。

1
PageSizeinteger

每页多少条数据,取值不超过 100。

50

返回参数

名称类型描述示例值
object

描述。

TotalCountlong

满足条件的实例总个数。

1
RequestIdstring

请求 ID。

B4B07137-F6AE-4756-8474-7F92BB6C4E04
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
InstanceListobject []

实例列表。

VpcIdstring

实例所属 VPC 的 ID。

vpc-o6wrloqsdqc9io3mg****
DatabaseUserstring

数据库用户名。

dbUser
DbaIdstring

实例 DBA ID。

31****
UseDsqlinteger

实例是否开启跨库查询:

  • 0:不开启
  • 1:开启
1
Portinteger

实例连接端口。

3306
EcsInstanceIdstring

实例 ECS ID。

150****
EnvTypestring

实例环境类型,返回值如下:

  • product:生产环境
  • dev:开发环境
  • pre:预发环境
  • test:测试环境
  • sit:SIT 环境
  • uat:UAT 环境
  • pet:压测环境
  • stag:STAG 环境
product
Sidstring

实例 Sid。

test
OwnerIdListarray

实例 Owner UserId 列表。

string

实例 Owner UserId。

12****
SafeRuleIdstring

实例安全规则 ID。

1
OwnerNameListarray

实例 Owner 昵称列表。

string

实例 Owner 昵称。

yuyang_test
DbaNickNamestring

实例 DBA 昵称。

dbaName
QueryTimeoutinteger

实例查询超时时间。

60
InstanceSourcestring

实例来源。

RDS
Hoststring

实例连接地址。

****.mysql.rds.aliyuncs.com
Statestring

实例状态。

NORMAL
DataLinkNamestring

DataLink 名称。

dblink_test
ExportTimeoutinteger

导出超时时间。

86400
InstanceIdstring

实例 ID。

150***
InstanceTypestring

实例 DB 类型。

mysql
DatabasePasswordstring

数据库用户密码。

******
InstanceAliasstring

实例别名。

test
DdlOnlineinteger

实例 DdlOnline 配置。

1
EcsRegionstring

实例所属地域。

cn-hangzhou
StandardGroupobject

实例对应的管控模式信息。

GroupNamestring

管控模式对应的安全规则名称。

test
GroupModestring

管控模式类型,取值如下:

  • COMMON:安全协同模式
  • NONE_CONTROL: 自由操作模式
  • STABLE:稳定变更模式
COMMON
SellSitdboolean

敏感数据保护是否开启,取值:

  • true:开启

  • false:关闭

true
Successboolean

请求是否成功:

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "InstanceList": {
    "Instance": [
      {
        "VpcId": "vpc-o6wrloqsdqc9io3mg****",
        "DatabaseUser": "dbUser",
        "DbaId": "31****",
        "UseDsql": 1,
        "Port": 3306,
        "EcsInstanceId": "150****",
        "EnvType": "product",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "12****"
          ]
        },
        "SafeRuleId": "1",
        "OwnerNameList": {
          "OwnerNames": [
            "yuyang_test"
          ]
        },
        "DbaNickName": "dbaName",
        "QueryTimeout": 60,
        "InstanceSource": "RDS",
        "Host": "****.mysql.rds.aliyuncs.com",
        "State": "NORMAL",
        "DataLinkName": "dblink_test",
        "ExportTimeout": 86400,
        "InstanceId": "150***",
        "InstanceType": "mysql",
        "DatabasePassword": "******",
        "InstanceAlias": "test",
        "DdlOnline": 1,
        "EcsRegion": "cn-hangzhou",
        "StandardGroup": {
          "GroupName": "test",
          "GroupMode": "COMMON"
        },
        "SellSitd": true
      }
    ]
  },
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈