v20201106

package
v1.0.1113 Latest Latest
Warning

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

 Go to latest Published: Mar 3, 2025 License: Apache-2.0 Imports: 7 Imported by: 3

Documentation

Index

Constants

View Source 
const (

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 请求的次数超过了频率限制。
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2020-11-06"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) DescribeProducts added in v1.0.359 

func (c *Client) DescribeProducts(request *DescribeProductsRequest) (response *DescribeProductsResponse, err error)

DescribeProducts 本接口(DescribeProducts)用于查询各个支持地域列表查询的产品信息。

func (*Client) DescribeProductsWithContext added in v1.0.359 

func (c *Client) DescribeProductsWithContext(ctx context.Context, request *DescribeProductsRequest) (response *DescribeProductsResponse, err error)

DescribeProducts 本接口(DescribeProducts)用于查询各个支持地域列表查询的产品信息。

func (*Client) DescribeRegions 

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

DescribeRegions 本接口(DescribeRegions)用于查询各个产品支持地域信息。

可能返回的错误码: 

INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DescribeRegionsWithContext added in v1.0.324 

func (c *Client) DescribeRegionsWithContext(ctx context.Context, request *DescribeRegionsRequest) (response *DescribeRegionsResponse, err error)

DescribeRegions 本接口(DescribeRegions)用于查询各个产品支持地域信息。

可能返回的错误码: 

INVALIDPARAMETER = "InvalidParameter"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DescribeZones 

func (c *Client) DescribeZones(request *DescribeZonesRequest) (response *DescribeZonesResponse, err error)

DescribeZones 本接口(DescribeZones)用于查询产品可用区信息。

可能返回的错误码: 

INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeZonesWithContext added in v1.0.324 

func (c *Client) DescribeZonesWithContext(ctx context.Context, request *DescribeZonesRequest) (response *DescribeZonesResponse, err error)

DescribeZones 本接口(DescribeZones)用于查询产品可用区信息。

可能返回的错误码: 

INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type DescribeProductsRequest added in v1.0.359 

type DescribeProductsRequest struct {
	*tchttp.BaseRequest

	// 返回数量，默认为 20，最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量，默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeProductsRequest added in v1.0.359 

func NewDescribeProductsRequest() (request *DescribeProductsRequest)

func (*DescribeProductsRequest) FromJsonString added in v1.0.359 

func (r *DescribeProductsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductsRequest) ToJsonString added in v1.0.359 

func (r *DescribeProductsRequest) ToJsonString() string

type DescribeProductsRequestParams added in v1.0.426 

type DescribeProductsRequestParams struct {
	// 返回数量，默认为 20，最大值为 100。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量，默认为 0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeProductsResponse added in v1.0.359 

type DescribeProductsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeProductsResponseParams `json:"Response"`
}

func NewDescribeProductsResponse added in v1.0.359 

func NewDescribeProductsResponse() (response *DescribeProductsResponse)

func (*DescribeProductsResponse) FromJsonString added in v1.0.359 

func (r *DescribeProductsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeProductsResponse) ToJsonString added in v1.0.359 

func (r *DescribeProductsResponse) ToJsonString() string

type DescribeProductsResponseParams added in v1.0.426 

type DescribeProductsResponseParams struct {
	// 产品详细信息列表。
	Products []*RegionProduct `json:"Products,omitnil,omitempty" name:"Products"`

	// 产品总数量。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRegionsRequest 

type DescribeRegionsRequest struct {
	*tchttp.BaseRequest

	// 待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`
}

func NewDescribeRegionsRequest 

func NewDescribeRegionsRequest() (request *DescribeRegionsRequest)

func (*DescribeRegionsRequest) FromJsonString 

func (r *DescribeRegionsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionsRequest) ToJsonString 

func (r *DescribeRegionsRequest) ToJsonString() string

type DescribeRegionsRequestParams added in v1.0.426 

type DescribeRegionsRequestParams struct {
	// 待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`
}

Predefined struct for user

type DescribeRegionsResponse 

type DescribeRegionsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegionsResponseParams `json:"Response"`
}

func NewDescribeRegionsResponse 

func NewDescribeRegionsResponse() (response *DescribeRegionsResponse)

func (*DescribeRegionsResponse) FromJsonString 

func (r *DescribeRegionsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeRegionsResponse) ToJsonString 

func (r *DescribeRegionsResponse) ToJsonString() string

type DescribeRegionsResponseParams added in v1.0.426 

type DescribeRegionsResponseParams struct {
	// 地域数量
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 地域列表信息
	RegionSet []*RegionInfo `json:"RegionSet,omitnil,omitempty" name:"RegionSet"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeZonesRequest 

type DescribeZonesRequest struct {
	*tchttp.BaseRequest

	// 待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`
}

func NewDescribeZonesRequest 

func NewDescribeZonesRequest() (request *DescribeZonesRequest)

func (*DescribeZonesRequest) FromJsonString 

func (r *DescribeZonesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeZonesRequest) ToJsonString 

func (r *DescribeZonesRequest) ToJsonString() string

type DescribeZonesRequestParams added in v1.0.426 

type DescribeZonesRequestParams struct {
	// 待查询产品的名称，例如cvm，具体取值请查询DescribeProducts接口
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`
}

Predefined struct for user

type DescribeZonesResponse 

type DescribeZonesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeZonesResponseParams `json:"Response"`
}

func NewDescribeZonesResponse 

func NewDescribeZonesResponse() (response *DescribeZonesResponse)

func (*DescribeZonesResponse) FromJsonString 

func (r *DescribeZonesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeZonesResponse) ToJsonString 

func (r *DescribeZonesResponse) ToJsonString() string

type DescribeZonesResponseParams added in v1.0.426 

type DescribeZonesResponseParams struct {
	// 可用区数量。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 可用区列表信息。
	ZoneSet []*ZoneInfo `json:"ZoneSet,omitnil,omitempty" name:"ZoneSet"`

	// 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RegionInfo 

type RegionInfo struct {
	// 地域名称，例如，ap-guangzhou
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// 地域描述，例如，华南地区(广州)
	RegionName *string `json:"RegionName,omitnil,omitempty" name:"RegionName"`

	// 地域是否可用状态
	RegionState *string `json:"RegionState,omitnil,omitempty" name:"RegionState"`

	// 控制台类型，api调用时默认null
	// 注意：此字段可能返回 null，表示取不到有效值。
	RegionTypeMC *int64 `json:"RegionTypeMC,omitnil,omitempty" name:"RegionTypeMC"`

	// 不同语言的地区
	// 注意：此字段可能返回 null，表示取不到有效值。
	LocationMC *string `json:"LocationMC,omitnil,omitempty" name:"LocationMC"`

	// 控制台展示的地域描述
	// 注意：此字段可能返回 null，表示取不到有效值。
	RegionNameMC *string `json:"RegionNameMC,omitnil,omitempty" name:"RegionNameMC"`

	// 控制台展示的RegionId
	// 注意：此字段可能返回 null，表示取不到有效值。
	RegionIdMC *string `json:"RegionIdMC,omitnil,omitempty" name:"RegionIdMC"`
}

type RegionProduct added in v1.0.359 

type RegionProduct struct {
	// 产品名称，如cvm
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

type ZoneInfo 

type ZoneInfo struct {
	// 可用区名称，例如，ap-guangzhou-3
	// 全网可用区名称如下：
	// <li> ap-chongqing-1 </li>
	// <li> ap-seoul-1 </li>
	// <li> ap-seoul-2 </li>
	// <li> ap-chengdu-1 </li>
	// <li> ap-chengdu-2 </li>
	// <li> ap-hongkong-1 </li>
	// <li> ap-hongkong-2 </li>
	// <li> ap-shenzhen-fsi-1 </li>
	// <li> ap-shenzhen-fsi-2 </li>
	// <li> ap-shenzhen-fsi-3 </li>
	// <li> ap-guangzhou-1（售罄）</li>
	// <li> ap-guangzhou-2（售罄）</li>
	// <li> ap-guangzhou-3 </li>
	// <li> ap-guangzhou-4 </li>
	// <li> ap-guangzhou-6 </li>
	// <li> ap-tokyo-1 </li>
	// <li> ap-singapore-1 </li>
	// <li> ap-singapore-2 </li>
	// <li> ap-shanghai-fsi-1 </li>
	// <li> ap-shanghai-fsi-2 </li>
	// <li> ap-shanghai-fsi-3 </li>
	// <li> ap-bangkok-1 </li>
	// <li> ap-shanghai-1（售罄） </li>
	// <li> ap-shanghai-2 </li>
	// <li> ap-shanghai-3 </li>
	// <li> ap-shanghai-4 </li>
	// <li> ap-shanghai-5 </li>
	// <li> ap-mumbai-1 </li>
	// <li> ap-mumbai-2 </li>
	// <li> eu-moscow-1 </li>
	// <li> ap-beijing-1 </li>
	// <li> ap-beijing-2 </li>
	// <li> ap-beijing-3 </li>
	// <li> ap-beijing-4 </li>
	// <li> ap-beijing-5 </li>
	// <li> na-siliconvalley-1 </li>
	// <li> na-siliconvalley-2 </li>
	// <li> eu-frankfurt-1 </li>
	// <li> na-toronto-1 </li>
	// <li> na-ashburn-1 </li>
	// <li> na-ashburn-2 </li>
	// <li> ap-nanjing-1 </li>
	// <li> ap-nanjing-2 </li>
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 可用区描述，例如，广州三区
	ZoneName *string `json:"ZoneName,omitnil,omitempty" name:"ZoneName"`

	// 可用区ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 可用区状态，包含AVAILABLE和UNAVAILABLE。AVAILABLE代表可用，UNAVAILABLE代表不可用。
	ZoneState *string `json:"ZoneState,omitnil,omitempty" name:"ZoneState"`

	// 父级zone
	// 注意：此字段可能返回 null，表示取不到有效值。
	ParentZone *string `json:"ParentZone,omitnil,omitempty" name:"ParentZone"`

	// 父级可用区ID
	// 注意：此字段可能返回 null，表示取不到有效值。
	ParentZoneId *string `json:"ParentZoneId,omitnil,omitempty" name:"ParentZoneId"`

	// 父级可用区描述
	// 注意：此字段可能返回 null，表示取不到有效值。
	ParentZoneName *string `json:"ParentZoneName,omitnil,omitempty" name:"ParentZoneName"`

	// zone类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	ZoneType *string `json:"ZoneType,omitnil,omitempty" name:"ZoneType"`

	// 控制台类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	MachineRoomTypeMC *string `json:"MachineRoomTypeMC,omitnil,omitempty" name:"MachineRoomTypeMC"`

	// 和ZoneId一样，适用于控制台调用
	// 注意：此字段可能返回 null，表示取不到有效值。
	ZoneIdMC *string `json:"ZoneIdMC,omitnil,omitempty" name:"ZoneIdMC"`
}

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.