getCloudDBInstanceList
    • PDF

    getCloudDBInstanceList

    • PDF

    記事の要約

    概要

    CloudDBインスタンスリスト情報を照会します。

    リクエスト

    リクエストヘッダ

    ヘッダ名説明
    x-ncp-apigw-timestamp1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-apigw-api-keyAPIGWで発行されたキーの値、v2を使用する場合、api-keyは使いません。
    x-ncp-apigw-api-key:{API Gateway API Key}
    x-ncp-iam-access-keyNaverクラウドプラットフォームで発行されたAccess Key ID値
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID値とSecret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-TypeRequest body content typeをapplication/jsonに指定
    Content-Type: application/json

    リクエストボディ

    APIリクエスト時には、フィールド名の大小文字区分が必要です。

    パラメータ名必須タイプ制約事項説明
    cloudDBInstanceNoListNList<String>インスタンス番号
    pageNoNintegerページ番号
    pageSizeNintegerページサイズ
    dbKindCodeYStringMYSQL , MSSQL , REDISDBタイプコード
    searchFilterNameNString検索フィルタ名
    searchFilterValueNString検索フィルタ値
    regionNoNStringリージョン番号
    zoneNoNStringzone番号
    responseFormatTypeNStringresponseの結果format設定
    • cloudDBInstanceNoList
      • 照会するインスタンス番号
    • pageNo
      • 件数が多い場合、ページサイズに該当するページ番号
    • pageSize
      • 1ページで照会するページサイズ
    • dbKindCode
      • 照会するCloudDBの種類選択、MSSQL・MySQL・Redisの中で入力します。
    • searchFilterName
      • 検索するフィルタの種類
    • searchFilterValue
      • 検索するフィルタ値
    • regionNo
      • Server APIであるgetRegionListを通じて取得できます。
    • zoneNo
      • Server APIであるgetZoneListを通じて取得できます。
    • responseFormatType
      • APIの実行結果をレスポンスするformatを決めます。xmlとjsonの中で選択できます。

    レスポンス

    フィールド名タイプ説明備考
    returnCodeIntegerレスポンスコード値
    returnMessageStringレスポンスメッセージ
    totalRowsIntegerレスポンス結果rowの数
    cloudDBInstanceList[]String作成されたcloud DB Instance情報

    例示

    リクエスト例示## 例示

    curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBInstanceList?pageNo=0&pageSize=0&dbKindCode=MYSQL&responseFormatType=json" 
    -H "accept: application/json" 
    -H "Content-Type: application/x-www-form-urlencoded" 
    -H "x-ncp-apigw-api-key: 25bpuog9sz" 
    -H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM" 
    -H "x-ncp-apigw-timestamp: 1545982163179" 
    -H "x-ncp-apigw-signature-v2: V/thRK1plszQrws/GphD5YAr94g0Z76t+w4Wn9zXZYw=" 
    
    https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBInstanceList?pageNo=0&pageSize=0&dbKindCode=MYSQL&responseFormatType=json
    

    リクエストサンプル

    • MySQLで作成されたinstance listの照会
    {
      "pageNo": 0,
      "pageSize": 0,
      "dbKindCode": "MYSQL",
      "responseFormatType": "json"
    }
    

    レスポンス例示

    connection: keep-alive 
    content-type: application/json;charset=UTF-8 
    date: Mon, 24 Dec 2018 08:59:40 GMT 
    server: nginx 
    transfer-encoding: chunked 
    x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2 
    
    {
      "getCloudDBInstanceListResponse": {
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "cloudDBInstanceList": [
          {
            "cloudDBInstanceNo": "882617",
            "cloudDBServiceName": "test",
            "dbKindCode": "MYSQL",
            "engineVersion": "MYSQL5.7.19",
            "cpuCount": 2,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "licenseCode": "GPL",
            "cloudDBPort": 3306,
            "isHa": true,
            "backupTime": "10:30",
            "backupFileRetentionPeriod": 1,
            "cloudDBInstanceStatusName": "running",
            "collation": "",
            "createDate": "2018-12-28T14:37:00+0900",
            "cloudDBImageProductCode": "SPSWMYSQLLINUX01",
            "cloudDBProductCode": "SPSVRDBAAS000001",
            "isCloudDBConfigNeedReboot": false,
            "isCloudDBNeedReboot": false,
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "カサンzone",
              "regionNo": "1"
            },
            "region": {
              "regionNo": "1",
              "regionCode": "KR",
              "regionName": "Korea"
            },
            "cloudDBConfigList": [],
            "cloudDBConfigGroupList": [],
            "accessControlGroupList": [
              {
                "accessControlGroupConfigurationNo": "23949",
                "accessControlGroupName": "cloud-db-ix15",
                "accessControlGroupDescription": "Group for cloud DB service 'test' (automatically created)",
                "isDefault": false,
                "createDate": "2018-12-28T14:37:29+0900"
              }
            ],
            "cloudDBServerInstanceList": [
              {
                "cloudDBServerInstanceNo": "882618",
                "cloudDBServerInstanceStatusName": "running",
                "cloudDBServerName": "test-001",
                "cloudDBServerRole": {
                  "code": "M",
                  "codeName": "Master"
                },
                "privateDnsName": "db-qttq.beta-cdb.ntruss.com",
                "publicDnsName": "",
                "dataStorageSize": 10737418240,
                "usedDataStorageSize": 0,
                "createDate": "2018-12-28T14:37:00+0900",
                "uptime": "2018-12-28T14:39:00+0900"
              },
              {
                "cloudDBServerName": "test-002",
                "cloudDBServerRole": {
                  "code": "H",
                  "codeName": "Hidden Master"
                }
              }
            ]
          }
        ]
      }
    }
    

    エラーコード

    Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。

    エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。

    エラーコードレスポンスメッセージ説明
    200Ok
    500Server Error

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.