upgradeCloudMysqlDbEngineVersion

Prev Next

VPC環境で利用できます。

Cloud DB for MySQLインスタンスの DBエンジンバージョンをアップグレードします。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET, POST /upgradeCloudMysqlDbEngineVersion

リクエストヘッダ

Cloud DB for MySQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MySQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • DBエンジンバージョンアップグレード対象 Cloud DB for MySQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMysqlInstanceNo String Required Cloud DB for MySQLインスタンス番号
cloudMysqlImageProductCode String Required Cloud DB for MySQLイメージ商品コード
engineVersionCode String Conditional エンジンバージョンコード
  • アップグレード対象 DBエンジンのバージョンコード
  • getCloudMysqlImageProductListを通じて確認
  • 入力しない場合、現在提供中の最新バージョンで作成
isMajorVersionUpgrade Boolean Optional メジャーバージョンアップグレードにするか
  • true | false (デフォルト)
    • true: メジャーバージョンアップグレードを実施 (例: MySQL 5.7.40 → 8.0.32)
    • false: マイナーバージョンアップグレードのみ実施 (例: MySQL 8.0.34 → 8.0.40)
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/upgradeCloudMysqlDbEngineVersion
?regionCode=KR
&cloudMysqlInstanceNo=****890
&cloudMysqlImageProductCode=SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050
&engineVersionCode=MYSQL8.0.40
&isMajorVersionUpgrade=false
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormatType=jsonの場合

    {
      "upgradeCloudMysqlDbEngineVersionResponse": {
        "requestId": "eb46ade8-****-****-****-133bcbc382c1",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 1,
        "cloudMysqlInstanceList": [
          {
            "cloudMysqlInstanceNo": "****890",
            "cloudMysqlServiceName": "test-****",
            "cloudMysqlInstanceStatusName": "upgrading",
            "cloudMysqlInstanceStatus": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Created State"
            },
            "cloudMysqlInstanceOperation": {
              "code": "UPGD",
              "codeName": "CLOUD DATABASE(VPC) Upgrade OP"
            },
            "cloudMysqlImageProductCode": "SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050",
            "engineVersion": "MYSQL8.0.40",
            "license": {
              "code": "GPL",
              "codeName": "General Public License"
            },
            "cloudMysqlPort": 13306,
            "isHa": true,
            "isMultiZone": true,
            "isBackup": true,
            "backupFileRetentionPeriod": 10,
            "backupTime": "02:00",
            "generationCode": "G2",
            "createDate": "2024-05-23T11:25:09+0900",
            "accessControlGroupNoList": [],
            "cloudMysqlConfigList": [],
            "cloudMysqlServerInstanceList": [
              {
                "cloudMysqlServerName": "test-****-001-e04",
                "cloudMysqlServerRole": {
                  "code": "M",
                  "codeName": "Master"
                },
                "cloudMysqlServerInstanceStatusName": "settingUp",
                "cloudMysqlServerInstanceStatus": {
                  "code": "RUN",
                  "codeName": "CLOUD DATABASE(VPC) Server Running State"
                },
                "cloudMysqlServerInstanceOperation": {
                  "code": "SETUP",
                  "codeName": "CLOUD DATABASE(VPC) Server Setup OP"
                },
                "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.SSD.B050.G002",
                "regionCode": "KR",
                "zoneCode": "KR-1",
                "vpcNo": "****83",
                "subnetNo": "****91",
                "isPublicSubnet": true,
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                },
                "isStorageEncryption": true,
                "dataStorageSize": 10737418240,
                "cpuCount": 2,
                "memorySize": 8589934592,
                "createDate": "2024-05-23T11:25:09+0900"
              },
              {
                "cloudMysqlServerName": "test-****-002-e05",
                "cloudMysqlServerRole": {
                  "code": "H",
                  "codeName": "Standby Master"
                },
                "cloudMysqlServerInstanceStatusName": "settingUp",
                "cloudMysqlServerInstanceStatus": {
                  "code": "RUN",
                  "codeName": "CLOUD DATABASE(VPC) Server Running State"
                },
                "cloudMysqlServerInstanceOperation": {
                  "code": "SETUP",
                  "codeName": "CLOUD DATABASE(VPC) Server Setup OP"
                },
                "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.SSD.B050.G002",
                "regionCode": "KR",
                "zoneCode": "KR-2",
                "vpcNo": "****83",
                "subnetNo": "****93",
                "isPublicSubnet": true,
                "dataStorageType": {
                  "code": "SSD",
                  "codeName": "SSD"
                },
                "isStorageEncryption": true,
                "dataStorageSize": 10737418240,
                "cpuCount": 2,
                "memorySize": 8589934592,
                "createDate": "2024-05-23T11:25:09+0900"
              }
            ]
          }
        ]
      }
    }
    
  • responseFormatType=xmlの場合 (デフォルト)

    <?xml version="1.0" encoding="UTF-8"?>
    <upgradeCloudMysqlDbEngineVersionResponse>
      <requestId>eb46ade8-****-****-****-133bcbc382c1</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <cloudMysqlInstanceList>
        <cloudMysqlInstance>
          <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
          <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
          <cloudMysqlInstanceStatusName>upgrading</cloudMysqlInstanceStatusName>
          <cloudMysqlInstanceStatus>
            <code>CREAT</code>
            <codeName>CLOUD DATABASE(VPC) Created State</codeName>
          </cloudMysqlInstanceStatus>
          <cloudMysqlInstanceOperation>
            <code>UPGD</code>
            <codeName>CLOUD DATABASE(VPC) Upgrade OP</codeName>
          </cloudMysqlInstanceOperation>
          <cloudMysqlImageProductCode>SW.VMYSL.OS.LNX64.ROCKY.0810.MYSQL.B050</cloudMysqlImageProductCode>
          <engineVersion>MYSQL8.0.40</engineVersion>
          <license>
            <code>GPL</code>
            <codeName>General Public License</codeName>
          </license>
          <cloudMysqlPort>13306</cloudMysqlPort>
          <isHa>true</isHa>
          <isMultiZone>true</isMultiZone>
          <isBackup>true</isBackup>
          <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
          <backupTime>02:00</backupTime>
          <generationCode>G2</generationCode>
          <createDate>2024-05-23T11:25:09+0900</createDate>
          <accessControlGroupNoList />
          <cloudMysqlConfigList />
          <cloudMysqlServerInstanceList>
            <cloudMysqlServerInstance>
              <cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
              <cloudMysqlServerRole>
                <code>M</code>
                <codeName>Master</codeName>
              </cloudMysqlServerRole>
              <cloudMysqlServerInstanceStatusName>settingUp</cloudMysqlServerInstanceStatusName>
              <cloudMysqlServerInstanceStatus>
                <code>RUN</code>
                <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
              </cloudMysqlServerInstanceStatus>
              <cloudMysqlServerInstanceOperation>
                <code>SETUP</code>
                <codeName>CLOUD DATABASE(VPC) Server Setup OP</codeName>
              </cloudMysqlServerInstanceOperation>
              <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
              <regionCode>KR</regionCode>
              <zoneCode>KR-1</zoneCode>
              <vpcNo>****83</vpcNo>
              <subnetNo>****91</subnetNo>
              <isPublicSubnet>true</isPublicSubnet>
              <dataStorageType>
                <code>SSD</code>
                <codeName>SSD</codeName>
              </dataStorageType>
              <isStorageEncryption>true</isStorageEncryption>
              <dataStorageSize>10737418240</dataStorageSize>
              <cpuCount>2</cpuCount>
              <memorySize>8589934592</memorySize>
              <createDate>2024-05-23T11:25:09+0900</createDate>
            </cloudMysqlServerInstance>
            <cloudMysqlServerInstance>
              <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
              <cloudMysqlServerRole>
                <code>H</code>
                <codeName>Standby Master</codeName>
              </cloudMysqlServerRole>
              <cloudMysqlServerInstanceStatusName>settingUp</cloudMysqlServerInstanceStatusName>
              <cloudMysqlServerInstanceStatus>
                <code>RUN</code>
                <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
              </cloudMysqlServerInstanceStatus>
              <cloudMysqlServerInstanceOperation>
                <code>SETUP</code>
                <codeName>CLOUD DATABASE(VPC) Server Setup OP</codeName>
              </cloudMysqlServerInstanceOperation>
              <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
              <regionCode>KR</regionCode>
              <zoneCode>KR-2</zoneCode>
              <vpcNo>****83</vpcNo>
              <subnetNo>****93</subnetNo>
              <isPublicSubnet>true</isPublicSubnet>
              <dataStorageType>
                <code>SSD</code>
                <codeName>SSD</codeName>
              </dataStorageType>
              <isStorageEncryption>true</isStorageEncryption>
              <dataStorageSize>10737418240</dataStorageSize>
              <cpuCount>2</cpuCount>
              <memorySize>8589934592</memorySize>
              <createDate>2024-05-23T11:25:09+0900</createDate>
            </cloudMysqlServerInstance>
          </cloudMysqlServerInstanceList>
        </cloudMysqlInstance>
      </cloudMysqlInstanceList>
    </upgradeCloudMysqlDbEngineVersionResponse>