vnas

package
v1.1.7-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 13, 2020 License: MIT, MIT Imports: 23 Imported by: 0

README

Go API client for vnas

VPC NAS 관련 API<br/>https://ncloud.apigw.ntruss.com/vnas/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-09-17T10:31:16Z
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.NcpGoForNcloudClientCodegen

Installation

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

"./vnas"

Documentation for API Endpoints

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

Class Method HTTP request Description
V2Api AddNasVolumeAccessControl Post /addNasVolumeAccessControl
V2Api ChangeNasVolumeSize Post /changeNasVolumeSize
V2Api CreateNasVolumeInstance Post /createNasVolumeInstance
V2Api DeleteNasVolumeInstances Post /deleteNasVolumeInstances
V2Api GetNasVolumeInstanceDetail Post /getNasVolumeInstanceDetail
V2Api GetNasVolumeInstanceList Post /getNasVolumeInstanceList
V2Api RemoveNasVolumeAccessControl Post /removeNasVolumeAccessControl
V2Api SetNasVolumeAccessControl Post /setNasVolumeAccessControl

Documentation For Models

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 vnas API v2020-09-17T10:31:16Z 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 AddNasVolumeAccessControlRequest

type AddNasVolumeAccessControlRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo"`

	// 서버인스턴스번호리스트
	ServerInstanceNoList []*string `json:"serverInstanceNoList"`
}

type AddNasVolumeAccessControlResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type ChangeNasVolumeSizeRequest

type ChangeNasVolumeSizeRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo"`

	// 볼륨사이즈
	VolumeSize *int32 `json:"volumeSize"`
}

type ChangeNasVolumeSizeResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type CommonCode

type CommonCode struct {

	// 코드
	Code *string `json:"code,omitempty"`

	// 코드명
	CodeName *string `json:"codeName,omitempty"`
}

type CreateNasVolumeInstanceRequest

type CreateNasVolumeInstanceRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// ZONE코드
	ZoneCode *string `json:"zoneCode,omitempty"`

	// 볼륨이름
	VolumeName *string `json:"volumeName,omitempty"`

	// 볼륨사이즈
	VolumeSize *int32 `json:"volumeSize"`

	// 볼륨할당프로토콜유형코드
	VolumeAllotmentProtocolTypeCode *string `json:"volumeAllotmentProtocolTypeCode"`

	// 서버인스턴스번호리스트
	ServerInstanceNoList []*string `json:"serverInstanceNoList,omitempty"`

	// CIFS유저이름
	CifsUserName *string `json:"cifsUserName,omitempty"`

	// CIFS유저비밀번호
	CifsUserPassword *string `json:"cifsUserPassword,omitempty"`

	// 볼륨암호화여부
	IsEncryptedVolume *bool `json:"isEncryptedVolume,omitempty"`

	// NAS볼륨설명
	NasVolumeDescription *string `json:"nasVolumeDescription,omitempty"`
}

type CreateNasVolumeInstanceResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type DeleteNasVolumeInstancesRequest

type DeleteNasVolumeInstancesRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호리스트
	NasVolumeInstanceNoList []*string `json:"nasVolumeInstanceNoList"`
}

type DeleteNasVolumeInstancesResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type GetNasVolumeInstanceDetailRequest

type GetNasVolumeInstanceDetailRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo"`
}

type GetNasVolumeInstanceDetailResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type GetNasVolumeInstanceListRequest

type GetNasVolumeInstanceListRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// 볼륨할당프로토콜유형코드
	VolumeAllotmentProtocolTypeCode *string `json:"volumeAllotmentProtocolTypeCode,omitempty"`

	// 이벤트설정여부
	IsEventConfiguration *bool `json:"isEventConfiguration,omitempty"`

	// 스냅샷설정여부
	IsSnapshotConfiguration *bool `json:"isSnapshotConfiguration,omitempty"`

	// NAS볼륨인스턴스번호리스트
	NasVolumeInstanceNoList []*string `json:"nasVolumeInstanceNoList,omitempty"`

	// ZONE코드
	ZoneCode *string `json:"zoneCode,omitempty"`

	// 페이지번호
	PageNo *int32 `json:"pageNo,omitempty"`

	// 페이지사이즈
	PageSize *int32 `json:"pageSize,omitempty"`

	// 볼륨이름
	VolumeName *string `json:"volumeName,omitempty"`

	// 정렬대상
	SortedBy *string `json:"sortedBy,omitempty"`

	// 정렬순서
	SortingOrder *string `json:"sortingOrder,omitempty"`
}

type GetNasVolumeInstanceListResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type NasVolumeInstance

type NasVolumeInstance struct {

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo,omitempty"`

	// NAS볼륨인스턴스상태
	NasVolumeInstanceStatus *CommonCode `json:"nasVolumeInstanceStatus,omitempty"`

	// 서버설명
	NasVolumeInstanceOperation *CommonCode `json:"nasVolumeInstanceOperation,omitempty"`

	// NAS볼륨인스턴스상태이름
	NasVolumeInstanceStatusName *string `json:"nasVolumeInstanceStatusName,omitempty"`

	// 생성일시
	CreateDate *string `json:"createDate,omitempty"`

	// NAS볼륨설명
	NasVolumeDescription *string `json:"nasVolumeDescription,omitempty"`

	// 마운트정보
	MountInformation *string `json:"mountInformation,omitempty"`

	// 볼륨할당프로토콜유형
	VolumeAllotmentProtocolType *CommonCode `json:"volumeAllotmentProtocolType,omitempty"`

	// 볼륨이름
	VolumeName *string `json:"volumeName,omitempty"`

	// 볼륨총사이즈
	VolumeTotalSize *int64 `json:"volumeTotalSize,omitempty"`

	// 볼륨사이즈
	VolumeSize *int64 `json:"volumeSize,omitempty"`

	// 볼륨사용사이즈
	VolumeUseSize *int64 `json:"volumeUseSize,omitempty"`

	// 볼륨사용사이즈비율
	VolumeUseRatio *float32 `json:"volumeUseRatio,omitempty"`

	// 스냅샷볼륨설정비율
	SnapshotVolumeConfigurationRatio *float32 `json:"snapshotVolumeConfigurationRatio,omitempty"`

	// 스냅샷볼륨설정기간유형
	SnapshotVolumeConfigPeriodType *CommonCode `json:"snapshotVolumeConfigPeriodType,omitempty"`

	// 스냅샷볼륨설정시간
	SnapshotVolumeConfigTime *int32 `json:"snapshotVolumeConfigTime,omitempty"`

	// 스냅샷볼륨사이즈
	SnapshotVolumeSize *int64 `json:"snapshotVolumeSize,omitempty"`

	// 스냅샷볼륨사용사이즈
	SnapshotVolumeUseSize *int64 `json:"snapshotVolumeUseSize,omitempty"`

	// 스냅샷볼륨사용비율
	SnapshotVolumeUseRatio *float32 `json:"snapshotVolumeUseRatio,omitempty"`

	// 스냅샷설정여부
	IsSnapshotConfiguration *bool `json:"isSnapshotConfiguration,omitempty"`

	// 이벤트설정여부
	IsEventConfiguration *bool `json:"isEventConfiguration,omitempty"`

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// ZONE코드
	ZoneCode *string `json:"zoneCode,omitempty"`

	// 초기화스크립트번호
	InitScriptNo *string `json:"initScriptNo,omitempty"`

	// NAS볼륨서버인스턴스번호리스트
	NasVolumeServerInstanceNoList []*string `json:"nasVolumeServerInstanceNoList,omitempty"`

	// 볼륨암호화여부
	IsEncryptedVolume *bool `json:"isEncryptedVolume,omitempty"`
}

type RemoveNasVolumeAccessControlRequest

type RemoveNasVolumeAccessControlRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo"`

	// 서버인스턴스번호리스트
	ServerInstanceNoList []*string `json:"serverInstanceNoList"`
}

type RemoveNasVolumeAccessControlResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type SetNasVolumeAccessControlRequest

type SetNasVolumeAccessControlRequest struct {

	// REGION코드
	RegionCode *string `json:"regionCode,omitempty"`

	// NAS볼륨인스턴스번호
	NasVolumeInstanceNo *string `json:"nasVolumeInstanceNo"`

	// 서버인스턴스번호리스트
	ServerInstanceNoList []*string `json:"serverInstanceNoList,omitempty"`
}

type SetNasVolumeAccessControlResponse

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

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

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

	TotalRows *int32 `json:"totalRows,omitempty"`

	NasVolumeInstanceList []*NasVolumeInstance `json:"nasVolumeInstanceList,omitempty"`
}

type V2ApiService

type V2ApiService service

func (*V2ApiService) AddNasVolumeAccessControl

func (a *V2ApiService) AddNasVolumeAccessControl(addNasVolumeAccessControlRequest *AddNasVolumeAccessControlRequest) (*AddNasVolumeAccessControlResponse, error)

V2ApiService NAS볼륨접근제어추가 @param addNasVolumeAccessControlRequest addNasVolumeAccessControlRequest @return *AddNasVolumeAccessControlResponse

func (*V2ApiService) ChangeNasVolumeSize

func (a *V2ApiService) ChangeNasVolumeSize(changeNasVolumeSizeRequest *ChangeNasVolumeSizeRequest) (*ChangeNasVolumeSizeResponse, error)

V2ApiService NAS볼륨사이즈변경 @param changeNasVolumeSizeRequest changeNasVolumeSizeRequest @return *ChangeNasVolumeSizeResponse

func (*V2ApiService) CreateNasVolumeInstance

func (a *V2ApiService) CreateNasVolumeInstance(createNasVolumeInstanceRequest *CreateNasVolumeInstanceRequest) (*CreateNasVolumeInstanceResponse, error)

V2ApiService NAS볼륨인스턴스생성 @param createNasVolumeInstanceRequest createNasVolumeInstanceRequest @return *CreateNasVolumeInstanceResponse

func (*V2ApiService) DeleteNasVolumeInstances

func (a *V2ApiService) DeleteNasVolumeInstances(deleteNasVolumeInstancesRequest *DeleteNasVolumeInstancesRequest) (*DeleteNasVolumeInstancesResponse, error)

V2ApiService NAS볼륨인스턴스제거 @param deleteNasVolumeInstancesRequest deleteNasVolumeInstancesRequest @return *DeleteNasVolumeInstancesResponse

func (*V2ApiService) GetNasVolumeInstanceDetail

func (a *V2ApiService) GetNasVolumeInstanceDetail(getNasVolumeInstanceDetailRequest *GetNasVolumeInstanceDetailRequest) (*GetNasVolumeInstanceDetailResponse, error)

V2ApiService NAS볼륨인스턴스상세조회 @param getNasVolumeInstanceDetailRequest getNasVolumeInstanceDetailRequest @return *GetNasVolumeInstanceDetailResponse

func (*V2ApiService) GetNasVolumeInstanceList

func (a *V2ApiService) GetNasVolumeInstanceList(getNasVolumeInstanceListRequest *GetNasVolumeInstanceListRequest) (*GetNasVolumeInstanceListResponse, error)

V2ApiService NAS볼륨인스턴스리스트조회 @param getNasVolumeInstanceListRequest getNasVolumeInstanceListRequest @return *GetNasVolumeInstanceListResponse

func (*V2ApiService) RemoveNasVolumeAccessControl

func (a *V2ApiService) RemoveNasVolumeAccessControl(removeNasVolumeAccessControlRequest *RemoveNasVolumeAccessControlRequest) (*RemoveNasVolumeAccessControlResponse, error)

V2ApiService NAS볼륨접근제어삭제 @param removeNasVolumeAccessControlRequest removeNasVolumeAccessControlRequest @return *RemoveNasVolumeAccessControlResponse

func (*V2ApiService) SetNasVolumeAccessControl

func (a *V2ApiService) SetNasVolumeAccessControl(setNasVolumeAccessControlRequest *SetNasVolumeAccessControlRequest) (*SetNasVolumeAccessControlResponse, error)

V2ApiService NAS볼륨접근제어설정 @param setNasVolumeAccessControlRequest setNasVolumeAccessControlRequest @return *SetNasVolumeAccessControlResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL