monitoring

README

Go API client for monitoring

<br/>https://ncloud.apigw.ntruss.com/monitoring/v2

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

• API version: 2020-05-22T09:10:03Z
• Package version: 1.1.4
• Build package: io.swagger.codegen.languages.NcpGoForNcloudClientCodegen

Installation

Put the package under your project folder and add the following in import:

"./monitoring"

Documentation for API Endpoints

All URIs are relative to https://ncloud.apigw.ntruss.com/monitoring/v2

Class	Method	HTTP request	Description
V2Api	GetListMetrics	Post /getListMetrics
V2Api	GetMetricStatisticList	Post /getMetricStatisticList

Documentation For Models

• DataPoint
• GetListMetricsRequest
• GetListMetricsResponse
• GetMetricStatisticListRequest
• GetMetricStatisticListResponse
• Metric
• MetricData
• MetricStatistic

Documentation

Index

• func CacheExpires(r *http.Response) time.Time
• func NewConfiguration(apiKey *ncloud.APIKey) *ncloud.Configuration
• type APIClient
  • func NewAPIClient(cfg *ncloud.Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type DataPoint
• type GetListMetricsRequest
• type GetListMetricsResponse
• type GetMetricStatisticListRequest
• type GetMetricStatisticListResponse
• type Metric
• type MetricData
• type MetricStatistic
• type V2ApiService
  • func (a *V2ApiService) GetListMetrics(getListMetricsRequest *GetListMetricsRequest) (*GetListMetricsResponse, error)
  • func (a *V2ApiService) GetMetricStatisticList(getMetricStatisticListRequest *GetMetricStatisticListRequest) (*GetMetricStatisticListResponse, error)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func NewConfiguration

func NewConfiguration(apiKey *ncloud.APIKey) *ncloud.Configuration

Types

type APIClient

type APIClient struct {

	// API Services
	V2Api *V2ApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the monitoring API v2020-05-22T09:10:03Z In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *ncloud.Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type DataPoint

type DataPoint struct {
	Timestamp *string `json:"timestamp,omitempty"`

	Average *float64 `json:"average,omitempty"`

	Unit *string `json:"unit,omitempty"`
}

type GetListMetricsRequest

type GetListMetricsRequest struct {

	// (서버)인스턴스번호
	InstanceNo *string `json:"instanceNo"`

	// 메트릭이름
	MetricName *string `json:"metricName,omitempty"`
}

type GetListMetricsResponse

type GetListMetricsResponse struct {
	RequestId *string `json:"requestId,omitempty"`

	ReturnCode *string `json:"returnCode,omitempty"`

	ReturnMessage *string `json:"returnMessage,omitempty"`

	Metrics []*Metric `json:"metrics,omitempty"`
}

type GetMetricStatisticListRequest

type GetMetricStatisticListRequest struct {

	// (서버)인스턴스번호리스트
	InstanceNoList []*string `json:"instanceNoList"`

	// 메트릭이름리스트
	MetricName *string `json:"metricName"`

	// 조회시작일시
	StartTime *string `json:"startTime"`

	// 조회종료일시
	EndTime *string `json:"endTime"`

	// 조회주기(초)
	Period *int32 `json:"period"`
}

type GetMetricStatisticListResponse

type GetMetricStatisticListResponse struct {
	RequestId *string `json:"requestId,omitempty"`

	ReturnCode *string `json:"returnCode,omitempty"`

	ReturnMessage *string `json:"returnMessage,omitempty"`

	MetricStatisticList []*MetricStatistic `json:"metricStatisticList,omitempty"`
}

type Metric

type Metric struct {
	InstanceNo *string `json:"instanceNo,omitempty"`

	MetricName *string `json:"metricName,omitempty"`
}

type MetricData

type MetricData struct {
	Label *string `json:"label,omitempty"`

	Average *float64 `json:"average,omitempty"`

	Maximum *float64 `json:"maximum,omitempty"`

	Minimum *float64 `json:"minimum,omitempty"`

	Sum *float64 `json:"sum,omitempty"`

	DataPointList []*DataPoint `json:"dataPointList,omitempty"`
}

type MetricStatistic

type MetricStatistic struct {
	InstanceNo *string `json:"instanceNo,omitempty"`

	MetricDataList []*MetricData `json:"metricDataList,omitempty"`
}

type V2ApiService

type V2ApiService service

func (*V2ApiService) GetListMetrics

func (a *V2ApiService) GetListMetrics(getListMetricsRequest *GetListMetricsRequest) (*GetListMetricsResponse, error)

V2ApiService B.메트릭 리스트 조회 @param getListMetricsRequest getListMetricsRequest @return *GetListMetricsResponse

func (*V2ApiService) GetMetricStatisticList

func (a *V2ApiService) GetMetricStatisticList(getMetricStatisticListRequest *GetMetricStatisticListRequest) (*GetMetricStatisticListResponse, error)

V2ApiService A.메트릭 통계 조회 @param getMetricStatisticListRequest getMetricStatisticListRequest @return *GetMetricStatisticListResponse