location

package
v1.62.411 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2023 License: Apache-2.0 Imports: 4 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	sdk.Client
}

Client is the sdk client struct, each func corresponds to an OpenAPI

func NewClient

func NewClient() (client *Client, err error)

NewClient creates a sdk client with environment variables

func NewClientWithAccessKey

func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)

NewClientWithAccessKey is a shortcut to create sdk client with accesskey usage: https://help.aliyun.com/document_detail/66217.html

func NewClientWithEcsRamRole

func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)

NewClientWithEcsRamRole is a shortcut to create sdk client with ecs ram role usage: https://help.aliyun.com/document_detail/66223.html

func NewClientWithOptions

func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)

NewClientWithOptions creates a sdk client with regionId/sdkConfig/credential this is the common api to create a sdk client

func NewClientWithRamRoleArn

func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn usage: https://help.aliyun.com/document_detail/66222.html

func NewClientWithRsaKeyPair

func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)

NewClientWithRsaKeyPair is a shortcut to create sdk client with rsa key pair attention: rsa key pair auth is only Japan regions available

func NewClientWithStsToken

func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)

NewClientWithStsToken is a shortcut to create sdk client with sts token usage: https://help.aliyun.com/document_detail/66222.html

func (*Client) DescribeEndpoint

func (client *Client) DescribeEndpoint(request *DescribeEndpointRequest) (response *DescribeEndpointResponse, err error)

DescribeEndpoint invokes the location.DescribeEndpoint API synchronously api document: https://help.aliyun.com/api/location/describeendpoint.html

func (*Client) DescribeEndpointWithCallback

func (client *Client) DescribeEndpointWithCallback(request *DescribeEndpointRequest, callback func(response *DescribeEndpointResponse, err error)) <-chan int

DescribeEndpointWithCallback invokes the location.DescribeEndpoint API asynchronously api document: https://help.aliyun.com/api/location/describeendpoint.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeEndpointWithChan

func (client *Client) DescribeEndpointWithChan(request *DescribeEndpointRequest) (<-chan *DescribeEndpointResponse, <-chan error)

DescribeEndpointWithChan invokes the location.DescribeEndpoint API asynchronously api document: https://help.aliyun.com/api/location/describeendpoint.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeEndpoints

func (client *Client) DescribeEndpoints(request *DescribeEndpointsRequest) (response *DescribeEndpointsResponse, err error)

DescribeEndpoints invokes the location.DescribeEndpoints API synchronously api document: https://help.aliyun.com/api/location/describeendpoints.html

func (*Client) DescribeEndpointsWithCallback

func (client *Client) DescribeEndpointsWithCallback(request *DescribeEndpointsRequest, callback func(response *DescribeEndpointsResponse, err error)) <-chan int

DescribeEndpointsWithCallback invokes the location.DescribeEndpoints API asynchronously api document: https://help.aliyun.com/api/location/describeendpoints.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeEndpointsWithChan

func (client *Client) DescribeEndpointsWithChan(request *DescribeEndpointsRequest) (<-chan *DescribeEndpointsResponse, <-chan error)

DescribeEndpointsWithChan invokes the location.DescribeEndpoints API asynchronously api document: https://help.aliyun.com/api/location/describeendpoints.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeRegions

func (client *Client) DescribeRegions(request *DescribeRegionsRequest) (response *DescribeRegionsResponse, err error)

DescribeRegions invokes the location.DescribeRegions API synchronously api document: https://help.aliyun.com/api/location/describeregions.html

func (*Client) DescribeRegionsWithCallback

func (client *Client) DescribeRegionsWithCallback(request *DescribeRegionsRequest, callback func(response *DescribeRegionsResponse, err error)) <-chan int

DescribeRegionsWithCallback invokes the location.DescribeRegions API asynchronously api document: https://help.aliyun.com/api/location/describeregions.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeRegionsWithChan

func (client *Client) DescribeRegionsWithChan(request *DescribeRegionsRequest) (<-chan *DescribeRegionsResponse, <-chan error)

DescribeRegionsWithChan invokes the location.DescribeRegions API asynchronously api document: https://help.aliyun.com/api/location/describeregions.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeServices

func (client *Client) DescribeServices(request *DescribeServicesRequest) (response *DescribeServicesResponse, err error)

DescribeServices invokes the location.DescribeServices API synchronously api document: https://help.aliyun.com/api/location/describeservices.html

func (*Client) DescribeServicesWithCallback

func (client *Client) DescribeServicesWithCallback(request *DescribeServicesRequest, callback func(response *DescribeServicesResponse, err error)) <-chan int

DescribeServicesWithCallback invokes the location.DescribeServices API asynchronously api document: https://help.aliyun.com/api/location/describeservices.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) DescribeServicesWithChan

func (client *Client) DescribeServicesWithChan(request *DescribeServicesRequest) (<-chan *DescribeServicesResponse, <-chan error)

DescribeServicesWithChan invokes the location.DescribeServices API asynchronously api document: https://help.aliyun.com/api/location/describeservices.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ListEndpoints

func (client *Client) ListEndpoints(request *ListEndpointsRequest) (response *ListEndpointsResponse, err error)

ListEndpoints invokes the location.ListEndpoints API synchronously api document: https://help.aliyun.com/api/location/listendpoints.html

func (*Client) ListEndpointsByIp

func (client *Client) ListEndpointsByIp(request *ListEndpointsByIpRequest) (response *ListEndpointsByIpResponse, err error)

ListEndpointsByIp invokes the location.ListEndpointsByIp API synchronously api document: https://help.aliyun.com/api/location/listendpointsbyip.html

func (*Client) ListEndpointsByIpWithCallback

func (client *Client) ListEndpointsByIpWithCallback(request *ListEndpointsByIpRequest, callback func(response *ListEndpointsByIpResponse, err error)) <-chan int

ListEndpointsByIpWithCallback invokes the location.ListEndpointsByIp API asynchronously api document: https://help.aliyun.com/api/location/listendpointsbyip.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ListEndpointsByIpWithChan

func (client *Client) ListEndpointsByIpWithChan(request *ListEndpointsByIpRequest) (<-chan *ListEndpointsByIpResponse, <-chan error)

ListEndpointsByIpWithChan invokes the location.ListEndpointsByIp API asynchronously api document: https://help.aliyun.com/api/location/listendpointsbyip.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ListEndpointsWithCallback

func (client *Client) ListEndpointsWithCallback(request *ListEndpointsRequest, callback func(response *ListEndpointsResponse, err error)) <-chan int

ListEndpointsWithCallback invokes the location.ListEndpoints API asynchronously api document: https://help.aliyun.com/api/location/listendpoints.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ListEndpointsWithChan

func (client *Client) ListEndpointsWithChan(request *ListEndpointsRequest) (<-chan *ListEndpointsResponse, <-chan error)

ListEndpointsWithChan invokes the location.ListEndpoints API asynchronously api document: https://help.aliyun.com/api/location/listendpoints.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

type DescribeEndpointRequest

type DescribeEndpointRequest struct {
	*requests.RpcRequest
	Password    string `position:"Query" name:"Password"`
	ServiceCode string `position:"Query" name:"ServiceCode"`
	Id          string `position:"Query" name:"Id"`
}

DescribeEndpointRequest is the request struct for api DescribeEndpoint

func CreateDescribeEndpointRequest

func CreateDescribeEndpointRequest() (request *DescribeEndpointRequest)

CreateDescribeEndpointRequest creates a request to invoke DescribeEndpoint API

type DescribeEndpointResponse

type DescribeEndpointResponse struct {
	*responses.BaseResponse
	RequestId   string                      `json:"RequestId" xml:"RequestId"`
	Endpoint    string                      `json:"Endpoint" xml:"Endpoint"`
	Id          string                      `json:"Id" xml:"Id"`
	Namespace   string                      `json:"Namespace" xml:"Namespace"`
	SerivceCode string                      `json:"SerivceCode" xml:"SerivceCode"`
	Type        string                      `json:"Type" xml:"Type"`
	Protocols   ProtocolsInDescribeEndpoint `json:"Protocols" xml:"Protocols"`
}

DescribeEndpointResponse is the response struct for api DescribeEndpoint

func CreateDescribeEndpointResponse

func CreateDescribeEndpointResponse() (response *DescribeEndpointResponse)

CreateDescribeEndpointResponse creates a response to parse from DescribeEndpoint response

type DescribeEndpointsRequest

type DescribeEndpointsRequest struct {
	*requests.RpcRequest
	ServiceCode string `position:"Query" name:"ServiceCode"`
	Id          string `position:"Query" name:"Id"`
	Type        string `position:"Query" name:"Type"`
}

DescribeEndpointsRequest is the request struct for api DescribeEndpoints

func CreateDescribeEndpointsRequest

func CreateDescribeEndpointsRequest() (request *DescribeEndpointsRequest)

CreateDescribeEndpointsRequest creates a request to invoke DescribeEndpoints API

type DescribeEndpointsResponse

type DescribeEndpointsResponse struct {
	*responses.BaseResponse
	RequestId string    `json:"RequestId" xml:"RequestId"`
	Success   bool      `json:"Success" xml:"Success"`
	Endpoints Endpoints `json:"Endpoints" xml:"Endpoints"`
}

DescribeEndpointsResponse is the response struct for api DescribeEndpoints

func CreateDescribeEndpointsResponse

func CreateDescribeEndpointsResponse() (response *DescribeEndpointsResponse)

CreateDescribeEndpointsResponse creates a response to parse from DescribeEndpoints response

type DescribeRegionsRequest

type DescribeRegionsRequest struct {
	*requests.RpcRequest
	Password string `position:"Query" name:"Password"`
}

DescribeRegionsRequest is the request struct for api DescribeRegions

func CreateDescribeRegionsRequest

func CreateDescribeRegionsRequest() (request *DescribeRegionsRequest)

CreateDescribeRegionsRequest creates a request to invoke DescribeRegions API

type DescribeRegionsResponse

type DescribeRegionsResponse struct {
	*responses.BaseResponse
	RequestId  string    `json:"RequestId" xml:"RequestId"`
	TotalCount int       `json:"TotalCount" xml:"TotalCount"`
	RegionIds  RegionIds `json:"RegionIds" xml:"RegionIds"`
}

DescribeRegionsResponse is the response struct for api DescribeRegions

func CreateDescribeRegionsResponse

func CreateDescribeRegionsResponse() (response *DescribeRegionsResponse)

CreateDescribeRegionsResponse creates a response to parse from DescribeRegions response

type DescribeServicesRequest

type DescribeServicesRequest struct {
	*requests.RpcRequest
	Password string `position:"Query" name:"Password"`
}

DescribeServicesRequest is the request struct for api DescribeServices

func CreateDescribeServicesRequest

func CreateDescribeServicesRequest() (request *DescribeServicesRequest)

CreateDescribeServicesRequest creates a request to invoke DescribeServices API

type DescribeServicesResponse

type DescribeServicesResponse struct {
	*responses.BaseResponse
	RequestId  string   `json:"RequestId" xml:"RequestId"`
	TotalCount int      `json:"TotalCount" xml:"TotalCount"`
	Services   Services `json:"Services" xml:"Services"`
}

DescribeServicesResponse is the response struct for api DescribeServices

func CreateDescribeServicesResponse

func CreateDescribeServicesResponse() (response *DescribeServicesResponse)

CreateDescribeServicesResponse creates a response to parse from DescribeServices response

type Endpoint

type Endpoint struct {
	Endpoint    string                       `json:"Endpoint" xml:"Endpoint"`
	Id          string                       `json:"Id" xml:"Id"`
	Namespace   string                       `json:"Namespace" xml:"Namespace"`
	SerivceCode string                       `json:"SerivceCode" xml:"SerivceCode"`
	Type        string                       `json:"Type" xml:"Type"`
	Protocols   ProtocolsInDescribeEndpoints `json:"Protocols" xml:"Protocols"`
}

Endpoint is a nested struct in location response

type EndpointListInListEndpoints

type EndpointListInListEndpoints struct {
	ItemEndpoint []ItemEndpoint `json:"ItemEndpoint" xml:"ItemEndpoint"`
}

EndpointListInListEndpoints is a nested struct in location response

type EndpointListInListEndpointsByIp

type EndpointListInListEndpointsByIp struct {
	ItemEndpoint []ItemEndpoint `json:"ItemEndpoint" xml:"ItemEndpoint"`
}

EndpointListInListEndpointsByIp is a nested struct in location response

type Endpoints

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

Endpoints is a nested struct in location response

type ItemEndpoint

type ItemEndpoint struct {
	Endpoint  string                       `json:"Endpoint" xml:"Endpoint"`
	Product   string                       `json:"Product" xml:"Product"`
	Namespace string                       `json:"Namespace" xml:"Namespace"`
	Id        string                       `json:"Id" xml:"Id"`
	Type      string                       `json:"Type" xml:"Type"`
	Protocols ProtocolsInListEndpointsByIp `json:"Protocols" xml:"Protocols"`
}

ItemEndpoint is a nested struct in location response

type ListEndpointsByIpRequest

type ListEndpointsByIpRequest struct {
	*requests.RpcRequest
	Ip string `position:"Query" name:"Ip"`
}

ListEndpointsByIpRequest is the request struct for api ListEndpointsByIp

func CreateListEndpointsByIpRequest

func CreateListEndpointsByIpRequest() (request *ListEndpointsByIpRequest)

CreateListEndpointsByIpRequest creates a request to invoke ListEndpointsByIp API

type ListEndpointsByIpResponse

type ListEndpointsByIpResponse struct {
	*responses.BaseResponse
	RequestId    string                          `json:"RequestId" xml:"RequestId"`
	Success      bool                            `json:"Success" xml:"Success"`
	EndpointList EndpointListInListEndpointsByIp `json:"EndpointList" xml:"EndpointList"`
}

ListEndpointsByIpResponse is the response struct for api ListEndpointsByIp

func CreateListEndpointsByIpResponse

func CreateListEndpointsByIpResponse() (response *ListEndpointsByIpResponse)

CreateListEndpointsByIpResponse creates a response to parse from ListEndpointsByIp response

type ListEndpointsRequest

type ListEndpointsRequest struct {
	*requests.RpcRequest
	Namespace   string `position:"Query" name:"Namespace"`
	Id          string `position:"Query" name:"Id"`
	SerivceCode string `position:"Query" name:"SerivceCode"`
}

ListEndpointsRequest is the request struct for api ListEndpoints

func CreateListEndpointsRequest

func CreateListEndpointsRequest() (request *ListEndpointsRequest)

CreateListEndpointsRequest creates a request to invoke ListEndpoints API

type ListEndpointsResponse

type ListEndpointsResponse struct {
	*responses.BaseResponse
	RequestId    string                      `json:"RequestId" xml:"RequestId"`
	Success      bool                        `json:"Success" xml:"Success"`
	EndpointList EndpointListInListEndpoints `json:"EndpointList" xml:"EndpointList"`
}

ListEndpointsResponse is the response struct for api ListEndpoints

func CreateListEndpointsResponse

func CreateListEndpointsResponse() (response *ListEndpointsResponse)

CreateListEndpointsResponse creates a response to parse from ListEndpoints response

type ProtocolsInDescribeEndpoint

type ProtocolsInDescribeEndpoint struct {
	Protocols []string `json:"Protocols" xml:"Protocols"`
}

ProtocolsInDescribeEndpoint is a nested struct in location response

type ProtocolsInDescribeEndpoints

type ProtocolsInDescribeEndpoints struct {
	Protocols []string `json:"Protocols" xml:"Protocols"`
}

ProtocolsInDescribeEndpoints is a nested struct in location response

type ProtocolsInListEndpoints

type ProtocolsInListEndpoints struct {
	Protocols []string `json:"Protocols" xml:"Protocols"`
}

ProtocolsInListEndpoints is a nested struct in location response

type ProtocolsInListEndpointsByIp

type ProtocolsInListEndpointsByIp struct {
	Protocols []string `json:"Protocols" xml:"Protocols"`
}

ProtocolsInListEndpointsByIp is a nested struct in location response

type RegionIds

type RegionIds struct {
	RegionIds []string `json:"RegionIds" xml:"RegionIds"`
}

RegionIds is a nested struct in location response

type Services

type Services struct {
	Services []string `json:"Services" xml:"Services"`
}

Services is a nested struct in location response

Jump to

Keyboard shortcuts

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