v20230306

Documentation

Index

• Constants
• type Client
  • func NewClient(credential common.CredentialIface, region string, ...) (client *Client, err error)
  • func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)
  • func (c *Client) DescribeEvents(request *DescribeEventsRequest) (response *DescribeEventsResponse, err error)
  • func (c *Client) DescribeEventsWithContext(ctx context.Context, request *DescribeEventsRequest) (response *DescribeEventsResponse, err error)
• type DescribeEventsRequest
  • func NewDescribeEventsRequest() (request *DescribeEventsRequest)
  • func (r *DescribeEventsRequest) FromJsonString(s string) error
  • func (r *DescribeEventsRequest) ToJsonString() string
• type DescribeEventsRequestParams
• type DescribeEventsResponse
  • func NewDescribeEventsResponse() (response *DescribeEventsResponse)
  • func (r *DescribeEventsResponse) FromJsonString(s string) error
  • func (r *DescribeEventsResponse) ToJsonString() string
• type DescribeEventsResponseParams
• type EventDetail
• type ProductEventList

Constants

const (

	// Internal error.
	INTERNALERROR = "InternalError"

	// Incorrect parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"
)

const APIVersion = "2023-03-06"

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) DescribeEvents

func (c *Client) DescribeEvents(request *DescribeEventsRequest) (response *DescribeEventsResponse, err error)

DescribeEvents This API is used to query the availability event list of tencent cloud services. It can be filtered by product, region, or event occurrence date.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeEventsWithContext

func (c *Client) DescribeEventsWithContext(ctx context.Context, request *DescribeEventsRequest) (response *DescribeEventsResponse, err error)

DescribeEvents This API is used to query the availability event list of tencent cloud services. It can be filtered by product, region, or event occurrence date.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

type DescribeEventsRequest

type DescribeEventsRequest struct {
	*tchttp.BaseRequest

	// event occurrence date
	EventDate *string `json:"EventDate,omitempty" name:"EventDate"`

	// Query by Product ID(s). Product ID examples: cvm, lb, cdb, cdn, crs.
	ProductIds []*string `json:"ProductIds,omitempty" name:"ProductIds"`

	//  1. Query by Region ID(s). Region ID examples: ap-guangzhou、ap-shanghai、ap-singapore.
	// 2. The region ID for non-region-specific products should be set to non-regional.
	RegionIds []*string `json:"RegionIds,omitempty" name:"RegionIds"`
}

func NewDescribeEventsRequest

func NewDescribeEventsRequest() (request *DescribeEventsRequest)

func (*DescribeEventsRequest) FromJsonString

func (r *DescribeEventsRequest) 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 (*DescribeEventsRequest) ToJsonString

func (r *DescribeEventsRequest) ToJsonString() string

type DescribeEventsRequestParams

type DescribeEventsRequestParams struct {
	// event occurrence date
	EventDate *string `json:"EventDate,omitempty" name:"EventDate"`

	// Query by Product ID(s). Product ID examples: cvm, lb, cdb, cdn, crs.
	ProductIds []*string `json:"ProductIds,omitempty" name:"ProductIds"`

	//  1. Query by Region ID(s). Region ID examples: ap-guangzhou、ap-shanghai、ap-singapore.
	// 2. The region ID for non-region-specific products should be set to non-regional.
	RegionIds []*string `json:"RegionIds,omitempty" name:"RegionIds"`
}

Predefined struct for user

type DescribeEventsResponse

type DescribeEventsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeEventsResponseParams `json:"Response"`
}

func NewDescribeEventsResponse

func NewDescribeEventsResponse() (response *DescribeEventsResponse)

func (*DescribeEventsResponse) FromJsonString

func (r *DescribeEventsResponse) 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 (*DescribeEventsResponse) ToJsonString

func (r *DescribeEventsResponse) ToJsonString() string

type DescribeEventsResponseParams

type DescribeEventsResponseParams struct {
	// Detailed event information.
	Data *ProductEventList `json:"Data,omitempty" name:"Data"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type EventDetail

type EventDetail struct {
	// Product ID.
	ProductId *string `json:"ProductId,omitempty" name:"ProductId"`

	// Product name.
	ProductName *string `json:"ProductName,omitempty" name:"ProductName"`

	// Region ID.
	RegionId *string `json:"RegionId,omitempty" name:"RegionId"`

	// Region name.
	RegionName *string `json:"RegionName,omitempty" name:"RegionName"`

	// Event start time.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// Event end time. If the event is still ongoing and has not ended, the end time will be empty.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Current status: Normally, Informational, Degradation.
	CurrentStatus *string `json:"CurrentStatus,omitempty" name:"CurrentStatus"`
}

type ProductEventList

type ProductEventList struct {
	// Detailed event information.
	// Note: this field may return null, indicating that no valid value is obtained.
	EventList []*EventDetail `json:"EventList,omitempty" name:"EventList"`
}