Server

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

VPC環境のサーバインスタンス(VM)リストを照会し、サーバ別 Cloud Log Analyticsサービスを利用したログ収集の設定状態を確認します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/vpc/servers' \
--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.vpcServerInfos`	Array	-	サーバリストサーバ情報ログ収集設定情報
`result.collectingCount`	Integer	-	ログ収集設定完了サーバ数

`vpcServerInfos`

vpcServerInfosの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`additionalParameterMap`	Object	-	サーバ情報
`collectingInfo`	Object	-	ログ収集設定情報
`collectingInfo.collectorAgentVersion`	String	-	ログ収集エージェントのバージョン
`collectingInfo.logTypeCount`	Integer	-	収集対象ログのタイプ数
`collectingInfo.collectionStatus`	String	-	ログ収集状態
`collectingInfo.settingStatus`	String	-	ログ収集の設定状態
`collectingInfo.settingStatusColor`	String	-	ログ収集設定状態の色表記
`collectingInfo.servername`	String	-	ログ収集対象のサーバ名
`collectingInfo.logCollectorDate`	String	-	ログ収集の設定日時
`collectingInfo.logTypeList`	String	-	収集対象ログのタイプリスト
`collectingInfo.configKey`	String	-	ログ収集エージェントの Install Key
`collectingInfo.isCollecting`	Boolean	-	ログ収集を有効化するかどうか `true` \| `false` `true`: 有効化 `false`: 無効化

参考

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

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

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

レスポンス例

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

{
    "code": 0,
    "message": "リクエストが正常に処理されました。",
    "result": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPage": 1,
        "totalCount": 2,
        "isPaged": true,
        "vpcServerInfos": [
            {
                "additionalParameterMap": {
                    "networkInterfaceList": [
                        {
                            "vpcNo": 77778,
                            "vpcName": "test",
                            "subnetNo": 177781,
                            "subnetName": "mgmt-subnet",
                            "subnet": "***.***.***.***/**",
                            "igwYn": "Y",
                            "zoneNo": 2,
                            "zoneName": "KR-1",
                            "networkInterfaceNo": 4352109,
                            "networkInterfaceName": "nic-4352109",
                            "internalIp": "***.***.***.***",
                            "macAddress": "**:**:**:**:**:**",
                            "attachedDeviceName": "eth0",
                            "secondaryIps": [
                                null
                            ]
                        }
                    ],
                    "igwYn": "Y",
                    "vpcName": "test",
                    "vpcNo": 77778,
                    "subnetName": "mgmt-subnet",
                    "subnetNo": 177781
                },
                "baseBlockStorageSize": null,
                "carrierNetworkIp": "***.***.***.***",
                "computeInstanceDetailTypeCode": null,
                "computeInstanceName": "s19293f45ef5",
                "computeInstanceTypeCode": "VSVR",
                "computeInstanceUuid": null,
                "computeSpec": "vCPU 2EA, Memory 8GB, Disk 50GB",
                "contractNo": 17792786,
                "cpuCount": 2,
                "createYmdt": 1729059121967,
                "hostNameInitConfigYn": null,
                "instanceNo": 27057139,
                "instanceProductType2Code": "STAND",
                "instanceStatusCode": "RUN",
                "instanceStatusName": "running",
                "instanceTypeCode": "VSVR",
                "ip": null,
                "launchDateTime": 1729059320699,
                "macAddress": null,
                "nsiName": "centos-7.3-64",
                "operationCode": "NULL",
                "operationYmdt": "1729059320699",
                "osDiskTypeCode": "NET",
                "osDiskTypeDetailCode": "HDD",
                "osInformation": "CentOS 7.3 (64-bit)",
                "osName": "CentOS 7.3 (64-bit)",
                "overlayNetworkIp": "172.16.1.7",
                "parameters": null,
                "platformTypeCode": "LNX64",
                "productCode": "SVR.VSVR.STAND.C002.M008.NET.HDD.B050.G002",
                "publicIp": null,
                "publicIpInstanceNo": null,
                "regionCode": "KR",
                "regionName": "Korea",
                "serverName": "s19293f45ef5",
                "serverSpec": "vCPU 2EA, Memory 8GB, Disk 50GB",
                "softwareProductCode": "SW.VSVR.OS.LNX64.CNTOS.0703.B050",
                "subnetName": null,
                "subAccountNo": null,
                "upTime": null,
                "vpcName": null,
                "zoneName": "KR-1",
                "zoneNo": 2,
                "serverStatusColor": "green",
                "serverStatusKorean": "実行中",
                "serverStatusValue": "実行中",
                "isSupportOS": true,
                "collectingInfo": {
                    "collectorAgentVersion": "7.17.2",
                    "logTypeCount": 5,
                    "collectionStatus": "未設定",
                    "settingStatus": "設定完了",
                    "settingStatusColor": "green",
                    "servername": "s19293f45ef5",
                    "logCollectorDate": "2024-11-08 22:30:57",
                    "logTypeList": "tomcat_catalina,SYSLOG,security_log,apache_access,apache_error",
                    "configKey": "***********",
                    "isCollecting": true
                }
            },
            {
                "additionalParameterMap": {
                    "networkInterfaceList": [
                        {
                            "vpcNo": 77778,
                            "vpcName": "test",
                            "subnetNo": 177781,
                            "subnetName": "mgmt-subnet",
                            "subnet": "***.***.***.***/**",
                            "igwYn": "Y",
                            "zoneNo": 2,
                            "zoneName": "KR-1",
                            "networkInterfaceNo": 4352038,
                            "networkInterfaceName": "nic-4352038",
                            "internalIp": "***.***.***.***",
                            "macAddress": "**:**:**:**:**:**",
                            "attachedDeviceName": "eth0",
                            "secondaryIps": [
                                null
                            ]
                        }
                    ],
                    "igwYn": "Y",
                    "vpcName": "test",
                    "vpcNo": 77778,
                    "subnetName": "mgmt-subnet",
                    "subnetNo": 177781
                },
                "baseBlockStorageSize": null,
                "carrierNetworkIp": "***.***.***.***",
                "computeInstanceDetailTypeCode": null,
                "computeInstanceName": "s19293c276d5",
                "computeInstanceTypeCode": "VSVR",
                "computeInstanceUuid": null,
                "computeSpec": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "contractNo": 17792417,
                "cpuCount": 2,
                "createYmdt": 1729055851701,
                "hostNameInitConfigYn": null,
                "instanceNo": 27056413,
                "instanceProductType2Code": "STAND",
                "instanceStatusCode": "RUN",
                "instanceStatusName": "running",
                "instanceTypeCode": "VSVR",
                "ip": null,
                "launchDateTime": 1729056060600,
                "macAddress": null,
                "nsiName": "centos-7.3-64",
                "operationCode": "NULL",
                "operationYmdt": "1729056060600",
                "osDiskTypeCode": "NET",
                "osDiskTypeDetailCode": "SSD",
                "osInformation": "CentOS 7.3 (64-bit)",
                "osName": "CentOS 7.3 (64-bit)",
                "overlayNetworkIp": "172.16.1.6",
                "parameters": null,
                "platformTypeCode": "LNX64",
                "productCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
                "publicIp": null,
                "publicIpInstanceNo": null,
                "regionCode": "KR",
                "regionName": "Korea",
                "serverName": "s19293c276d5",
                "serverSpec": "vCPU 2EA, Memory 8GB, [SSD]Disk 50GB",
                "softwareProductCode": "SW.VSVR.OS.LNX64.CNTOS.0703.B050",
                "subnetName": null,
                "subAccountNo": null,
                "upTime": null,
                "vpcName": null,
                "zoneName": "KR-1",
                "zoneNo": 2,
                "serverStatusColor": "green",
                "serverStatusKorean": "実行中",
                "serverStatusValue": "実行中",
                "isSupportOS": true,
                "collectingInfo": {
                    "collectorAgentVersion": "7.17.2",
                    "logTypeCount": 8,
                    "collectionStatus": "未設定",
                    "settingStatus": "設定完了",
                    "settingStatusColor": "green",
                    "servername": "s19293c276d5",
                    "logCollectorDate": "2024-11-17 23:27:09",
                    "logTypeList": "apache_access,apache_error,cdb_mysql_audit,mysql_error,mysql_slow,security_log,SYSLOG,tomcat_catalina",
                    "configKey": "***********",
                    "isCollecting": true
                }
            }
        ],
        "collectingCount": 0
    }
}

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

What's Next

Cloud DB for MySQL

リクエスト
レスポンス