getCloudRedisInstanceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用可能です。

概要

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

要請

レスポンスデータタイプ

パラメータ	必須	タイプ	制約事項	説明
regionCode	No	String		リージョンコード Cloud DB for Redisのインスタンスリストが照会されるリージョンを決定できます。regionCodeはgetRegionListアクションを通じて取得できます。Default：getRegionList照会結果の最初のリージョンを選択
zoneCode	No	String		Zoneコード Cloud DB for Redisのインスタンスリストが照会されるZoneを決定できます。zoneCodeはgetZoneListアクションを通じて取得できます。
vpcNo	No	String		VPC番号 Cloud DB for Redisのインスタンスリストが照会されるVPCを決定できます。vpcNoはgetCloudRedisTargetVpcListアクションを通じて取得できます。
subnetNo	No	String		Subnet番号 Cloud DB for Redisのインスタンスリストが照会されるSubnetを決定できます。SubnetNoはgetCloudRedisTargetSubnetListアクションを通じて取得できます。
cloudRedisServiceName	No	String		Cloud DB for Redisのサービス名 Cloud DB for Redisのサービス名でフィルタリングして検索できます。cloudRedisServiceNameはgetCloudRedisInstanceListアクションを通じて取得できます。
cloudRedisInstanceNoList	No	List<String>		Cloud DB for Redisのインスタンス番号リスト Cloud DB for Redisのインスタンス番号でフィルタリングして検索できます。cloudRedisInstanceNoListはgetCloudRedisInstanceListアクションを通じて取得できます。ex) cloudRedisInstanceNoList 1234 2345
cloudRedisServerName	No	String		Cloud DB for Redisのサーバ名 Cloud DB for Redisのサーバ名でフィルタリングして検索できます。cloudRedisServerNameはgetCloudRedisInstanceListアクションを通じて取得できます。
cloudRedisServerInstanceNoList	No	List<String>		Cloud DB for Redisのサーバインスタンス番号リスト Cloud DB for Redisのサーバインスタンス番号でフィルタリングして検索できます。cloudRedisServerInstanceNoListはgetCloudRedisInstanceListアクションを通じて取得できます。ex) cloudRedisServerInstanceNoList 1234 2345
pageNo	No	Integer	Min: 0	ページングされた結果のページ番号の結果値をpageNo、pageSizeを用いてページング処理することができます。
pageSize	Conditional	Integer	Min: 1	ページングの際に表示する各ページのサイズ結果値をpageNo、pageSizeを用いてページング処理することができます。pageNoを入力する際に必ず入力します。
output	No	String		レスポンス結果のフォーマットタイプ Options：xml \| json Default : 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 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>
            <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>

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

What's Next

getCloudRedisProductList

概要
要請
レスポンス
例

タグ