common

package
v0.0.0-...-6869780 Latest Latest
Warning

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

 Go to latest Published: May 30, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	HTTP_PROTOCOL  = "http"
	HTTPS_PROTOCOL = "https"
)
View Source 
const (
	Hangzhou    = Region("cn-hangzhou")
	Qingdao     = Region("cn-qingdao")
	Beijing     = Region("cn-beijing")
	Hongkong    = Region("cn-hongkong")
	Shenzhen    = Region("cn-shenzhen")
	Shanghai    = Region("cn-shanghai")
	Zhangjiakou = Region("cn-zhangjiakou")
	Huhehaote   = Region("cn-huhehaote")

	APSouthEast1 = Region("ap-southeast-1")
	APNorthEast1 = Region("ap-northeast-1")
	APSouthEast2 = Region("ap-southeast-2")
	APSouthEast3 = Region("ap-southeast-3")

	USWest1 = Region("us-west-1")
	USEast1 = Region("us-east-1")

	MEEast1 = Region("me-east-1")

	EUCentral1 = Region("eu-central-1")

	ShenZhenFinance = Region("cn-shenzhen-finance-1")
	ShanghaiFinance = Region("cn-shanghai-finance-1")
)

Constants of region definition

View Source 
const (
	SignatureVersion   = "1.0"
	SignatureMethod    = "HMAC-SHA1"
	JSONResponseFormat = "JSON"
	XMLResponseFormat  = "XML"
	ECSRequestMethod   = "GET"
)

Constants for Aliyun API requests

View Source 
const (
	PayByBandwidth = InternetChargeType("PayByBandwidth")
	PayByTraffic   = InternetChargeType("PayByTraffic")
)
View Source 
const (
	PrePaid  = InstanceChargeType("PrePaid")
	PostPaid = InstanceChargeType("PostPaid")
)
View Source 
const (
	Internet = NetType("Internet")
	Intranet = NetType("Intranet")
)
View Source 
const (
	Hour  = TimeType("Hour")
	Day   = TimeType("Day")
	Week  = TimeType("Week")
	Month = TimeType("Month")
	Year  = TimeType("Year")
)
View Source 
const (
	Classic = NetworkType("Classic")
	VPC     = NetworkType("VPC")
)
View Source 
const Version = "0.1"

Variables

View Source 
var (
	SpecailEnpoints = map[Region]map[string]string{
		APNorthEast1: {
			"ecs": "https://ecs.ap-northeast-1.aliyuncs.com",
			"slb": "https://slb.ap-northeast-1.aliyuncs.com",
			"rds": "https://rds.ap-northeast-1.aliyuncs.com",
			"vpc": "https://vpc.ap-northeast-1.aliyuncs.com",
		},
		APSouthEast2: {
			"ecs": "https://ecs.ap-southeast-2.aliyuncs.com",
			"slb": "https://slb.ap-southeast-2.aliyuncs.com",
			"rds": "https://rds.ap-southeast-2.aliyuncs.com",
			"vpc": "https://vpc.ap-southeast-2.aliyuncs.com",
		},
		APSouthEast3: {
			"ecs": "https://ecs.ap-southeast-3.aliyuncs.com",
			"slb": "https://slb.ap-southeast-3.aliyuncs.com",
			"rds": "https://rds.ap-southeast-3.aliyuncs.com",
			"vpc": "https://vpc.ap-southeast-3.aliyuncs.com",
		},
		MEEast1: {
			"ecs": "https://ecs.me-east-1.aliyuncs.com",
			"slb": "https://slb.me-east-1.aliyuncs.com",
			"rds": "https://rds.me-east-1.aliyuncs.com",
			"vpc": "https://vpc.me-east-1.aliyuncs.com",
		},
		EUCentral1: {
			"ecs": "https://ecs.eu-central-1.aliyuncs.com",
			"slb": "https://slb.eu-central-1.aliyuncs.com",
			"rds": "https://rds.eu-central-1.aliyuncs.com",
			"vpc": "https://vpc.eu-central-1.aliyuncs.com",
		},
		Zhangjiakou: {
			"ecs": "https://ecs.cn-zhangjiakou.aliyuncs.com",
			"slb": "https://slb.cn-zhangjiakou.aliyuncs.com",
			"rds": "https://rds.cn-zhangjiakou.aliyuncs.com",
			"vpc": "https://vpc.cn-zhangjiakou.aliyuncs.com",
		},
		Huhehaote: {
			"ecs": "https://ecs.cn-huhehaote.aliyuncs.com",
			"slb": "https://slb.cn-huhehaote.aliyuncs.com",
			"rds": "https://rds.cn-huhehaote.aliyuncs.com",
			"vpc": "https://vpc.cn-huhehaote.aliyuncs.com",
		},
	}
)
View Source 
var ValidRegions = []Region{
	Hangzhou, Qingdao, Beijing, Shenzhen, Hongkong, Shanghai, Zhangjiakou, Huhehaote,
	USWest1, USEast1,
	APNorthEast1, APSouthEast1, APSouthEast2, APSouthEast3,
	MEEast1,
	EUCentral1,
	ShenZhenFinance, ShanghaiFinance,
}

Functions

func GetClientError 

func GetClientError(err error) error

func GetClientErrorFromString 

func GetClientErrorFromString(str string) error

Types

type APIEndpoints 

type APIEndpoints struct {
	Endpoint []EndpointItem
}

type BusinessInfo 

type BusinessInfo struct {
	Pack       string `json:"pack,omitempty"`
	ActivityId string `json:"activityId,omitempty"`
}

type Client 

type Client struct {
	AccessKeyId     string //Access Key Id
	AccessKeySecret string //Access Key Secret
	// contains filtered or unexported fields
}

A Client represents a client of ECS services

func (*Client) GenerateClientToken 

func (client *Client) GenerateClientToken() string

GenerateClientToken generates the Client Token with random string

func (*Client) Init 

func (client *Client) Init(endpoint, version, accessKeyId, accessKeySecret string)

Initialize properties of a client instance

func (*Client) InitClient 

func (client *Client) InitClient() *Client

Intialize client object when all properties are ready

func (*Client) Invoke 

func (client *Client) Invoke(action string, args interface{}, response interface{}) error

Invoke sends the raw HTTP request for ECS services

func (*Client) InvokeByAnyMethod 

func (client *Client) InvokeByAnyMethod(method, action, path string, args interface{}, response interface{}) error

Invoke sends the raw HTTP request for ECS services 改进了一下上面那个方法，可以使用各种Http方法 2017.1.30 增加了一个path参数，用来拓展访问的地址

func (*Client) InvokeByFlattenMethod 

func (client *Client) InvokeByFlattenMethod(action string, args interface{}, response interface{}) error

Invoke sends the raw HTTP request for ECS services

func (*Client) NewInit 

func (client *Client) NewInit(endpoint, version, accessKeyId, accessKeySecret, serviceCode string, regionID Region)

Initialize properties of a client instance including regionID

func (*Client) NewInitForAssumeRole 

func (client *Client) NewInitForAssumeRole(endpoint, version, accessKeyId, accessKeySecret, serviceCode string, regionID Region, securityToken string)

func (*Client) SetAccessKeyId 

func (client *Client) SetAccessKeyId(id string)

SetAccessKeyId sets new AccessKeyId

func (*Client) SetAccessKeySecret 

func (client *Client) SetAccessKeySecret(secret string)

SetAccessKeySecret sets new AccessKeySecret

func (*Client) SetBusinessInfo 

func (client *Client) SetBusinessInfo(businessInfo string)

SetBusinessInfo sets business info to log the request/response message

func (*Client) SetDebug 

func (client *Client) SetDebug(debug bool)

SetDebug sets debug mode to log the request/response message

func (*Client) SetEndpoint 

func (client *Client) SetEndpoint(endpoint string)

SetEndpoint sets custom endpoint

func (*Client) SetHTTPDoHook 

func (client *Client) SetHTTPDoHook(hook HTTPDoHook)

SetHTTPDoHook ...

func (*Client) SetRegionID 

func (client *Client) SetRegionID(regionID Region)

SetEndpoint sets Region ID

func (*Client) SetSecurityToken 

func (client *Client) SetSecurityToken(securityToken string)

set SecurityToken

func (*Client) SetServiceCode 

func (client *Client) SetServiceCode(serviceCode string)

SetServiceCode sets serviceCode

func (*Client) SetUserAgent 

func (client *Client) SetUserAgent(userAgent string)

SetUserAgent sets user agent to the request/response message

func (*Client) SetVersion 

func (client *Client) SetVersion(version string)

SetEndpoint sets custom version

func (*Client) WithAccessKeyId 

func (client *Client) WithAccessKeyId(id string) *Client

WithAccessKeyId sets new AccessKeyId

func (*Client) WithAccessKeySecret 

func (client *Client) WithAccessKeySecret(secret string) *Client

WithAccessKeySecret sets new AccessKeySecret

func (*Client) WithBusinessInfo 

func (client *Client) WithBusinessInfo(businessInfo string) *Client

WithBusinessInfo sets business info to log the request/response message

func (*Client) WithDebug 

func (client *Client) WithDebug(debug bool) *Client

WithDebug sets debug mode to log the request/response message

func (*Client) WithEndpoint 

func (client *Client) WithEndpoint(endpoint string) *Client

WithEndpoint sets custom endpoint

func (*Client) WithHTTPDoHook 

func (client *Client) WithHTTPDoHook(hook HTTPDoHook) *Client

WithHTTPDoHook sets httpDoHook

func (*Client) WithRegionID 

func (client *Client) WithRegionID(regionID Region) *Client

WithRegionID sets Region ID

func (*Client) WithSecurityToken 

func (client *Client) WithSecurityToken(securityToken string) *Client

WithSecurityToken sets securityToken

func (*Client) WithServiceCode 

func (client *Client) WithServiceCode(serviceCode string) *Client

WithServiceCode sets serviceCode

func (*Client) WithUserAgent 

func (client *Client) WithUserAgent(userAgent string) *Client

WithUserAgent sets user agent to the request/response message

func (*Client) WithVersion 

func (client *Client) WithVersion(version string) *Client

WithVersion sets custom version

type DescribeEndpointArgs 

type DescribeEndpointArgs struct {
	Id          Region
	ServiceCode string
	Type        string
}

type DescribeEndpointResponse 

type DescribeEndpointResponse struct {
	Response
	EndpointItem
}

type DescribeEndpointsArgs 

type DescribeEndpointsArgs struct {
	Id          Region
	ServiceCode string
	Type        string
}

type DescribeEndpointsResponse 

type DescribeEndpointsResponse struct {
	Response
	Endpoints APIEndpoints
	RequestId string
	Success   bool
}

type Endpoint 

type Endpoint struct {
	Name      string    `xml:"name,attr"`
	RegionIds RegionIds `xml:"RegionIds"`
	Products  Products  `xml:"Products"`
}

type EndpointItem 

type EndpointItem struct {
	Protocols struct {
		Protocols []string
	}
	Type        string
	Namespace   string
	Id          Region
	SerivceCode string
	Endpoint    string
}

type Endpoints 

type Endpoints struct {
	Endpoint []Endpoint `xml:"Endpoint"`
}

xml

type Error 

type Error struct {
	ErrorResponse
	StatusCode int //Status Code of HTTP Response
}

An Error represents a custom error for Aliyun API failure response

func (*Error) Error 

func (e *Error) Error() string

type ErrorResponse 

type ErrorResponse struct {
	Response
	HostId  string
	Code    string
	Message string
}

type FlattenArray 

type FlattenArray []string

RemovalPolicy.N add index to array item RemovalPolicy=["a", "b"] => RemovalPolicy.1="a" RemovalPolicy.2="b"

type HTTPDoHook 

type HTTPDoHook func(fn func(req *http.Request) (*http.Response, error)) func(req *http.Request) (*http.Response, error)

HTTPDoHook defines the type of hook

type InstanceChargeType 

type InstanceChargeType string

type InternetChargeType 

type InternetChargeType string

type LocationClient 

type LocationClient struct {
	Client
}

func NewLocationClient 

func NewLocationClient(accessKeyId, accessKeySecret, securityToken string) *LocationClient

func NewLocationClientWithSecurityToken 

func NewLocationClientWithSecurityToken(accessKeyId, accessKeySecret, securityToken string) *LocationClient

func (*LocationClient) DescribeEndpoint 

func (client *LocationClient) DescribeEndpoint(args *DescribeEndpointArgs) (*DescribeEndpointResponse, error)

func (*LocationClient) DescribeEndpoints 

func (client *LocationClient) DescribeEndpoints(args *DescribeEndpointsArgs) (*DescribeEndpointsResponse, error)

func (*LocationClient) DescribeOpenAPIEndpoint 

func (client *LocationClient) DescribeOpenAPIEndpoint(region Region, serviceCode string) string

type NetType 

type NetType string

type NetworkType 

type NetworkType string

type Pagination 

type Pagination struct {
	PageNumber int
	PageSize   int
}

func (*Pagination) SetPageSize 

func (p *Pagination) SetPageSize(size int)

func (*Pagination) Validate 

func (p *Pagination) Validate()

type PaginationResult 

type PaginationResult struct {
	TotalCount int
	PageNumber int
	PageSize   int
}

A PaginationResponse represents a response with pagination information

func (*PaginationResult) NextPage 

func (r *PaginationResult) NextPage() *Pagination

NextPage gets the next page of the result set

type Product 

type Product struct {
	ProductName string `xml:"ProductName"`
	DomainName  string `xml:"DomainName"`
}

type Products 

type Products struct {
	Product []Product `xml:"Product"`
}

type Region 

type Region string

Region represents ECS region

type RegionIds 

type RegionIds struct {
	RegionId string `xml:"RegionId"`
}

type Request 

type Request struct {
	Format               string
	Version              string
	RegionId             Region
	AccessKeyId          string
	SecurityToken        string
	Signature            string
	SignatureMethod      string
	Timestamp            util.ISO6801Time
	SignatureVersion     string
	SignatureNonce       string
	ResourceOwnerAccount string
	Action               string
}

type Response 

type Response struct {
	RequestId string
}

type TimeType 

type TimeType string

type UnderlineString 

type UnderlineString string

string contains underline which will be replaced with dot SystemDisk_Category => SystemDisk.Category

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.