ros

package
v0.0.0-...-ba7e8e4 Latest Latest
Warning

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

 Go to latest Published: Aug 9, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ROSDefaultEndpoint is the default API endpoint of ROS services
	ROSDefaultEndpoint = "https://ros.aliyuncs.com"
	ROSAPIVersion      = "2015-09-01"
)
View Source 
const (
	SUPPORT_STATUS_UNKNOWN     = "UNKNOWN"
	SUPPORT_STATUS_SUPPORTED   = "SUPPORTED"
	SUPPORT_STATUS_DEPRECATED  = "DEPRECATED"
	SUPPORT_STATUS_UNSUPPORTED = "UNSUPPORTED"
	SUPPORT_STATUS_HIDDEN      = "HIDDEN"
)
View Source 
const (
	ROS_RPC_APIVersion = "2019-09-10"
	ROSServiceCode     = "ros"
)
View Source 
const (
	DeletionProtectionEnabled  = DeletionProtection("Enabled")
	DeletionProtectionDisabled = DeletionProtection("Disabled")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AbandonStackRequest 

type AbandonStackRequest struct {
	RegionId common.Region
}

https://help.aliyun.com/document_detail/28912.html?spm=5176.doc28911.6.582.X0FKwG

type AbandonStackResponse 

type AbandonStackResponse struct {
	common.Response
	Id          string
	Name        string
	Action      string
	Status      string
	Template    interface{}
	Resources   interface{}
	Environment interface{}
}

type Client 

type Client struct {
	AccessKeyId     string
	AccessKeySecret string
	SecurityToken   string

	Version string
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(accessKeyId, accessKeySecret string) *Client

NewClient creates a new instance of ROS client

func NewClientForAussumeRole 

func NewClientForAussumeRole(accessKeyId, accessKeySecret, securityToken string) *Client

func NewROSClientWithSecurityToken 

func NewROSClientWithSecurityToken(accessKeyId string, accessKeySecret string, securityToken string) *Client

func (*Client) AbandonStack 

func (client *Client) AbandonStack(regionId common.Region, stackId string, stackName string) (*AbandonStackResponse, error)

func (*Client) CreateStack 

func (client *Client) CreateStack(regionId common.Region, args *CreateStackRequest) (*CreateStackResponse, error)

func (*Client) DeleteStack 

func (client *Client) DeleteStack(regionId common.Region, stackId string, stackName string) (*DeleteStackResponse, error)

func (*Client) DescribeEvents 

func (client *Client) DescribeEvents(stackId, stackName string, args *DescribeEventsRequest) (*DescribeEventsResponse, error)

func (*Client) DescribeRegions 

func (client *Client) DescribeRegions() (*DescribeRegionsResponse, error)

func (*Client) DescribeResource 

func (client *Client) DescribeResource(stackId, stackName, resourceName string) (*Resource, error)

https://help.aliyun.com/document_detail/28917.html?spm=5176.doc28916.6.589.BUPJqx

func (*Client) DescribeResourceByRegion 

func (client *Client) DescribeResourceByRegion(regionId common.Region, stackId, stackName, resourceName string) (*Resource, error)

https://help.aliyun.com/document_detail/28917.html?spm=5176.doc28916.6.589.BUPJqx

func (*Client) DescribeResources 

func (client *Client) DescribeResources(stackId, stackName string) ([]*Resource, error)

func (*Client) DescribeResoureType 

func (client *Client) DescribeResoureType(typeName string) (*DescribeResoureTypeResponse, error)

func (*Client) DescribeResoureTypeTemplate 

func (client *Client) DescribeResoureTypeTemplate(typeName string) (*DescribeResoureTypeTemplateResponse, error)

func (*Client) DescribeResoureTypes 

func (client *Client) DescribeResoureTypes(supportStatus SupportStatus) (*DescribeResoureTypesResponse, error)

func (*Client) DescribeStack 

func (client *Client) DescribeStack(regionId common.Region, stackId string, stackName string) (*DescribeStackResponse, error)

func (*Client) DescribeStacks 

func (client *Client) DescribeStacks(args *DescribeStacksRequest) (*DescribeStacksResponse, error)

func (*Client) DescribeTemplate 

func (client *Client) DescribeTemplate(stackId, stackName string) (*DescribeTemplateResponse, error)

func (*Client) Invoke 

func (client *Client) Invoke(region common.Region, method string, path string, query url.Values, args interface{}, response interface{}) error

Invoke sends the raw HTTP request for ROS services

func (*Client) PreviewStack 

func (client *Client) PreviewStack(regionId common.Region, args PreviewStackRequest) (*PreviewStackResponse, error)

func (*Client) SetDebug 

func (client *Client) SetDebug(debug bool)

SetDebug sets debug mode to log the request/response message

func (*Client) SetSecurityToken 

func (client *Client) SetSecurityToken(securityToken string)

func (*Client) SetTransport 

func (client *Client) SetTransport(transport http.RoundTripper)

SetTransport sets transport to the http client

func (*Client) SetUserAgent 

func (client *Client) SetUserAgent(userAgent string)

SetUserAgent sets user agent to log the request/response message

func (*Client) UpdateStack 

func (client *Client) UpdateStack(regionId common.Region, stackId string, stackName string, args *UpdateStackRequest) (*UpdateStackResponse, error)

func (*Client) ValidateTemplate 

func (client *Client) ValidateTemplate(args *ValidateTemplateRequest) (*ValidateTemplateResponse, error)

type CreateStackRequest 

type CreateStackRequest struct {
	Name               string
	Template           string
	Parameters         interface{}
	DisableRollback    bool
	DeletionProtection DeletionProtection
	TimeoutMins        int
}

https://help.aliyun.com/document_detail/28910.html?spm=5176.doc50083.6.580.b5wkQr

type CreateStackResponse 

type CreateStackResponse struct {
	Id   string
	Name string
}

type DeleteStackRequest 

type DeleteStackRequest struct {
	RegionId common.Region
}

https://help.aliyun.com/document_detail/28911.html?spm=5176.doc28910.6.581.etoi2Z

type DeleteStackResponse 

type DeleteStackResponse struct {
	common.Response
}

type DeleteStackRpcRequest 

type DeleteStackRpcRequest struct {
	RegionId           common.Region
	StackId            string
	RetainResources    common.FlattenArray
	RetainAllResources bool
}

type DeletionProtection 

type DeletionProtection string

type DescribeEventsRequest 

type DescribeEventsRequest struct {
	ResourceStatus string
	ResourceName   string
	ResourceType   string
	PageNumber     int
	PageSize       int
}

https://help.aliyun.com/document_detail/28925.html?spm=5176.doc28923.6.597.Wktzdg

type DescribeEventsResponse 

type DescribeEventsResponse struct {
	common.Response
	TotalCount int
	PageNumber int
	PageSize   int
	Events     []Event
}

type DescribeRegionsResponse 

type DescribeRegionsResponse struct {
	common.Response
	Regions []Region
}

type DescribeResoureTypeResponse 

type DescribeResoureTypeResponse struct {
	common.Response
	ResourceType  string
	Attributes    interface{}
	SupportStatus interface{}
	Properties    interface{}
}

https://help.aliyun.com/document_detail/28919.html?spm=5176.doc28918.6.591.7QkDYC

type DescribeResoureTypeTemplateResponse 

type DescribeResoureTypeTemplateResponse struct {
	common.Response
	ROSTemplateFormatVersion string
	Parameters               interface{}
	Outputs                  interface{}
	Resources                interface{}
}

https://help.aliyun.com/document_detail/28920.html?spm=5176.doc28919.6.592.IiEwar

type DescribeResoureTypesRequest 

type DescribeResoureTypesRequest struct {
	SupportStatus SupportStatus
}

type DescribeResoureTypesResponse 

type DescribeResoureTypesResponse struct {
	common.Response
	ResourceTypes []string
}

type DescribeStackRequest 

type DescribeStackRequest struct {
	RegionId common.Region
}

https://help.aliyun.com/document_detail/28914.html?spm=5176.doc28913.6.584.9JAYPI

type DescribeStackResponse 

type DescribeStackResponse struct {
	Parameters interface{}
	common.Response
	Id                  string
	Region              common.Region
	Name                string
	Updated             string
	Created             string
	TemplateDescription string
	StatusReason        string
	Status              string
	Outputs             interface{}
	DisableRollback     bool
	TimeoutMins         int
}

type DescribeStacksRequest 

type DescribeStacksRequest struct {
	RegionId   common.Region
	StackId    string
	Name       string
	Status     string
	PageNumber string
	PageSize   string
}

https://help.aliyun.com/document_detail/28913.html?spm=5176.doc28912.6.583.vrfk38

type DescribeStacksResponse 

type DescribeStacksResponse struct {
	common.Response
	TotalCount int
	PageNumber int
	PageSize   int
	Stacks     []Stack
}

type DescribeTemplateResponse 

type DescribeTemplateResponse struct {
	common.Response
	ROSTemplateFormatVersion string
	Parameters               interface{}
	Outputs                  interface{}
	Resources                interface{}
	Description              interface{}
	Conditions               interface{}
	Mappings                 interface{}
	Metadata                 interface{}
}

https://help.aliyun.com/document_detail/28922.html?spm=5176.doc28920.6.594.UI5p6A

type Event 

type Event struct {
	Status             string
	ResourceStatus     string
	ResourceName       string
	StatusReason       string
	Id                 string
	ResourceId         string
	ResourceType       string
	ResourcePhysicalId string
	Time               string
}

type PreviewStackRequest 

type PreviewStackRequest struct {
	Name            string
	Template        string
	Parameters      string
	DisableRollback bool
	TimeoutMins     int
}

https://help.aliyun.com/document_detail/50083.html?spm=5176.doc28914.6.585.QnbbaF

type PreviewStackResponse 

type PreviewStackResponse struct {
	common.Response
	Id                  string
	Resources           interface{}
	Region              common.Region
	Description         string
	Updated             string
	Created             string
	Parameters          interface{}
	TemplateDescription string
	Webhook             string
	DisableRollback     bool
	TimeoutMins         int
}

type Region 

type Region struct {
	LocalName string
	RegionId  string
}

https://help.aliyun.com/document_detail/50086.html?spm=5176.doc28910.6.598.ngYYj6

type Request 

type Request struct {
	Method          string
	URL             string
	Version         string
	Region          common.Region
	Signature       string
	SignatureMethod string
	SignatureNonce  string
	Timestamp       util.ISO6801Time
	Body            []byte
}

type Resource 

type Resource struct {
	Id           string
	Name         string
	Type         string
	Status       string
	StatusReason string
	Updated      string
	PhysicalId   string
}

https://help.aliyun.com/document_detail/28916.html?spm=5176.doc49066.6.588.d7Ntjs

type Response 

type Response struct {
	RequestId string `json:"request_id"`
}

type RpcClient 

type RpcClient struct {
	common.Client
}

func NewRosRpcClientWithEndpointAndSecurityToken 

func NewRosRpcClientWithEndpointAndSecurityToken(endpoint string, accessKeyId string, accessKeySecret string, securityToken string, regionID common.Region) *RpcClient

func NewRosRpcClientWithSecurityToken 

func NewRosRpcClientWithSecurityToken(accessKeyId string, accessKeySecret string, securityToken string, regionID common.Region) *RpcClient

func NewRpcClient 

func NewRpcClient(accessKeyId, accessKeySecret string) *RpcClient

func NewRpcClientWithEndpoint 

func NewRpcClientWithEndpoint(endpoint string, accessKeyId string, accessKeySecret string) *RpcClient

func (*RpcClient) DeleteStack 

func (client *RpcClient) DeleteStack(args *DeleteStackRpcRequest) (*DeleteStackResponse, error)

rpc api: https://help.aliyun.com/document_detail/132113.html?spm=a2c4g.11174283.6.880.1b1d143eCzdE0b

func (*RpcClient) SetDeletionProtection 

func (client *RpcClient) SetDeletionProtection(args *SetDeletionProtectionRequest) (*common.Response, error)

rpc api: https://help.aliyun.com/document_detail/161560.html?spm=a2c4g.11186623.6.991.18f62842yOfz9G

type SetDeletionProtectionRequest 

type SetDeletionProtectionRequest struct {
	RegionId           common.Region
	StackId            string
	DeletionProtection DeletionProtection
}

type Stack 

type Stack struct {
	Region          common.Region
	Id              string
	Name            string
	Updated         string
	Created         string
	StatusReason    string
	Status          string
	Description     string
	DisableRollback bool
	TimeoutMins     int
}

type SupportStatus 

type SupportStatus string

https://help.aliyun.com/document_detail/28918.html?spm=5176.doc28917.6.590.smknll

type UpdateStackRequest 

type UpdateStackRequest struct {
	Template          string
	Parameters        interface{}
	DisableRollback   bool
	TimeoutMins       int
	StackPolicy       interface{}
	UpdateAllowPolicy interface{}
	Existing          bool
}

https://help.aliyun.com/document_detail/49066.html?spm=5176.doc28910.6.586.MJjWQh

type UpdateStackResponse 

type UpdateStackResponse struct {
	common.Response
	Id   string
	Name string
}

type ValidateTemplateRequest 

type ValidateTemplateRequest struct {
	Template string
}

https://help.aliyun.com/document_detail/28923.html?spm=5176.doc28922.6.595.uhWWET

type ValidateTemplateResponse 

type ValidateTemplateResponse struct {
	common.Response
	Parameters  interface{}
	Description interface{}
}

Source Files

View all Source files

Directories

Path Synopsis

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.