Cloud DB for MySQL

Classic環境で利用できます。

Classic環境の Cloud DB for MySQLサーバインスタンス(VM)リストを照会します。

リクエスト

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

メソッド	URI
GET	/api/{regionCode}-v1/classic/servers/mysql

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Required	リージョンコード `kr` \| `sgn` \| `jpn` \| `uswn` \| `den` `kr`: 韓国リージョン `sgn`: シンガポールリージョン `jpn`: 日本リージョン `uswn`: 米国西部リージョン `den`: ドイツリージョン

リクエストクエリパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~100 (デフォルト: 1)
`pageSize`	Integer	Optional	ページごとの項目数 20~100 (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/classic/servers/mysql' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスステータスコード
`message`	String	-	レスポンスステータスメッセージ
`result`	Object	-	レスポンス結果
`result.pageSize`	Integer	-	ページごとの項目数
`result.currentPage`	Integer	-	現在のページ番号
`result.totalPage`	Integer	-	ページの総数
`result.totalCount`	Integer	-	総項目数
`result.isPaged`	Boolean	-	ページングするかどうか `true` \| `false` `true`: ページング `false`: ページングしない
`result.dbServers`	Array	-	サーバリストサーバ情報

参考

Server情報関連フィールド(dbServers)の詳細は、Cloud DB for MySQL APIガイドとCloud DB for MySQLご利用ガイドをご参照ください。

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

Cloud Log Analytics APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Log Analyticsのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "code": 0,
  "message": "リクエストが正常に処理されました",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 1,
    "totalCount": 2,
    "isPaged": true,
    "dbServers": [
      {
        "standbyMasterServerName": null,
        "dbServerName": "cla-test-001-1shh",
        "databaseProductCode": null,
        "db_svr_rank": 0,
        "cloudDbServiceName": "clatest",
        "dataStorageTypeCode": null,
        "dataStorageSize": 10,
        "dataStorageSizeStr": "10GB",
        "dbInstanceNo": 0,
        "memorySize": "8GB",
        "dbStatusName": null,
        "clusterStatusName": null,
        "serverInstanceNo": 0,
        "dbServerIpAddress": null,
        "cpuCount": 2,
        "roleCode": null,
        "dbServerRoleCode": null,
        "dbServerType": "[Standard] 2vCPU, 8GB Mem",
        "usedDataStorageSize": 0,
        "uuid": "*-***-****-***-****",
        "dbStatusNameValue": "creating",
        "dbStatusNameColor": "yellow",
        "dbServerRoleValue": "Master",
        "zoneNo": null,
        "zoneName": null
      },
      {
        "standbyMasterServerName": null,
        "dbServerName": "cla-test-002-1shi",
        "databaseProductCode": null,
        "db_svr_rank": 0,
        "cloudDbServiceName": "clatest",
        "dataStorageTypeCode": null,
        "dataStorageSize": 10,
        "dataStorageSizeStr": "10GB",
        "dbInstanceNo": 0,
        "memorySize": "8GB",
        "dbStatusName": null,
        "clusterStatusName": null,
        "serverInstanceNo": 0,
        "dbServerIpAddress": null,
        "cpuCount": 2,
        "roleCode": null,
        "dbServerRoleCode": null,
        "dbServerType": "[Standard] 2vCPU, 8GB Mem",
        "usedDataStorageSize": 0,
        "uuid": "*-***-****-***-****",
        "dbStatusNameValue": "creating",
        "dbStatusNameColor": "yellow",
        "dbServerRoleValue": "Standby Master",
        "zoneNo": null,
        "zoneName": null
      }
    ]
  }
}