getCloudMysqlInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET, POST	/getCloudMysqlInstanceList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の Cloud DB for MySQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`zoneCode`	String	Optional	ゾーンコードでフィルタリング getZoneListを通じて確認
`vpcNo`	String	Optional	VPC番号でフィルタリング getCloudMysqlTargetVpcListを通じて確認
`subnetNo`	String	Optional	Subnet番号でフィルタリング getCloudMysqlTargetSubnetListを通じて確認
`cloudMysqlServiceName`	String	Optional	Cloud DB for MySQLサービス名でフィルタリング getCloudMysqlInstanceListを通じて確認
`cloudMysqlInstanceNoList.N`	List<String>	Optional	Cloud DB for MySQLインスタンス番号リスト Cloud DB for MySQLインスタンス番号でフィルタリング getCloudMysqlInstanceListを通じて確認 <例> `cloudMysqlInstanceNoList.1=1234&cloudMysqlInstanceNoList.2=2345`
`cloudMysqlServerName`	String	Optional	Cloud DB for MySQLサーバ名でフィルタリング getCloudMysqlInstanceListを通じて確認
`cloudMysqlServerInstanceNoList.N`	List<String>	Optional	Cloud DB for MySQLサーバインスタンス番号リスト Cloud DB for MySQLサーバインスタンス番号でフィルタリング getCloudMysqlInstanceListを通じて確認 <例> `cloudMysqlServerInstanceNoList.1=1234&cloudMysqlServerInstanceNoList.2=2345`
`generationCode`	String	Optional	サーバの世代コードでフィルタリング `G2` \| `G3` getCloudMysqlInstanceListを通じて確認
`pageNo`	Integer	Optional	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用してページング処理 0 (最小)
`pageSize`	Integer	Conditional	ページごとに表示する結果数 `pageNo`、`pageSize`を利用してページング処理 `pageNo`入力時、必須 1 (最小)
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/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'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "getCloudMysqlInstanceListResponse": {
        "totalRows": 1,
        "cloudMysqlInstanceList": [
            {
                "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": [
                    {
                        "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"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-1",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateIp": "***.***.***.***",
                        "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"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "****83",
                        "subnetNo": "****91",
                        "privateIp": "***.***.***.***",
                        "dataStorageSize": 10737418240,
                        "cpuCount": 2,
                        "memorySize": 8589934592
                    }
                ]
            }
        ],
        "requestId": "8f728514-****-****-****-e56324aeb031",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlInstanceListResponse>
  <requestId>8f728514-****-****-****-e56324aeb031</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>
          <regionCode>KR</regionCode>
          <zoneCode>KR-1</zoneCode>
          <vpcNo>****83</vpcNo>
          <subnetNo>****91</subnetNo>
          <privateIp>***.***.***.***</privateIp>
          <dataStorageSize>10737418240</dataStorageSize>
          <cpuCount>2</cpuCount>
          <memorySize>8589934592</memorySize>
        </cloudMysqlServerInstance>
        <cloudMysqlServerInstance>
          <cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
          <cloudMysqlServerName>test-****-002-4y1w</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>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>****83</vpcNo>
          <subnetNo>****93</subnetNo>
          <privateIp>***.***.***.***</privateIp>
          <dataStorageSize>10737418240</dataStorageSize>
          <cpuCount>2</cpuCount>
          <memorySize>8589934592</memorySize>
        </cloudMysqlServerInstance>
  </cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>

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

What's Next

getCloudMysqlProductList

リクエスト
レスポンス

タグ

Cloud DB for MySQL