すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:DescribeDBInstancesAsCsv

    ドキュメントセンター

    ApsaraDB RDS:DescribeDBInstancesAsCsv

    最終更新日:Apr 18, 2026

    この API はインスタンスリストをクエリするために使用されます。この API は非推奨となっており、呼び出しは可能ですが、メンテナンスは終了しています。

    説明

    この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Rds(2014-08-15) - DescribeDBInstances への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

    操作説明

    この API は非推奨です。呼び出しは可能ですが、Alibaba Cloud ではすでにメンテナンスされていません。代わりに DescribeDBInstances API を使用してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rds:DescribeDBInstancesAsCsv

    get

    DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID です。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    DBInstanceId

    string

    任意

    インスタンス ID です。DescribeDBInstances 操作を呼び出して、インスタンスの詳細をクエリできます。

    rm-uf6wjk5****

    ResourceGroupId

    string

    任意

    リソースグループの ID です。

    rg-acfmy****
    CachedAsync

    boolean

    任意

    このパラメーターは非推奨です。

    API
    ExportKey

    string

    任意

    このパラメーターは非推奨です。

    API

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    Items

    object

    DBInstanceAttribute

    array<object>

    DBInstanceAttribute オブジェクトの配列。

    array<object>

    インスタンスの属性。

    AccountMaxQuantity

    integer

    インスタンスで作成できるアカウントの最大数。

    500
    AccountType

    string

    アカウントのタイプ。

    super
    AvailabilityValue

    string

    インスタンスの可用性 (パーセンテージ)。

    100
    Category

    string

    インスタンスのカテゴリ。

    0
    ConnectionMode

    string

    インスタンスの接続モード。有効値：

    • Performance：標準接続モード。

    • Safety：高セキュリティ接続モード。

    Performance
    ConnectionString

    string

    内部エンドポイント。

    rm-uf6wjk5****.mysql.rds.aliyuncs.com
    CreationTime

    string

    インスタンスの作成タイムスタンプ。

    2011-05-30T12:11:04Z
    DBInstanceCPU

    string

    インスタンスの CPU コア数。

    2
    DBInstanceClass

    string

    インスタンスタイプ。

    rds.mys2.small
    DBInstanceClassType

    string

    インスタンスファミリー。

    s
    DBInstanceDescription

    string

    インスタンスの説明。

    0
    DBInstanceId

    string

    インスタンス ID。

    rm-uf6wjk5****
    DBInstanceMemory

    integer

    インスタンスのメモリサイズ (単位：メガバイト (MB))。

    4096
    DBInstanceNetType

    string

    インスタンスのネットワークタイプ。有効値：

    • Internet：パブリックネットワーク。

    • Intranet：内部ネットワーク。

    Internet
    DBInstanceStatus

    string

    インスタンスステータス。

    Running
    DBInstanceStorage

    integer

    インスタンスのストレージサイズ (単位：ギガバイト (GB))。

    10
    DBInstanceType

    string

    インスタンスロール。有効値：

    • Primary：プライマリインスタンス。

    • ReadOnly：読み取り専用インスタンス。

    • Guard：ディザスタリカバリ (DR) インスタンス。

    • Temp：一時インスタンス。

    Primary
    DBMaxQuantity

    integer

    インスタンスで作成できるデータベースの最大数。

    200
    Engine

    string

    インスタンスのデータベースエンジン。

    MySQL
    EngineVersion

    string

    データベースエンジンバージョン。

    8.0
    ExpireTime

    string

    インスタンスの有効期限。このパラメーターは、サブスクリプションインスタンスの場合にのみ返されます。

    2019-03-27T16:00:00Z
    ExportKey

    string

    このパラメーターは非推奨であり、無視できます。

    API
    GuardDBInstanceId

    string

    アタッチされているディザスタリカバリ (DR) インスタンスの ID。

    rm-uf64zsu****
    IncrementSourceDBInstanceId

    string

    増分データレプリケーションのソースインスタンスの ID。たとえば、DR インスタンスまたは読み取り専用インスタンスのソースは、そのプライマリインスタンスです。

    rm-uf6wjk5****
    InstanceNetworkType

    string

    インスタンスのネットワークタイプ。

    VPC
    LockMode

    string

    インスタンスのロックモード。

    Unlock
    LockReason

    string

    インスタンスがロックされた理由。

    instance_expired
    MaintainTime

    string

    インスタンスのメンテナンスウィンドウ。時刻は協定世界時 (UTC) で指定されます。ApsaraDB RDS コンソールでは、時刻は UTC+8 タイムゾーンで表示されます。

    00:00Z-02:00Z
    MasterInstanceId

    string

    プライマリインスタンスの ID。

    rm-uf6wjk5****
    MaxConnections

    integer

    最大同時接続数。

    60
    MaxIOPS

    integer

    最大 IOPS (1 秒あたりの I/O 操作)。

    150
    PayType

    string

    インスタンスの課金方法。

    Postpaid
    Port

    string

    内部ポート番号。

    3306
    ReadDelayTime

    string

    プライマリインスタンスからのデータレプリケーションの遅延。このパラメーターは、読み取り専用インスタンスの場合にのみ返されます。

    0
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    SecurityIPList

    string

    インスタンスの IP 許可リスト。

    42.XX.XX.XX
    SlaveZones

    object

    slaveRegion

    array

    このパラメーターは非推奨であり、無視できます。

    string

    このパラメーターは非推奨であり、無視できます。

    API
    SupportUpgradeAccountType

    string

    アカウントタイプをスペックアップできるかどうかを示します。

    No
    Tags

    string

    インスタンスにアタッチされているタグ。

    0
    TempDBInstanceId

    string

    アタッチされている一時インスタンスの ID。

    rm-uf64zs****
    VSwitchId

    string

    VSwitch の ID。

    vsw-uf6adz52c2p****
    VpcId

    string

    VPC の ID。

    vpc-uf6f7l4fg90****

    ZoneId

    string

    アベイラビリティゾーンの ID。

    cn-hangzhou-j
    DBInstanceStorageType

    string
    インスタンスのストレージタイプ。

    RequestId

    string

    リクエスト ID。

    1AD222E9-E606-4A42-BF6D-8A444291****

    例

    成功レスポンス

    JSONJSON

    {
  "Items": {
    "DBInstanceAttribute": [
      {
        "AccountMaxQuantity": 500,
        "AccountType": "super",
        "AvailabilityValue": "100",
        "Category": "0",
        "ConnectionMode": "Performance",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "CreationTime": "2011-05-30T12:11:04Z",
        "DBInstanceCPU": "2",
        "DBInstanceClass": "rds.mys2.small",
        "DBInstanceClassType": "s",
        "DBInstanceDescription": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceMemory": 4096,
        "DBInstanceNetType": "Internet",
        "DBInstanceStatus": "Running",
        "DBInstanceStorage": 10,
        "DBInstanceType": "Primary",
        "DBMaxQuantity": 200,
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "ExpireTime": "2019-03-27T16:00:00Z",
        "ExportKey": "API",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "IncrementSourceDBInstanceId": "rm-uf6wjk5****",
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "instance_expired",
        "MaintainTime": "00:00Z-02:00Z",
        "MasterInstanceId": "rm-uf6wjk5****",
        "MaxConnections": 60,
        "MaxIOPS": 150,
        "PayType": "Postpaid",
        "Port": "3306",
        "ReadDelayTime": "0",
        "RegionId": "cn-hangzhou",
        "SecurityIPList": "42.XX.XX.XX",
        "SlaveZones": {
          "slaveRegion": [
            "API"
          ]
        },
        "SupportUpgradeAccountType": "No",
        "Tags": "0",
        "TempDBInstanceId": "rm-uf64zs****",
        "VSwitchId": "vsw-uf6adz52c2p****",
        "VpcId": "vpc-uf6f7l4fg90****\t ",
        "ZoneId": "cn-hangzhou-j",
        "DBInstanceStorageType": ""
      }
    ]
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A444291****\t"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InstanceNames.Malformed instance number of Instance Names should be less than 3000
    400 400 Export all instances more than 6 times in an hour, please try 1 hour later.
    400 ExportLimitExceeded Export all instances more than 6 times in an hour, please try 1 hour later.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400 Price.CommoditySys Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
    400 KmsApiError User secret key invalid.
    400 System.SaleValidateFailed Sales expression validation system error.
    400 Abs.InvalidAccount.NotFound account is not found.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s.
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400 InvalideStatus.Format The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation.
    400 Pay.NoCreditCard No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported.
    500 ExternalFailure The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api.
    403 Export.InProcess There is already a task running, please try later
    403 OrderStatus.UnPaid The specified db instance has unpaid order.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount.
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 IncorrectMinorVersion Current engine minor version does not support operations.
    403 OperationDenied.ZoneResource There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service.
    404 Request.NotFound The requested resource is not available.
    404 HostInfo.NotFound The specified host info is not found.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。