apigroups

Documentation

Index

• func List(client *golangsdk.ServiceClient, instanceId string, opts ListOptsBuilder) pagination.Pager
• type CreateOptsBuilder
• type CreateResult
  • func Create(client *golangsdk.ServiceClient, instanceId string, opts CreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*Group, error)
• type DeleteResult
  • func Delete(client *golangsdk.ServiceClient, instanceId, groupId string) (r DeleteResult)
• type GetResult
  • func Get(client *golangsdk.ServiceClient, instanceId, groupId string) (r GetResult)
  • func (r GetResult) Extract() (*Group, error)
• type Group
  • func ExtractGroups(r pagination.Page) ([]Group, error)
• type GroupOpts
  • func (opts GroupOpts) ToCreateOptsMap() (map[string]interface{}, error)
• type GroupPage
• type ListOpts
  • func (opts ListOpts) ToListQuery() (string, error)
• type ListOptsBuilder
• type UpdateResult
  • func Update(client *golangsdk.ServiceClient, instanceId, groupId string, ...) (r UpdateResult)
  • func (r UpdateResult) Extract() (*Group, error)
• type UrlDomian

Functions

func List

func List(client *golangsdk.ServiceClient, instanceId string, opts ListOptsBuilder) pagination.Pager

List is a method to obtain an array of one or more groups according to the query parameters.

Types

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToCreateOptsMap() (map[string]interface{}, error)
}

type CreateResult

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult represents a result of the Create method.

func Create

func Create(client *golangsdk.ServiceClient, instanceId string, opts CreateOptsBuilder) (r CreateResult)

Create is a method by which to create function that create a new group.

func (CreateResult) Extract

func (r CreateResult) Extract() (*Group, error)

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents a result of the Delete method.

func Delete

func Delete(client *golangsdk.ServiceClient, instanceId, groupId string) (r DeleteResult)

Delete is a method to delete an existing group.

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult represents a result of the Get operation.

func Get

func Get(client *golangsdk.ServiceClient, instanceId, groupId string) (r GetResult)

Get is a method to obtain the specified group according to the instanceId and appId.

func (GetResult) Extract

func (r GetResult) Extract() (*Group, error)

type Group

type Group struct {
	// List of independent domain names bound to the API group.
	UrlDomians []UrlDomian `json:"url_domains"`
	// Time when the API group was last modified.
	UpdateTime string `json:"update_time"`
	// API group name.
	Name string `json:"name"`
	// Indicates whether the API group has been listed on the marketplace.
	//     1: listed
	//     2: not listed
	//     3: under review.
	OnSellStatus int `json:"on_sell_status"`
	// Description.
	Description string `json:"remark"`
	// Subdomain name that API Gateway automatically allocates to the API group.
	Subdomain string `json:"sl_domain"`
	// Subdomain names that API Gateway automatically allocates to the API group.
	Subdomains []string `json:"sl_domains"`
	// ID.
	Id string `json:"id"`
	// Registraion time.
	RegistraionTime string `json:"register_time"`
	// group status.
	//     1: valid
	Status int `json:"status"`
	// Indicates whether the API group is the default group.
	IsDefault int `json:"is_default"`
}

func ExtractGroups

func ExtractGroups(r pagination.Page) ([]Group, error)

type GroupOpts

type GroupOpts struct {
	// API group name, which can contain 3 to 64 characters, starting with a letter.
	// Only letters, digits and underscores (_) are allowed.
	// Chinese characters must be in UTF-8 or Unicode format.
	Name string `json:"name" required:"true"`
	// Description of the API group, which can contain a maximum of 255 characters,
	// and the angle brackets (< and >) are not allowed.
	// Chinese characters must be in UTF-8 or Unicode format.
	Description *string `json:"remark,omitempty"`
}

GroupOpts allows to create a group or update a existing group using given parameters.

func (GroupOpts) ToCreateOptsMap

func (opts GroupOpts) ToCreateOptsMap() (map[string]interface{}, error)

type GroupPage

type GroupPage struct {
	pagination.SinglePageBase
}

GroupPage represents the response pages of the List operation.

type ListOpts

type ListOpts struct {
	// API group ID.
	Id string `q:"id"`
	// API group name.
	Name string `q:"name"`
	// Offset from which the query starts.
	// If the offset is less than 0, the value is automatically converted to 0. Default to 0.
	Offset int `q:"offset"`
	// Number of items displayed on each page. The valid values are range form 1 to 500, default to 20.
	Limit int `q:"limit"`
	// Parameter name for exact matching. Only API group names are supported.
	PreciseSearch string `q:"precise_search"`
}

ListOpts allows to filter list data using given parameters.

func (ListOpts) ToListQuery

func (opts ListOpts) ToListQuery() (string, error)

type ListOptsBuilder

type ListOptsBuilder interface {
	ToListQuery() (string, error)
}

type UpdateResult

type UpdateResult struct {
	// contains filtered or unexported fields
}

UpdateResult represents a result of the Update operation.

func Update

func Update(client *golangsdk.ServiceClient, instanceId, groupId string, opts CreateOptsBuilder) (r UpdateResult)

Update is a method by which to create function that udpate a existing group.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*Group, error)

type UrlDomian

type UrlDomian struct {
	// Domain ID.
	Id string `json:"id"`
	// Domain ID.
	DomainName string `json:"domain"`
	// CNAME resolution status of the domain name.
	//     1: not resolved
	//     2: resolving
	//     3: resolved
	//     4: resolving failed
	ResolutionStatus int `json:"cname_status"`
	// SSL certificate ID.
	SSLId string `json:"ssl_id"`
	// SSL certificate name.
	SSLName string `json:"ssl_name"`
	// Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.
	// Enumeration values:
	//     TLSv1.1
	//     TLSv1.2
	MinSSLVersion string `json:"min_ssl_version"`
}