Go API client for openapi

API of the JuiceFS console (https://juicefs.com/api/v1)

Overview

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

• API version: 0.0.1
• Package version: 1.0.0
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://juicefs.com/contact

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to /api/v1

Class	Method	HTTP request	Description
CloudAPI	CloudsCloudIDGet	Get /clouds/{cloudID}
CloudAPI	CloudsGet	Get /clouds
InstanceAPI	MetadatasMetadataIDInstancesGet	Get /metadatas/{metadataID}/instances	Get instance list
InstanceAPI	MetadatasMetadataIDInstancesInstanceIDGet	Get /metadatas/{metadataID}/instances/{instanceID}	Get instance by ID
InstanceAPI	MetadatasMetadataIDInstancesInstanceIDPatch	Patch /metadatas/{metadataID}/instances/{instanceID}	Update instance properties
MetadataAPI	MetadataDnsGet	Get /metadata-dns	Resolve domain name
MetadataAPI	MetadatasGet	Get /metadatas	Get metadata list
MetadataAPI	MetadatasMetadataIDGet	Get /metadatas/{metadataID}	Get metadata by ID
MetadataAPI	MetadatasMetadataIDLicenseGet	Get /metadatas/{metadataID}/license	Get current license
MetadataAPI	MetadatasMetadataIDLicensePut	Put /metadatas/{metadataID}/license	Set license
NodeAPI	NodesGet	Get /nodes	Get node list
NodeAPI	NodesNodeIDGet	Get /nodes/{nodeID}	Get node by ID
NodeAPI	NodesNodeIDPatch	Patch /nodes/{nodeID}
NodeAPI	NodesNodeIDPut	Put /nodes/{nodeID}	Update node by ID
RegionAPI	RegionsGet	Get /regions	Get region list
RegionAPI	RegionsRegionIDGet	Get /regions/{regionID}	Get region by ID
RegionAPI	RegionsRegionIDMetricsGet	Get /regions/{regionID}/metrics	Get region metrics
RegionAPI	RegionsRegionIDTrashtimeGet	Get /regions/{regionID}/trashtime
RegionAPI	RegionsRegionIDTrashtimePut	Put /regions/{regionID}/trashtime	Set region trashtime(days)
VolumeAPI	VolumesGet	Get /volumes	Get volume list
VolumeAPI	VolumesPost	Post /volumes
VolumeAPI	VolumesVolumeIDClientsGet	Get /volumes/{volumeID}/clients	Get mounted clients
VolumeAPI	VolumesVolumeIDDelete	Delete /volumes/{volumeID}
VolumeAPI	VolumesVolumeIDGet	Get /volumes/{volumeID}
VolumeAPI	VolumesVolumeIDIsReadyGet	Get /volumes/{volumeID}/is_ready	Volume has been ready or not
VolumeAPI	VolumesVolumeIDKerberosGet	Get /volumes/{volumeID}/kerberos
VolumeAPI	VolumesVolumeIDKerberosPatch	Patch /volumes/{volumeID}/kerberos
VolumeAPI	VolumesVolumeIDListDirGet	Get /volumes/{volumeID}/listDir	List directory
VolumeAPI	VolumesVolumeIDMetricsGet	Get /volumes/{volumeID}/metrics	Get volume metrics
VolumeAPI	VolumesVolumeIDMirrorsGet	Get /volumes/{volumeID}/mirrors
VolumeAPI	VolumesVolumeIDMirrorsPost	Post /volumes/{volumeID}/mirrors
VolumeAPI	VolumesVolumeIDRangerGet	Get /volumes/{volumeID}/ranger
VolumeAPI	VolumesVolumeIDRangerPatch	Patch /volumes/{volumeID}/ranger
VolumeAPI	VolumesVolumeIDSettingGet	Get /volumes/{volumeID}/setting
VolumeAPI	VolumesVolumeIDSettingPost	Post /volumes/{volumeID}/setting
VolumeACLAPI	VolumesVolumeIDExportsGet	Get /volumes/{volumeID}/exports	Get ACL list
VolumeACLAPI	VolumesVolumeIDExportsPost	Post /volumes/{volumeID}/exports	Create ACL
VolumeACLAPI	VolumesVolumeIDExportsVolumeExportIDDelete	Delete /volumes/{volumeID}/exports/{volumeExportID}	Delete ACL
VolumeACLAPI	VolumesVolumeIDExportsVolumeExportIDGet	Get /volumes/{volumeID}/exports/{volumeExportID}	Get ACL by ID
VolumeACLAPI	VolumesVolumeIDExportsVolumeExportIDPut	Put /volumes/{volumeID}/exports/{volumeExportID}	Update ACL by ID
VolumeQuotaAPI	VolumesVolumeIDQuotasGet	Get /volumes/{volumeID}/quotas	Get quota list
VolumeQuotaAPI	VolumesVolumeIDQuotasPost	Post /volumes/{volumeID}/quotas	Set quota
VolumeQuotaAPI	VolumesVolumeIDQuotasVolumeQuotaIDDelete	Delete /volumes/{volumeID}/quotas/{volumeQuotaID}
VolumeQuotaAPI	VolumesVolumeIDQuotasVolumeQuotaIDGet	Get /volumes/{volumeID}/quotas/{volumeQuotaID}
VolumeQuotaAPI	VolumesVolumeIDQuotasVolumeQuotaIDPut	Put /volumes/{volumeID}/quotas/{volumeQuotaID}	Update quota by ID
VolumeTrashAPI	VolumesVolumeIDDeleteTrashPost	Post /volumes/{volumeID}/deleteTrash	Delete from trash
VolumeTrashAPI	VolumesVolumeIDEmptyTrashPost	Post /volumes/{volumeID}/emptyTrash	Empty trash asynchronously
VolumeTrashAPI	VolumesVolumeIDListTrashGet	Get /volumes/{volumeID}/listTrash	List trash files
VolumeTrashAPI	VolumesVolumeIDRestoreFilePost	Post /volumes/{volumeID}/restoreFile	Restore from trash

Documentation For Models

• Cloud
• CreateMirrorVolume
• CreateVolumeQuota
• FileInfo
• GettableVolume
• GettableVolumeAllOfAccessRules
• GettableVolumeExport
• GettableVolumeQuota
• Inodes
• Metadata
• MetadataDnsGet200Response
• MetadataInstance
• MetadataInstanceConfig
• MetadataLicense
• MirrorVolume
• Node
• PostableVolume
• PostableVolumeExport
• Region
• TrashTime
• UpdateVolumeQuota
• Volume
• VolumeClient
• VolumeKerberos
• VolumeKerberosProxy
• VolumeRanger
• VolumesVolumeIDGet404Response
• VolumesVolumeIDIsReadyGet200Response
• VolumesVolumeIDListDirGet400Response
• VolumesVolumeIDListTrashGet200Response
• VolumesVolumeIDListTrashGet200ResponseFilesInner
• VolumesVolumeIDListTrashGet400Response
• VolumesVolumeIDQuotasVolumeQuotaIDPut400Response

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]