VPC環境で利用できます。
概要
Cloud DB for Cacheインスタンスリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - リージョンコード Cloud DB for Cacheインスタンスリストが照会されるリージョン(Region)を決定可能 regionCodeはgetRegionListアクションを通じて取得可能 デフォルト: getRegionList照会結果の最初のリージョンを選択 |
|
| zoneCode | No | String | - ZONEコード Cloud DB for Cacheインスタンスリストが照会される Zoneを決定可能 zoneCodeはgetZoneListアクションを通じて取得可能 |
|
| vpcNo | No | String | - VPC番号 Cloud DB for Cacheインスタンスリストが照会される VPCを決定 vpcNoはgetCloudCacheTargetVpcListアクションを通じて取得可能 |
|
| subnetNo | No | String | - Subnet番号 Cloud DB for Cacheインスタンスリストが照会される Subnetを決定可能 SubnetNoはgetCloudCacheTargetSubnetListアクションを通じて取得可能 |
|
| cloudRedisServiceName | No | String | - Cloud DB for Cacheサービス名 Cloud DB for Cacheサービス名で絞り込んで検索可能 cloudRedisServiceNameはgetCloudCacheInstanceListアクションを通じて取得可能 |
|
| cloudRedisInstanceNoList | No | List<String> | - Cloud DB for Cacheインスタンス番号リスト Cloud DB for Cacheインスタンス番号で絞り込んで検索可能 cloudRedisInstanceNoListはgetCloudCacheInstanceListアクションを通じて取得可能 例) cloudRedisInstanceNoList 1234 2345 |
|
| cloudRedisServerName | No | String | - Cloud DB for Cacheサーバ名 Cloud DB for Cacheサーバ名で絞り込んで検索可能。 cloudRedisServerNameはgetCloudCacheInstanceListアクションを通じて取得可能 |
|
| cloudRedisServerInstanceNoList | No | List<String> | - Cloud DB for Cacheサーバインスタンス番号リスト Cloud DB for Cacheサーバインスタンス番号で絞り込んで検索可能 cloudRedisServerInstanceNoListはgetCloudRedisInstanceListアクションを通じて取得可能 例) cloudRedisServerInstanceNoList 1234 2345 |
|
| generationCode | No | String | - サーバの世代コード オプション: G2 | G3 |
|
| pageNo | No | Integer | 最小: 0 | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理できる |
| pageSize | Conditional | Integer | 最小: 1 | - ページング時に表示する各ページサイズ 結果値を pageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力 |
| output | No | String | - レスポンス結果の形式タイプ オプション: xml | json デフォルト: json |
レスポンス
レスポンスデータタイプ
- CloudRedisInstanceListタイプ
| CloudRedisInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<CloudRedisInstance> cloudRedisInstanceList = new ArrayList<>(); |
| CloudRedisInstance |
|---|
| private String cloudRedisInstanceNo; |
| private String cloudRedisServiceName; |
| private String cloudRedisInstanceStatusName; |
| private CommonCode cloudRedisInstanceStatus; |
| private CommonCode cloudRedisInstanceOperation; |
| private String cloudRedisImageProductCode; |
| private String engineVersion; |
| private CommonCode licence; |
| private Integer cloudRedisPort; |
| private Boolean isHa; |
| private String cloudRedisServerPrefix; |
| private Boolean isBackup; |
| private Integer backupFileRetentionPeriod; |
| private String backupTime; |
| private String backupSchedule; |
| private String generationCode; |
| private Date createDate; |
| private Integer shardCount; |
| private Integer shardCopyCount; |
| private AccessControlGroupNoList accessControlGroupNoList; |
| private String configGroupNo; |
| private String configGroupName; |
| private CommonCode role; |
| private List<CloudRedisInstance> cloudRedisServerInstanceList; |
| AccessControlGroupNoList |
|---|
| private List<String> accessControlGroupNoList = new ArrayList<>(); |
| CloudRedisServerInstance |
|---|
| private String cloudRedisServerInstanceNo; |
| private String cloudRedisServerName; |
| private CommonCode cloudRedisServerRole; |
| private String cloudRedisServerInstanceStatusName; |
| private CommonCode cloudRedisServerInstanceStatus; |
| private CommonCode cloudRedisServerInstanceOperation; |
| private String cloudRedisProductCode; |
| private String regionCode; |
| private String zoneCode; |
| private String vpcNo; |
| private String subnetNo; |
| private String privateDomain; |
| private Integer cpuCount; |
| private Long memorySize; |
| private Long osMemorySize; |
| private Date uptime; |
| private Date createDate; |
| private String slotName; |
例
呼び出し
ncloud vredis getCloudRedisInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ****65 --subnetNo ****92 --cloudRedisServiceName test-**** --cloudRedisInstanceNoList ****890 --cloudRedisServerName test--**** --cloudRedisServerInstanceNoList ****518 --pageNo 0 --pageSize 10
レスポンス
<getCloudRedisInstanceListResponse>
<requestId>722951df-d6d8-45a5-b3e1-7a16df4670f8</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<cloudRedisInstanceList>
<cloudRedisInstance>
<cloudRedisInstanceNo>****890</cloudRedisInstanceNo>
<cloudRedisInstanceName>test-****</cloudRedisInstanceName>
<cloudRedisInstanceStatusName>running</cloudRedisInstanceStatusName>
<cloudRedisInstanceStatus>
<code>CREAT</code>
<codeName>CLOUD DATABASE(VPC) Created State</codeName>
</cloudRedisInstanceStatus>
<cloudRedisInstanceOperation>
<code>NULL</code>
<codeName>CLOUD DATABASE(VPC) Null OP</codeName>
</cloudRedisInstanceOperation>
<isHa>false</isHa>
<role>
<code>CLUSTER</code>
<codeName>CLOUD REDIS(VPC) Cluster Role</codeName>
</role>
<generationCode>G2</generationCode>
<cloudRedisServerInstanceList>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****518</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-001-001-ehs</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****616</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-002-001-eht</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****619</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-003-001-ehu</cloudRedisServerName>
<cloudRedisServerRole>
<code>M</code>
<codeName>Master</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****622</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-001-002-ehv</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****625</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-002-002-ehw</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
<cloudRedisServerInstance>
<cloudRedisServerInstanceNo>****628</cloudRedisServerInstanceNo>
<cloudRedisServerName>test-****-003-002-ehx</cloudRedisServerName>
<cloudRedisServerRole>
<code>S</code>
<codeName>Slave</codeName>
</cloudRedisServerRole>
<cloudRedisServerInstanceStatusName>running</cloudRedisServerInstanceStatusName>
<cloudRedisServerInstanceStatus>
<code>RUN</code>
<codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
</cloudRedisServerInstanceStatus>
<cloudRedisServerInstanceOperation>
<code>NOOP</code>
<codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
</cloudRedisServerInstanceOperation>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****65</vpcNo>
<subnetNo>****92</subnetNo>
<privateDomain>redisc-*****-vpc-cdb.ntruss.com</privateDomain>
<cpuCount>4</cpuCount>
<memorySize>1610612736</memorySize>
</cloudRedisServerInstance>
</cloudRedisServerInstanceList>
</cloudRedisInstance>
</cloudRedisInstanceList>
</getCloudRedisInstanceListResponse>