v20220106

package
v1.0.941 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2024 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Index

Constants

View Source 
const (

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 后台处理出错。
	INTERNALERROR_BACKENDERROR = "InternalError.BackendError"

	// 获取配置失败。
	INTERNALERROR_DOMAINCONFIG = "InternalError.DomainConfig"

	// 上传链接生成失败。
	INTERNALERROR_FAILEDTOGENERATEURL = "InternalError.FailedToGenerateUrl"

	// 配额系统处理失败。
	INTERNALERROR_QUOTASYSTEM = "InternalError.QuotaSystem"

	// 后端服务路由地址错误。
	INTERNALERROR_ROUTEERROR = "InternalError.RouteError"

	// 域名不存在或不属于该账号。
	INVALIDPARAMETER_DOMAINNOTFOUND = "InvalidParameter.DomainNotFound"

	// 参数错误: 无效 "结束时间", 不在允许的查询范围内: [开始时间, 开始+ 7天]
	INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"

	// 资源存在错误。
	INVALIDPARAMETER_TARGET = "InvalidParameter.Target"

	// 任务无法生成。
	INVALIDPARAMETER_TASKNOTGENERATED = "InvalidParameter.TaskNotGenerated"

	// 文件上传链接存在问题。
	INVALIDPARAMETER_UPLOADURL = "InvalidParameter.UploadUrl"

	// 本次提交的资源数超过上限。
	LIMITEXCEEDED_BATCHQUOTA = "LimitExceeded.BatchQuota"

	// 当天提交的资源数超过上限。
	LIMITEXCEEDED_DAILYQUOTA = "LimitExceeded.DailyQuota"

	// 操作被拒绝。
	OPERATIONDENIED = "OperationDenied"

	// Cam 未授权。
	UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"

	// 鉴权错误。
	UNAUTHORIZEDOPERATION_DOMAINEMPTY = "UnauthorizedOperation.DomainEmpty"

	// 子账户没有操作权限，请添加权限后继续操作。
	UNAUTHORIZEDOPERATION_NOPERMISSION = "UnauthorizedOperation.NoPermission"
)
View Source 
const APIVersion = "2022-01-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) CreatePrefetchTask added in v1.0.394 

func (c *Client) CreatePrefetchTask(request *CreatePrefetchTaskRequest) (response *CreatePrefetchTaskResponse, err error)

CreatePrefetchTask 创建预热任务

可能返回的错误码: 

INTERNALERROR_BACKENDERROR = "InternalError.BackendError"
INTERNALERROR_DOMAINCONFIG = "InternalError.DomainConfig"
INTERNALERROR_FAILEDTOGENERATEURL = "InternalError.FailedToGenerateUrl"
INTERNALERROR_QUOTASYSTEM = "InternalError.QuotaSystem"
INVALIDPARAMETER_DOMAINNOTFOUND = "InvalidParameter.DomainNotFound"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
INVALIDPARAMETER_TARGET = "InvalidParameter.Target"
INVALIDPARAMETER_TASKNOTGENERATED = "InvalidParameter.TaskNotGenerated"
INVALIDPARAMETER_UPLOADURL = "InvalidParameter.UploadUrl"
LIMITEXCEEDED_BATCHQUOTA = "LimitExceeded.BatchQuota"
LIMITEXCEEDED_DAILYQUOTA = "LimitExceeded.DailyQuota"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"

func (*Client) CreatePrefetchTaskWithContext added in v1.0.394 

func (c *Client) CreatePrefetchTaskWithContext(ctx context.Context, request *CreatePrefetchTaskRequest) (response *CreatePrefetchTaskResponse, err error)

CreatePrefetchTask 创建预热任务

可能返回的错误码: 

INTERNALERROR_BACKENDERROR = "InternalError.BackendError"
INTERNALERROR_DOMAINCONFIG = "InternalError.DomainConfig"
INTERNALERROR_FAILEDTOGENERATEURL = "InternalError.FailedToGenerateUrl"
INTERNALERROR_QUOTASYSTEM = "InternalError.QuotaSystem"
INVALIDPARAMETER_DOMAINNOTFOUND = "InvalidParameter.DomainNotFound"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
INVALIDPARAMETER_TARGET = "InvalidParameter.Target"
INVALIDPARAMETER_TASKNOTGENERATED = "InvalidParameter.TaskNotGenerated"
INVALIDPARAMETER_UPLOADURL = "InvalidParameter.UploadUrl"
LIMITEXCEEDED_BATCHQUOTA = "LimitExceeded.BatchQuota"
LIMITEXCEEDED_DAILYQUOTA = "LimitExceeded.DailyQuota"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"

func (*Client) CreatePurgeTask 

func (c *Client) CreatePurgeTask(request *CreatePurgeTaskRequest) (response *CreatePurgeTaskResponse, err error)

CreatePurgeTask 创建清除缓存任务

可能返回的错误码: 

INTERNALERROR_BACKENDERROR = "InternalError.BackendError"
INTERNALERROR_DOMAINCONFIG = "InternalError.DomainConfig"
INTERNALERROR_QUOTASYSTEM = "InternalError.QuotaSystem"
INVALIDPARAMETER_DOMAINNOTFOUND = "InvalidParameter.DomainNotFound"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
INVALIDPARAMETER_TARGET = "InvalidParameter.Target"
INVALIDPARAMETER_TASKNOTGENERATED = "InvalidParameter.TaskNotGenerated"
INVALIDPARAMETER_UPLOADURL = "InvalidParameter.UploadUrl"
LIMITEXCEEDED_BATCHQUOTA = "LimitExceeded.BatchQuota"
LIMITEXCEEDED_DAILYQUOTA = "LimitExceeded.DailyQuota"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"
UNAUTHORIZEDOPERATION_NOPERMISSION = "UnauthorizedOperation.NoPermission"

func (*Client) CreatePurgeTaskWithContext 

func (c *Client) CreatePurgeTaskWithContext(ctx context.Context, request *CreatePurgeTaskRequest) (response *CreatePurgeTaskResponse, err error)

CreatePurgeTask 创建清除缓存任务

可能返回的错误码: 

INTERNALERROR_BACKENDERROR = "InternalError.BackendError"
INTERNALERROR_DOMAINCONFIG = "InternalError.DomainConfig"
INTERNALERROR_QUOTASYSTEM = "InternalError.QuotaSystem"
INVALIDPARAMETER_DOMAINNOTFOUND = "InvalidParameter.DomainNotFound"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
INVALIDPARAMETER_TARGET = "InvalidParameter.Target"
INVALIDPARAMETER_TASKNOTGENERATED = "InvalidParameter.TaskNotGenerated"
INVALIDPARAMETER_UPLOADURL = "InvalidParameter.UploadUrl"
LIMITEXCEEDED_BATCHQUOTA = "LimitExceeded.BatchQuota"
LIMITEXCEEDED_DAILYQUOTA = "LimitExceeded.DailyQuota"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"
UNAUTHORIZEDOPERATION_NOPERMISSION = "UnauthorizedOperation.NoPermission"

func (*Client) DescribePrefetchTasks added in v1.0.394 

func (c *Client) DescribePrefetchTasks(request *DescribePrefetchTasksRequest) (response *DescribePrefetchTasksResponse, err error)

DescribePrefetchTasks 查询预热任务状态

可能返回的错误码: 

INTERNALERROR = "InternalError"
INTERNALERROR_ROUTEERROR = "InternalError.RouteError"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_DOMAINEMPTY = "UnauthorizedOperation.DomainEmpty"

func (*Client) DescribePrefetchTasksWithContext added in v1.0.394 

func (c *Client) DescribePrefetchTasksWithContext(ctx context.Context, request *DescribePrefetchTasksRequest) (response *DescribePrefetchTasksResponse, err error)

DescribePrefetchTasks 查询预热任务状态

可能返回的错误码: 

INTERNALERROR = "InternalError"
INTERNALERROR_ROUTEERROR = "InternalError.RouteError"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_DOMAINEMPTY = "UnauthorizedOperation.DomainEmpty"

func (*Client) DescribePurgeTasks 

func (c *Client) DescribePurgeTasks(request *DescribePurgeTasksRequest) (response *DescribePurgeTasksResponse, err error)

DescribePurgeTasks 查询清除缓存历史记录

可能返回的错误码: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
OPERATIONDENIED = "OperationDenied"

func (*Client) DescribePurgeTasksWithContext 

func (c *Client) DescribePurgeTasksWithContext(ctx context.Context, request *DescribePurgeTasksRequest) (response *DescribePurgeTasksResponse, err error)

DescribePurgeTasks 查询清除缓存历史记录

可能返回的错误码: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PARAMETERERROR = "InvalidParameter.ParameterError"
OPERATIONDENIED = "OperationDenied"

func (*Client) DescribeZones added in v1.0.393 

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

DescribeZones 用户查询用户站点信息列表，支持分页

可能返回的错误码: 

OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"
UNAUTHORIZEDOPERATION_NOPERMISSION = "UnauthorizedOperation.NoPermission"

func (*Client) DescribeZonesWithContext added in v1.0.393 

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

DescribeZones 用户查询用户站点信息列表，支持分页

可能返回的错误码: 

OPERATIONDENIED = "OperationDenied"
UNAUTHORIZEDOPERATION_CAMUNAUTHORIZED = "UnauthorizedOperation.CamUnauthorized"
UNAUTHORIZEDOPERATION_NOPERMISSION = "UnauthorizedOperation.NoPermission"

type CreatePrefetchTaskRequest added in v1.0.394 

type CreatePrefetchTaskRequest struct {
	*tchttp.BaseRequest

	// Zone ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 要预热的资源列表，每个元素格式类似如下:
	// http://www.example.com/example.txt
	Targets []*string `json:"Targets,omitnil,omitempty" name:"Targets"`

	// 是否对url进行encode
	// 若内容含有非 ASCII 字符集的字符，请开启此开关，编码转换（编码规则遵循 RFC3986）
	EncodeUrl *bool `json:"EncodeUrl,omitnil,omitempty" name:"EncodeUrl"`

	// 附带的http头部信息
	Headers []*Header `json:"Headers,omitnil,omitempty" name:"Headers"`
}

func NewCreatePrefetchTaskRequest added in v1.0.394 

func NewCreatePrefetchTaskRequest() (request *CreatePrefetchTaskRequest)

func (*CreatePrefetchTaskRequest) FromJsonString added in v1.0.394 

func (r *CreatePrefetchTaskRequest) 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 (*CreatePrefetchTaskRequest) ToJsonString added in v1.0.394 

func (r *CreatePrefetchTaskRequest) ToJsonString() string

type CreatePrefetchTaskRequestParams added in v1.0.426 

type CreatePrefetchTaskRequestParams struct {
	// Zone ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 要预热的资源列表，每个元素格式类似如下:
	// http://www.example.com/example.txt
	Targets []*string `json:"Targets,omitnil,omitempty" name:"Targets"`

	// 是否对url进行encode
	// 若内容含有非 ASCII 字符集的字符，请开启此开关，编码转换（编码规则遵循 RFC3986）
	EncodeUrl *bool `json:"EncodeUrl,omitnil,omitempty" name:"EncodeUrl"`

	// 附带的http头部信息
	Headers []*Header `json:"Headers,omitnil,omitempty" name:"Headers"`
}

Predefined struct for user

type CreatePrefetchTaskResponse added in v1.0.394 

type CreatePrefetchTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreatePrefetchTaskResponseParams `json:"Response"`
}

func NewCreatePrefetchTaskResponse added in v1.0.394 

func NewCreatePrefetchTaskResponse() (response *CreatePrefetchTaskResponse)

func (*CreatePrefetchTaskResponse) FromJsonString added in v1.0.394 

func (r *CreatePrefetchTaskResponse) 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 (*CreatePrefetchTaskResponse) ToJsonString added in v1.0.394 

func (r *CreatePrefetchTaskResponse) ToJsonString() string

type CreatePrefetchTaskResponseParams added in v1.0.426 

type CreatePrefetchTaskResponseParams struct {
	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 失败的任务列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	FailedList []*FailReason `json:"FailedList,omitnil,omitempty" name:"FailedList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreatePurgeTaskRequest 

type CreatePurgeTaskRequest struct {
	*tchttp.BaseRequest

	// Zone ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 类型，当前支持的类型：
	// - purge_url：URL
	// - purge_prefix：前缀
	// - purge_host：Hostname
	// - purge_all：全部缓存
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 要刷新的资源列表，每个元素格式依据Type而定
	// 1) Type = purge_host 时
	// 形如：www.example.com 或 foo.bar.example.com
	// 2) Type = purge_prefix 时
	// 形如：http://www.example.com/example
	// 3) Type = purge_url 时
	// 形如：https://www.example.com/example.jpg
	// 4）Type = purge_all 时
	// Targets可为空，不需要填写
	Targets []*string `json:"Targets,omitnil,omitempty" name:"Targets"`

	// 若有编码转换，仅清除编码转换后匹配的资源
	// 若内容含有非 ASCII 字符集的字符，请开启此开关，编码转换（编码规则遵循 RFC3986）
	EncodeUrl *bool `json:"EncodeUrl,omitnil,omitempty" name:"EncodeUrl"`
}

func NewCreatePurgeTaskRequest 

func NewCreatePurgeTaskRequest() (request *CreatePurgeTaskRequest)

func (*CreatePurgeTaskRequest) FromJsonString 

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

func (r *CreatePurgeTaskRequest) ToJsonString() string

type CreatePurgeTaskRequestParams added in v1.0.426 

type CreatePurgeTaskRequestParams struct {
	// Zone ID
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 类型，当前支持的类型：
	// - purge_url：URL
	// - purge_prefix：前缀
	// - purge_host：Hostname
	// - purge_all：全部缓存
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 要刷新的资源列表，每个元素格式依据Type而定
	// 1) Type = purge_host 时
	// 形如：www.example.com 或 foo.bar.example.com
	// 2) Type = purge_prefix 时
	// 形如：http://www.example.com/example
	// 3) Type = purge_url 时
	// 形如：https://www.example.com/example.jpg
	// 4）Type = purge_all 时
	// Targets可为空，不需要填写
	Targets []*string `json:"Targets,omitnil,omitempty" name:"Targets"`

	// 若有编码转换，仅清除编码转换后匹配的资源
	// 若内容含有非 ASCII 字符集的字符，请开启此开关，编码转换（编码规则遵循 RFC3986）
	EncodeUrl *bool `json:"EncodeUrl,omitnil,omitempty" name:"EncodeUrl"`
}

Predefined struct for user

type CreatePurgeTaskResponse 

type CreatePurgeTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreatePurgeTaskResponseParams `json:"Response"`
}

func NewCreatePurgeTaskResponse 

func NewCreatePurgeTaskResponse() (response *CreatePurgeTaskResponse)

func (*CreatePurgeTaskResponse) FromJsonString 

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

func (r *CreatePurgeTaskResponse) ToJsonString() string

type CreatePurgeTaskResponseParams added in v1.0.426 

type CreatePurgeTaskResponseParams struct {
	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 失败的任务列表及原因
	// 注意：此字段可能返回 null，表示取不到有效值。
	FailedList []*FailReason `json:"FailedList,omitnil,omitempty" name:"FailedList"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePrefetchTasksRequest added in v1.0.394 

type DescribePrefetchTasksRequest struct {
	*tchttp.BaseRequest

	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 查询起始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 查询起始偏移量
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 查询最大返回的结果条数
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询的状态
	// 允许的值为：processing、success、failed、timeout、invalid
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// zone id
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 查询的域名列表
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 查询的资源
	Target *string `json:"Target,omitnil,omitempty" name:"Target"`
}

func NewDescribePrefetchTasksRequest added in v1.0.394 

func NewDescribePrefetchTasksRequest() (request *DescribePrefetchTasksRequest)

func (*DescribePrefetchTasksRequest) FromJsonString added in v1.0.394 

func (r *DescribePrefetchTasksRequest) 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 (*DescribePrefetchTasksRequest) ToJsonString added in v1.0.394 

func (r *DescribePrefetchTasksRequest) ToJsonString() string

type DescribePrefetchTasksRequestParams added in v1.0.426 

type DescribePrefetchTasksRequestParams struct {
	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 查询起始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 查询起始偏移量
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 查询最大返回的结果条数
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询的状态
	// 允许的值为：processing、success、failed、timeout、invalid
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// zone id
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 查询的域名列表
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 查询的资源
	Target *string `json:"Target,omitnil,omitempty" name:"Target"`
}

Predefined struct for user

type DescribePrefetchTasksResponse added in v1.0.394 

type DescribePrefetchTasksResponse struct {
	*tchttp.BaseResponse
	Response *DescribePrefetchTasksResponseParams `json:"Response"`
}

func NewDescribePrefetchTasksResponse added in v1.0.394 

func NewDescribePrefetchTasksResponse() (response *DescribePrefetchTasksResponse)

func (*DescribePrefetchTasksResponse) FromJsonString added in v1.0.394 

func (r *DescribePrefetchTasksResponse) 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 (*DescribePrefetchTasksResponse) ToJsonString added in v1.0.394 

func (r *DescribePrefetchTasksResponse) ToJsonString() string

type DescribePrefetchTasksResponseParams added in v1.0.426 

type DescribePrefetchTasksResponseParams struct {
	// 该查询条件总共条目数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 任务结果列表
	Tasks []*Task `json:"Tasks,omitnil,omitempty" name:"Tasks"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribePurgeTasksRequest 

type DescribePurgeTasksRequest struct {
	*tchttp.BaseRequest

	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 类型
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 查询起始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 查询起始偏移量
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 查询最大返回的结果条数
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询的状态
	// 允许的值为：processing、success、failed、timeout、invalid
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// zone id
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 查询的域名列表
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 查询内容
	Target *string `json:"Target,omitnil,omitempty" name:"Target"`
}

func NewDescribePurgeTasksRequest 

func NewDescribePurgeTasksRequest() (request *DescribePurgeTasksRequest)

func (*DescribePurgeTasksRequest) FromJsonString 

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

func (r *DescribePurgeTasksRequest) ToJsonString() string

type DescribePurgeTasksRequestParams added in v1.0.426 

type DescribePurgeTasksRequestParams struct {
	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 类型
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 查询起始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 查询结束时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 查询起始偏移量
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 查询最大返回的结果条数
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询的状态
	// 允许的值为：processing、success、failed、timeout、invalid
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// zone id
	ZoneId *string `json:"ZoneId,omitnil,omitempty" name:"ZoneId"`

	// 查询的域名列表
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 查询内容
	Target *string `json:"Target,omitnil,omitempty" name:"Target"`
}

Predefined struct for user

type DescribePurgeTasksResponse 

type DescribePurgeTasksResponse struct {
	*tchttp.BaseResponse
	Response *DescribePurgeTasksResponseParams `json:"Response"`
}

func NewDescribePurgeTasksResponse 

func NewDescribePurgeTasksResponse() (response *DescribePurgeTasksResponse)

func (*DescribePurgeTasksResponse) FromJsonString 

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

func (r *DescribePurgeTasksResponse) ToJsonString() string

type DescribePurgeTasksResponseParams added in v1.0.426 

type DescribePurgeTasksResponseParams struct {
	// 该查询条件总共条目数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 任务结果列表
	Tasks []*Task `json:"Tasks,omitnil,omitempty" name:"Tasks"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeZonesRequest added in v1.0.393 

type DescribeZonesRequest struct {
	*tchttp.BaseRequest

	// 分页查询偏移量。默认值：0，最小值：0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页查询限制数目。默认值：1000，最大值：1000。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询条件过滤器，复杂类型。
	Filters []*ZoneFilter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

func NewDescribeZonesRequest added in v1.0.393 

func NewDescribeZonesRequest() (request *DescribeZonesRequest)

func (*DescribeZonesRequest) FromJsonString added in v1.0.393 

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 added in v1.0.393 

func (r *DescribeZonesRequest) ToJsonString() string

type DescribeZonesRequestParams added in v1.0.426 

type DescribeZonesRequestParams struct {
	// 分页查询偏移量。默认值：0，最小值：0。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页查询限制数目。默认值：1000，最大值：1000。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 查询条件过滤器，复杂类型。
	Filters []*ZoneFilter `json:"Filters,omitnil,omitempty" name:"Filters"`
}

Predefined struct for user

type DescribeZonesResponse added in v1.0.393 

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

func NewDescribeZonesResponse added in v1.0.393 

func NewDescribeZonesResponse() (response *DescribeZonesResponse)

func (*DescribeZonesResponse) FromJsonString added in v1.0.393 

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 added in v1.0.393 

func (r *DescribeZonesResponse) ToJsonString() string

type DescribeZonesResponseParams added in v1.0.426 

type DescribeZonesResponseParams struct {
	// 符合条件的站点个数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 站点详细信息列表。
	Zones []*Zone `json:"Zones,omitnil,omitempty" name:"Zones"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type FailReason 

type FailReason struct {
	// 失败原因
	Reason *string `json:"Reason,omitnil,omitempty" name:"Reason"`

	// 处理失败的资源列表。
	// 该列表元素来源于输入参数中的Targets，因此格式和入参中的Targets保持一致
	Targets []*string `json:"Targets,omitnil,omitempty" name:"Targets"`
}
type Header struct {
	// HTTP头部
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// HTTP头部值
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type Resource added in v1.0.452 

type Resource struct {
	// 资源 ID。
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 付费模式，取值有：
	// <li>0：后付费。</li>
	PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 创建时间。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 生效时间。
	EnableTime *string `json:"EnableTime,omitnil,omitempty" name:"EnableTime"`

	// 失效时间。
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// 套餐状态，取值有：
	// <li>normal：正常；</li>
	// <li>isolated：隔离；</li>
	// <li>destroyed：销毁。</li>
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 询价参数。
	Sv []*Sv `json:"Sv,omitnil,omitempty" name:"Sv"`

	// 是否自动续费，取值有：
	// <li>0：默认状态；</li>
	// <li>1：自动续费；</li>
	// <li>2：不自动续费。</li>
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// 套餐关联资源 ID。
	PlanId *string `json:"PlanId,omitnil,omitempty" name:"PlanId"`

	// 地域，取值有：
	// <li>mainland：国内；</li>
	// <li>overseas：海外。</li>
	Area *string `json:"Area,omitnil,omitempty" name:"Area"`
}

type Sv added in v1.0.452 

type Sv struct {
	// 询价参数键。
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

	// 询价参数值。
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type Tag added in v1.0.440 

type Tag struct {
	// 标签键
	// 注意：此字段可能返回 null，表示取不到有效值。
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

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

type Task 

type Task struct {
	// 任务ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// 状态
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 资源
	Target *string `json:"Target,omitnil,omitempty" name:"Target"`

	// 任务类型
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 任务创建时间
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 任务完成时间
	UpdateTime *string `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`
}

type Zone added in v1.0.393 

type Zone struct {
	// 站点ID。
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 站点名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 站点当前使用的 NS 列表。
	OriginalNameServers []*string `json:"OriginalNameServers,omitnil,omitempty" name:"OriginalNameServers"`

	// 腾讯云分配的 NS 列表。
	NameServers []*string `json:"NameServers,omitnil,omitempty" name:"NameServers"`

	// 站点状态，取值有：
	// <li> active：NS 已切换； </li>
	// <li> pending：NS 未切换；</li>
	// <li> moved：NS 已切走；</li>
	// <li> deactivated：被封禁。 </li>
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 站点接入方式，取值有
	// <li> full：NS 接入； </li>
	// <li> partial：CNAME 接入。</li>
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 站点是否关闭。
	Paused *bool `json:"Paused,omitnil,omitempty" name:"Paused"`

	// 是否开启cname加速，取值有：
	// <li> enabled：开启；</li>
	// <li> disabled：关闭。</li>
	CnameSpeedUp *string `json:"CnameSpeedUp,omitnil,omitempty" name:"CnameSpeedUp"`

	// cname 接入状态，取值有：
	// <li> finished：站点已验证；</li>
	// <li> pending：站点验证中。</li>
	CnameStatus *string `json:"CnameStatus,omitnil,omitempty" name:"CnameStatus"`

	// 资源标签列表。
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 计费资源列表。
	Resources []*Resource `json:"Resources,omitnil,omitempty" name:"Resources"`

	// 站点创建时间。
	CreatedOn *string `json:"CreatedOn,omitnil,omitempty" name:"CreatedOn"`

	// 站点修改时间。
	ModifiedOn *string `json:"ModifiedOn,omitnil,omitempty" name:"ModifiedOn"`

	// 站点接入地域，取值为：
	// <li> global：全球；</li>
	// <li> mainland：中国大陆；</li>
	// <li> overseas：境外区域。</li>
	Area *string `json:"Area,omitnil,omitempty" name:"Area"`
}

type ZoneFilter added in v1.0.393 

type ZoneFilter struct {
	// 过滤字段名，支持的列表如下：
	// <li> name：站点名；</li>
	// <li> status：站点状态；</li>
	// <li> tagKey：标签键；</li>
	// <li> tagValue: 标签值。</li>
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 过滤字段值。
	Values []*string `json:"Values,omitnil,omitempty" name:"Values"`

	// 是否启用模糊查询，仅支持过滤字段名为name。模糊查询时，Values长度最大为1。默认为false。
	Fuzzy *bool `json:"Fuzzy,omitnil,omitempty" name:"Fuzzy"`
}

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.