getCloudMysqlDatabaseList

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET, POST	/getCloudMysqlDatabaseList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード照会対象の Cloud DB for MySQLインスタンスのリージョンコード getRegionListを通じて確認 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudMysqlInstanceNo`	String	Required	Cloud DB for MySQLインスタンス番号 getCloudMysqlInstanceListを通じて確認
`pageNo`	Integer	Required	ページングされた結果のページ番号 `pageNo`、`pageSize`を利用してページング処理 0 (最小)
`pageSize`	Integer	Required	ページごとに表示する結果数 `pageNo`、`pageSize`を利用してページング処理 1 (最小)
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlDatabaseList
?regionCode=KR
&cloudMysqlInstanceNo=****890
&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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

responseFormatType=jsonの場合

{
    "getCloudMysqlDatabaseListResponse": {
        "totalRows": 2,
        "cloudMysqlDatabaseList": [
            {
                "databaseName": "mysql_test"
            },
            {
                "databaseName": "test-****"
            }
        ],
        "requestId": "36cc2f85-****-****-****-5d2511df4e45",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlDatabaseListResponse>
    <requestId>36cc2f85-****-****-****-5d2511df4e45</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMysqlDatabaseList>
        <cloudMysqlDatabase>
            <databaseName>mysql_test</databaseName>
        </cloudMysqlDatabase>
        <cloudMysqlDatabase>
            <databaseName>test-****</databaseName>
        </cloudMysqlDatabase>
    </cloudMysqlDatabaseList>
</getCloudMysqlDatabaseListResponse>

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

What's Next

getCloudMysqlEventHistoryList

リクエスト
レスポンス

タグ

Cloud DB for MySQL