Server
    • PDF

    Server

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

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

    リクエスト

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

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

    リクエストヘッダ

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

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

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

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

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

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

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

    リクエスト例

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

    curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/classic/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' \
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    codeInteger-レスポンスステータスコード
    messageString-レスポンスステータスメッセージ
    resultObject-レスポンス結果
    result.pageSizeInteger-ページごとの項目数
    result.currentPageInteger-現在のページ番号
    result.totalPageInteger-ページの総数
    result.totalCountInteger-総項目数
    result.isPagedBoolean-ページングするかどうか
    • true | false
      • true: ページング
      • false: ページングしない
    result.serverInfosArray-サーバリスト
    • サーバ情報
    • ログ収集設定情報
    result.collectingCountInteger-ログ収集設定完了サーバ数

    serverInfos

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

    フィールドタイプ必須の有無説明
    collectingInfoObject-ログ収集設定情報
    collectingInfo.collectorAgentVersionString-ログ収集エージェントのバージョン
    collectingInfo.logTypeCountInteger-収集対象ログのタイプ数
    collectingInfo.collectionStatusString-ログ収集状態
    collectingInfo.settingStatusString-ログ収集の設定状態
    collectingInfo.settingStatusColorString-ログ収集設定状態の色表記
    collectingInfo.servernameString-ログ収集対象のサーバ名
    collectingInfo.logCollectorDateString-ログ収集の設定日時
    collectingInfo.logTypeListString-収集対象ログのタイプリスト
    collectingInfo.configKeyString-ログ収集エージェントの Install Key
    collectingInfo.isCollectingBoolean-ログ収集を有効化するかどうか
    • true | false
      • true: 有効化
      • false: 無効化
    参考

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

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

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

    レスポンス例

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

    {
        "code": 0,
        "message": "リクエストが正常に処理されました。",
        "result": {
            "pageSize": 10,
            "currentPage": 1,
            "totalPage": 1,
            "totalCount": 1,
            "isPaged": true,
            "serverInfos": [
                {
                    "servername": "s1933b2316e4",
                    "publicIp": null,
                    "osName": "CentOS 7.3 (64-bit)",
                    "createYmdt": 1731863979871,
                    "privateIp": "***.***.***.***",
                    "serverStatusCode": "INIT",
                    "serverStatusName": "CREATING",
                    "serverStatusKorean": "作成中",
                    "serverStatusValue": "作成中",
                    "serverStatusColor": "yellow",
                    "serverImageName": "centos-7.3-64",
                    "uptime": 1731863979810,
                    "message": null,
                    "occuredTime": null,
                    "logType": null,
                    "zoneNo": "3",
                    "zoneName": "KR-2",
                    "secureZoneNo": null,
                    "platformTypeCode": "LNX64",
                    "platformDetailTypeCode": "-",
                    "cpuCount": 2,
                    "osDiskType2Code": "NET",
                    "virtualNetworkInterfaceIp": null,
                    "portForwardingIp": "***.***.***.***",
                    "virtualNetworkDomainNo": "3",
                    "hostName": test,
                    "gpuCount": null,
                    "softwareProductCode": "SPSW0LINUX000046",
                    "virtualNetworkDomainName": "KR2D0003",
                    "virtualNetworkInterfaceNo": null,
                    "internalDnsHostName": null,
                    "regionName": "Korea",
                    "serverInstanceDetailTypeCode": null,
                    "operationCode": "CREAT",
                    "macAddr": "**:**:**:**:**:**",
                    "alisRaidTypeName": null,
                    "networkMonitoringYn": null,
                    "lastServerStateSyncYmdt": null,
                    "instanceProductType2Code": "STAND",
                    "accessControlGroupList": [],
                    "lastLbServerStatusSyncYmdt": null,
                    "objectMonitoringInstanceNo": null,
                    "secureZoneName": null,
                    "loginKeyName": "HJJJ",
                    "publicIpInstanceNo": null,
                    "serverInstanceTypeCode": "SVR",
                    "instanceNo": 27231808,
                    "portForwardingIpBackboneCode": "PUBLC",
                    "osDiskType2DetailCode": "SSD",
                    "feeChargingMonitoringYn": "N",
                    "regionCode": "KR",
                    "internalPort": null,
                    "productCode": "SPSVRSSD00000003",
                    "memorySize": {
                        "json.expansion@key": "json.bigdecimal",
                        "json.expansion@value": "4294967296"
                    },
                    "instanceDesc": "",
                    "regionNo": "1",
                    "isSsdStorageAddable": true,
                    "externalPort": null,
                    "baseBlockStorageSize": {
                        "json.expansion@key": "json.bigdecimal",
                        "json.expansion@value": "53687091200"
                    },
                    "backboneCode": "PUBLC",
                    "isSupportOS": false,
                    "collectingInfo": {
                        "collectorAgentVersion": 5.5.1,
                        "logTypeCount": 3,
                        "collectionStatus": "未設定",
                        "settingStatus": "設定完了",
                        "settingStatusColor": "green",
                        "servername": test,
                        "logCollectorDate": 2024-11-11 13:11:17,
                        "logTypeList": apache_error,apache_access,wineventlog,
                        "configKey": "***********",
                        "isCollecting": true
                    }
                }
            ],
            "collectingCount": 1
        }
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.