getCloudMysqlInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

Cloud DB for MySQLのインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ	タイプ	要否	説明	制約事項
regionCode	String	N	Cloud DB for MySQLインスタンスが存在するリージョンコード - getRegionListアクションを通じて取得できる - default: getRegionList照会結果の最初のリージョン	-
zoneCode	String	N	ZONEコード - getZoneListアクションを通じて取得できる	-
vpcNo	String	N	VPC番号 - getCloudMysqlTargetVpcListアクションを通じて取得できる	-
subnetNo	String	N	Subnet番号 - getCloudMysqlTargetSubnetListアクションを通じて取得できる	-
cloudMysqlServiceName	String	N	Cloud DB for MySQLのサービス名 - getCloudMysqlInstanceListアクションを通じて取得できる	-
cloudMysqlInstanceNoList	List<String>	N	Cloud DB for MySQLのインスタンス番号リスト - getCloudMysqlInstanceListアクションを通じて取得できる - 例) cloudMysqlInstanceNoList.1=1234&cloudMysqlInstanceNoList.2=2345	-
cloudMysqlServerName	String	N	Cloud DB for MySQLのサーバ名 - getCloudMysqlInstanceListアクションを通じて取得できる	-
cloudMysqlServerInstanceNoList	List<String>	N	Cloud DB for MySQLのサーバインスタンス番号リスト - getCloudMysqlInstanceListアクションを通じて取得できる - 例) cloudMysqlServerInstanceNoList.1=1234&cloudMysqlServerInstanceNoList.2=2345	-
generationCode	String	N	サーバの世代コード - getCloudMysqlInstanceListアクションを通じて取得できる - options: G2 \| G3	-
pageNo	Integer	N	ページングされた結果のページ番号 - 結果値を、pageNo、pageSizeを利用してページング処理可能	min: 0
pageSize	Integer	N	ページング時に表示する各ページサイズ - 結果値を、pageNo、pageSizeを利用してページング処理可能 - pageNo入力時に必ず入力	min: 1
responseFormatType	String	N	レスポンス結果のフォーマットタイプ - options: xml \| json - default: xml	-

レスポンス

レスポンスボディ

レスポンスボディは CloudMysqlInstanceListをご参照ください。

例

リクエスト例

リクエスト構文例は以下のとおりです。

GET {API_URL}/getCloudMysqlInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***83
&subnetNo=**91
&cloudMysqlServiceName=test-****
&cloudMysqlInstanceNoList.1=****890
&cloudMysqlServerName=test-****
&cloudMysqlServerInstanceNoList.1=****891
&generationCode=G2
&pageNo=0
&pageSize=10

レスポンス例

レスポンス構文例は以下のとおりです。

レスポンス結果フォーマットタイプ(responseFormatType)が jsonであるとき

{
  "getCloudMysqlInstanceListResponse": {
    "requestId": "1ae10c76-412d-4050-8911-42fa19a60a31",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudMysqlInstanceList": {
      "cloudMysqlInstance": {
        "cloudMysqlInstanceNo": "****890",
        "cloudMysqlServiceName": "test-****",
        "cloudMysqlInstanceStatusName": "running",
        "cloudMysqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudMysqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "isHa": true,
        "isMultiZone": true,
        "generationCode": "G2",
        "cloudMysqlServerInstanceList": {
          "cloudMysqlServerInstance": [
            {
              "cloudMysqlServerInstanceNo": "****891",
              "cloudMysqlServerName": "test-****-001-e04",
              "cloudMysqlServerRole": {
                "code": "M",
                "codeName": "Master"
              },
              "cloudMysqlServerInstanceStatusName": "running",
              "cloudMysqlServerInstanceStatus": {
                "code": "RUN",
                "codeName": "CLOUD DATABASE(VPC) Server Running State"
              },
              "cloudMysqlServerInstanceOperation": {
                "code": "NOOP",
                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
              },
              "privateIp": "***.***.***.***",
              "regionCode": "KR",
              "zoneCode": "KR-1",
              "vpcNo": "****83",
              "subnetNo": "****91",
              "dataStorageSize": 10737418240,
              "cpuCount": 2,
              "memorySize": 8589934592
            },
            {
              "cloudMysqlServerInstanceNo": "****897",
              "cloudMysqlServerName": "test-****-002-e05",
              "cloudMysqlServerRole": {
                "code": "H",
                "codeName": "Standby Master"
              },
              "cloudMysqlServerInstanceStatusName": "running",
              "cloudMysqlServerInstanceStatus": {
                "code": "RUN",
                "codeName": "CLOUD DATABASE(VPC) Server Running State"
              },
              "cloudMysqlServerInstanceOperation": {
                "code": "NOOP",
                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
              },
              "privateIp": "***.***.***.***",
              "regionCode": "KR",
              "zoneCode": "KR-2",
              "vpcNo": "****83",
              "subnetNo": "****93",
              "dataStorageSize": 10737418240,
              "cpuCount": 2,
              "memorySize": 8589934592
            }
          ]
        }
      }
    }
  }
}

レスポンス結果フォーマットタイプ(responseFormatType)が xmlであるとき


<getCloudMysqlInstanceListResponse>
    <requestId>1ae10c76-412d-4050-8911-42fa19a60a31</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudMysqlInstanceList>
        <cloudMysqlInstance>
            <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
            <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
            <cloudMysqlInstanceStatusName>running</cloudMysqlInstanceStatusName>
            <cloudMysqlInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudMysqlInstanceStatus>
            <cloudMysqlInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
            </cloudMysqlInstanceOperation>
            <isHa>true</isHa>
            <isMultiZone>true</isMultiZone>
            <generationCode>G2</generationCode>
            <cloudMysqlServerInstanceList>
                <cloudMysqlServerInstance>
                    <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
                    <cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
                    <cloudMysqlServerRole>
                        <code>M</code>
                        <codeName>Master</codeName>
                    </cloudMysqlServerRole>
                    <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                    <cloudMysqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMysqlServerInstanceStatus>
                    <cloudMysqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMysqlServerInstanceOperation>
                    <privateIp>***.***.***.***</privateIp>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-1</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****91</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                </cloudMysqlServerInstance>
                <cloudMysqlServerInstance>
                    <cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
                    <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
                    <cloudMysqlServerRole>
                        <code>H</code>
                        <codeName>Standby Master</codeName>
                    </cloudMysqlServerRole>
                    <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                    <cloudMysqlServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudMysqlServerInstanceStatus>
                    <cloudMysqlServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                    </cloudMysqlServerInstanceOperation>
                    <privateIp>***.***.***.***</privateIp>
                    <regionCode>KR</regionCode>
                    <zoneCode>KR-2</zoneCode>
                    <vpcNo>****83</vpcNo>
                    <subnetNo>****93</subnetNo>
                    <dataStorageSize>10737418240</dataStorageSize>
                    <cpuCount>2</cpuCount>
                    <memorySize>8589934592</memorySize>
                </cloudMysqlServerInstance>
            </cloudMysqlServerInstanceList>
        </cloudMysqlInstance>
    </cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>

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

What's Next

getCloudMysqlProductList

リクエスト
レスポンス
例

タグ

Cloud DB for MySQL