getCloudRedisTargetSubnetList

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

Cloud DB for Redisで使用可能な Subnetリストを照会します。

リクエスト

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

メソッド	URI
GET, POST	/getCloudRedisTargetSubnetList

リクエストヘッダ

Cloud DB for Redis APIで共通して使用されるヘッダの詳細は、Cloud DB for Redisの共通ヘッダをご参照ください。

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象の Subnetのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`vpcNo`	String	Required	VPC番号でフィルタリング getCloudRedisTargetVpcListを通じて確認
`cloudRedisImageProductCode`	String	Required	Cloud DB for Redisイメージ商品コードでフィルタリング getCloudRedisImageProductListを通じて確認
`isPublic`	Boolean	Optional	Public Subnetかどうかでフィルタリング `true` \| `false`
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vredis/v2/getCloudRedisTargetSubnetList
?regionCode=KR
?vpcNo=****83
?cloudRedisImageProductCode=SW.VDBAS.VRDS.LNX64.CNTOS.0708.REDIS.7015.B050'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "getCloudRedisTargetSubnetListResponse": {
        "totalRows": 3,
        "targetSubnetList": [
            {
                "subnetNo": "****91",
                "subnetName": "f**",
                "vpcNo": "****83",
                "vpcName": "te**",
                "zoneCode": "KR-1",
                "subnet": "192.168.1.0/28",
                "isPublic": false,
                "createdDate": "2024-05-28T09:44:21+0900"
            }
        ],
        "requestId": "7c37c61d-****-****-****-ae81a5bc3e9a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudRedisTargetSubnetListResponse>
    <requestId>7c37c61d-****-****-****-ae81a5bc3e9a</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetSubnetList>
        <targetSubnet>
            <subnetNo>****91</subnetNo>
            <subnetName>f**</subnetName>
            <vpcNo>39**</vpcNo>
            <vpcName>te**</vpcName>
            <zoneCode>KR-1</zoneCode>
            <subnet>192.168.1.0/28</subnet>
            <isPublic>false</isPublic>
            <createdDate>2024-05-28T09:44:21+0900</createdDate>
        </targetSubnet>
    </targetSubnetList>
</getCloudRedisTargetSubnetListResponse>

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

What's Next

getCloudRedisTargetVpcList

リクエスト
レスポンス

タグ

Cloud DB for Redis