getCloudMysqlTargetSubnetList

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET, POST	/getCloudMysqlTargetSubnetList

リクエストヘッダ

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

リクエストパラメータ

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlTargetSubnetList
?regionCode=KR
&vpcNo=****83
&cloudMysqlImageProductCode=SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8018.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の場合

{
    "getCloudMysqlTargetSubnetListResponse": {
        "totalRows": 3,
        "targetSubnetList": [
            {
                "subnetNo": "****91",
                "subnetName": "test-***",
                "vpcNo": "****83",
                "vpcName": "test-***",
                "zoneCode": "KR-1",
                "subnet": "192.168.*.0/28",
                "isPublic": true,
                "createdDate": "2024-06-03T08:53:40+0900"
            },
            {
                "subnetNo": "****93",
                "subnetName": "test-***",
                "vpcNo": "****83",
                "vpcName": "test-***",
                "zoneCode": "KR-2",
                "subnet": "192.168.*.0/24",
                "isPublic": true,
                "createdDate": "2022-03-30T10:01:13+0900"
            }
        ],
        "requestId": "b9cf9a98-****-****-****-ba0d20cf0567",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlTargetSubnetListResponse>
    <requestId>b9cf9a98-****-****-****-ba0d20cf0567</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>3</totalRows>
    <targetSubnetList>
        <targetSubnet>
            <subnetNo>****83</subnetNo>
            <subnetName>test-***</subnetName>
            <vpcNo>****83</vpcNo>
            <vpcName>test-***</vpcName>
            <zoneCode>KR-1</zoneCode>
            <subnet>192.168.*.0/28</subnet>
            <isPublic>true</isPublic>
            <createdDate>2024-06-03T08:53:40+0900</createdDate>
        </targetSubnet>
        <targetSubnet>
            <subnetNo>****93</subnetNo>
            <subnetName>test-***</subnetName>
            <vpcNo>****83</vpcNo>
            <vpcName>test-***</vpcName>
            <zoneCode>KR-2</zoneCode>
            <subnet>192.168.*.0/24</subnet>
            <isPublic>true</isPublic>
            <createdDate>2022-03-30T10:01:13+0900</createdDate>
        </targetSubnet>
    </targetSubnetList>
</getCloudMysqlTargetSubnetListResponse>

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

What's Next

getCloudMysqlTargetVpcList

リクエスト
レスポンス

タグ

Cloud DB for MySQL