imagex

package
v1.0.140 Latest Latest
Warning

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

Go to latest
Published: Jan 29, 2024 License: Apache-2.0 Imports: 17 Imported by: 3

Documentation

Index

Constants

View Source
const (
	ServiceName    = "ImageX"
	DefaultTimeout = 10 * time.Second
)
View Source
const (
	ResourceServiceIdTRN = "trn:ImageX:*:*:ServiceId/%s"
	ResourceStoreKeyTRN  = "trn:ImageX:*:*:StoreKeys/%s"

	MinChunkSize   = 1024 * 1024 * 20
	LargeFileSize  = 1024 * 1024 * 1024
	UploadRoutines = 4
)

Variables

View Source
var (
	ServiceInfoMap = map[string]common.ServiceInfo{
		"cn-north-1": {
			Timeout: DefaultTimeout,
			Scheme:  "https",
			Host:    "imagex.volcengineapi.com",
			Header: http.Header{
				"Accept": []string{"application/json"},
			},
			Credentials: common.Credentials{
				Region:  "cn-north-1",
				Service: ServiceName,
			},
		},
		"ap-singapore-1": {
			Timeout: DefaultTimeout,
			Scheme:  "https",
			Host:    "imagex-ap-singapore-1.volcengineapi.com",
			Header: http.Header{
				"Accept": []string{"application/json"},
			},
			Credentials: common.Credentials{
				Region:  "ap-singapore-1",
				Service: ServiceName,
			},
		},
		"us-east-1": {
			Timeout: DefaultTimeout,
			Scheme:  "https",
			Host:    "imagex-us-east-1.volcengineapi.com",
			Header: http.Header{
				"Accept": []string{"application/json"},
			},
			Credentials: common.Credentials{
				Region:  "us-east-1",
				Service: ServiceName,
			},
		},
	}
	ApiListInfo = map[string]*common.ApiInfo{}/* 166 elements not displayed */

)
View Source
var DefaultInstance = NewInstance()

Functions

This section is empty.

Types

type ApplyImageUpload added in v1.0.140

type ApplyImageUpload struct{}

type ApplyImageUploadBody added in v1.0.140

type ApplyImageUploadBody struct{}

type ApplyImageUploadQuery added in v1.0.140

type ApplyImageUploadQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 文件扩展名(如:.java, .txt, .go 等),最大长度限制为 8 个字节。 :::tip 仅当未指定StoreKeys时生效。 :::
	FileExtension string `json:"FileExtension,omitempty" query:"FileExtension"`

	// 覆盖上传
	Overwrite bool `json:"Overwrite,omitempty" query:"Overwrite"`

	// 指定的上传文件路径。
	// * 指定Prefix时,下发的存储 Key 为:Prefix/{随机Key}{FileExtension},其中Prefix + FileExtension最大长度限制为 145 个字节。
	// * 不支持以/开头或结尾,不支持/连续出现。 :::tip 仅当未指定StoreKeys时生效。 :::
	Prefix string `json:"Prefix,omitempty" query:"Prefix"`

	// 一次上传会话 Key。 :::tip 本接口上一次请求的SessionKey,可在重试时带上,作为服务端的再次选路时的一个参考。 :::
	SessionKey string `json:"SessionKey,omitempty" query:"SessionKey"`

	// 上传文件的存储 Key。默认使用随机生成的字符串作为存储 Key。
	// * 数组长度和UploadNum保持一致。
	// * 不支持空格,如果中间有空格将会导致上传失败。
	// * 不支持以/开头或结尾,不支持/连续出现,Key 值最大长度限制为 180 个字节。 :::tip 仅对于 veImageX 上传场景生效。 :::
	StoreKeys []string `json:"StoreKeys,omitempty" query:"StoreKeys"`

	// 上传文件的数量,将决定下发的 StoreUri 的数量,取值范围为[1,10],默认为 1。
	UploadNum int `json:"UploadNum,omitempty" query:"UploadNum"`
}

type ApplyImageUploadReq added in v1.0.140

type ApplyImageUploadReq struct {
	*ApplyImageUploadQuery
	*ApplyImageUploadBody
}

type ApplyImageUploadRes added in v1.0.140

type ApplyImageUploadRes struct {

	// REQUIRED
	ResponseMetadata *ApplyImageUploadResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *ApplyImageUploadResResult `json:"Result"`
}

type ApplyImageUploadResResponseMetadata added in v1.0.140

type ApplyImageUploadResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string                                    `json:"Version"`
	Error   *ApplyImageUploadResResponseMetadataError `json:"Error,omitempty"`
}

type ApplyImageUploadResResponseMetadataError added in v1.0.140

type ApplyImageUploadResResponseMetadataError struct {

	// REQUIRED; 错误码
	Code string `json:"Code"`

	// REQUIRED; 错误信息
	Message string `json:"Message"`
}

type ApplyImageUploadResResult added in v1.0.140

type ApplyImageUploadResResult struct {

	// REQUIRED; 请求的唯一标识 ID。
	RequestID string `json:"RequestId"`

	// REQUIRED; 上传地址
	UploadAddress *ApplyImageUploadResResultUploadAddress `json:"UploadAddress"`
}

type ApplyImageUploadResResultUploadAddress added in v1.0.140

type ApplyImageUploadResResultUploadAddress struct {

	// REQUIRED; 一次上传会话 Key。
	// 上传完成上报时使用该值,该 Key 可以在解码后提取信息及参数校验。
	SessionKey string `json:"SessionKey"`

	// REQUIRED; 上传 Uri
	// 数量由请求参数中的 UploadNum 决定。
	StoreInfos []*ApplyImageUploadResResultUploadAddressStoreInfosItem `json:"StoreInfos"`

	// REQUIRED; 上传域名列表,可以用于客户端容灾,并行上传等。
	UploadHosts []string `json:"UploadHosts"`
}

ApplyImageUploadResResultUploadAddress - 上传地址

type ApplyImageUploadResResultUploadAddressStoreInfosItem added in v1.0.140

type ApplyImageUploadResResultUploadAddressStoreInfosItem struct {

	// REQUIRED; 上传凭证
	Auth string `json:"Auth"`

	// REQUIRED; 资源 URI
	StoreURI string `json:"StoreUri"`
}

type ApplyUploadImageParam

type ApplyUploadImageParam struct {
	ServiceId   string
	SessionKey  string
	UploadNum   int
	StoreKeys   []string
	CommitParam *CommitUploadImageParam
	SkipMeta    bool
	SkipCommit  bool
	Overwrite   bool
}

ApplyImageUpload

type ApplyUploadImageResult

type ApplyUploadImageResult struct {
	UploadAddress UploadAddress `json:"UploadAddress"`
	RequestId     string        `json:"RequestId"`
}

type CommitImageUpload added in v1.0.140

type CommitImageUpload struct{}

type CommitImageUploadBody added in v1.0.140

type CommitImageUploadBody struct {

	// REQUIRED; 一次上传会话 Key。 :::tip 请参考获取文件上传地址 [https://www.volcengine.com/docs/508/9397]获取。 :::
	SessionKey string `json:"SessionKey"`

	// REQUIRED; 上传成功的资源 ID。
	SuccessOids []string `json:"SuccessOids"`
	DecryptKeys []string `json:"DecryptKeys,omitempty"`
}

type CommitImageUploadQuery added in v1.0.140

type CommitImageUploadQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 是否返回图片meta信息。默认 false。
	// * true:不返回图片 meta 信息。
	// * false:获取图片 meta 信息并返回对应 meta 信息。
	// * 其中若 meta 获取超时或失败,接口返回成功,但对应 meta 信息将为空。
	// * 如果强依赖 meta 请参考图片Meta信息 [https://www.volcengine.com/docs/508/64085]获取。
	SkipMeta bool `json:"SkipMeta,omitempty" query:"SkipMeta"`
}

type CommitImageUploadReq added in v1.0.140

type CommitImageUploadReq struct {
	*CommitImageUploadQuery
	*CommitImageUploadBody
}

type CommitImageUploadRes added in v1.0.140

type CommitImageUploadRes struct {

	// REQUIRED
	ResponseMetadata *CommitImageUploadResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CommitImageUploadResResult `json:"Result"`
}

type CommitImageUploadResResponseMetadata added in v1.0.140

type CommitImageUploadResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CommitImageUploadResResult added in v1.0.140

type CommitImageUploadResResult struct {

	// REQUIRED; 请求的唯一标识 ID。
	RequestID string `json:"RequestId"`

	// REQUIRED; 运行结果,数组长度对应上传的数量。
	Results []*CommitImageUploadResResultResultsItem `json:"Results"`

	// JSON 序列化之后的图片信息,结构体请参考 ImageInfo 的 Array。
	PluginResult []*CommitImageUploadResResultPluginResultItem `json:"PluginResult,omitempty"`
}

type CommitImageUploadResResultPluginResultItem added in v1.0.140

type CommitImageUploadResResultPluginResultItem struct {

	// REQUIRED; 图片 Uri。
	ImageURI string `json:"ImageUri"`

	// 图片文件名。
	FileName string `json:"FileName,omitempty"`

	// 图片帧数量
	FrameCnt int `json:"FrameCnt,omitempty"`

	// 图片格式
	ImageFormat string `json:"ImageFormat,omitempty"`

	// 图片的高。
	ImageHeight int `json:"ImageHeight,omitempty"`

	// 图片的 MD5
	ImageMD5 string `json:"ImageMd5,omitempty"`

	// 图片大小
	ImageSize int `json:"ImageSize,omitempty"`

	// 图片的宽。
	ImageWidth int `json:"ImageWidth,omitempty"`
}

type CommitImageUploadResResultResultsItem added in v1.0.140

type CommitImageUploadResResultResultsItem struct {

	// REQUIRED; 源图片的 Uri。
	URI string `json:"Uri"`

	// REQUIRED; 图片上传结果。
	// * 返回值为 2000,表示上传成功;
	// * 返回值为 2001,表示上传失败。 :::tip 需要传 SuccessOids 才会返回值。 :::
	URIStatus int `json:"UriStatus"`

	// 加密结果。 :::tip 指定了 Encryption Function 时有值 。 :::
	Encryption *CommitImageUploadResResultResultsItemEncryption `json:"Encryption,omitempty"`
	ImageMeta  *CommitImageUploadResResultResultsItemImageMeta  `json:"ImageMeta,omitempty"`
}

type CommitImageUploadResResultResultsItemEncryption added in v1.0.140

type CommitImageUploadResResultResultsItemEncryption struct {

	// REQUIRED; 加密算法。
	Algorithm string `json:"Algorithm"`

	// REQUIRED; 额外信息,键值均为 String。
	Extra map[string]string `json:"Extra"`

	// REQUIRED; 加密私钥。
	SecretKey string `json:"SecretKey"`

	// REQUIRED; 加密源 MD5。
	SourceMD5 string `json:"SourceMd5"`

	// REQUIRED; 加密图片的 Uri。
	URI string `json:"Uri"`

	// REQUIRED; 加密版本。
	Version string `json:"Version"`
}

CommitImageUploadResResultResultsItemEncryption - 加密结果。 :::tip 指定了 Encryption Function 时有值 。 :::

type CommitImageUploadResResultResultsItemImageMeta added in v1.0.140

type CommitImageUploadResResultResultsItemImageMeta struct {

	// REQUIRED
	Field75 int `json:"Field75"`

	// REQUIRED
	Format string `json:"Format"`

	// REQUIRED
	Height int `json:"Height"`

	// REQUIRED
	MD5 string `json:"Md5"`

	// REQUIRED
	Size int `json:"Size"`

	// REQUIRED
	URI string `json:"Uri"`
}

type CommitUploadImageParam

type CommitUploadImageParam struct {
	ServiceId   string     `json:"-"`
	SessionKey  string     `json:"SessionKey"`
	SuccessOids []string   `json:"SuccessOids"`
	Functions   []Function `json:"Functions"`
	SkipMeta    bool       `json:"-"`
}

CommitImageUpload

type CommitUploadImageResult

type CommitUploadImageResult struct {
	Results    []Result    `json:"Results"`
	RequestId  string      `json:"RequestId"`
	ImageInfos []ImageInfo `json:"PluginResult"`
}

type Components16Kv6ElSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesEventrulesItems added in v1.0.140

type Components16Kv6ElSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesEventrulesItems struct {
	CallbackURL string `json:"CallbackUrl"`

	Enable bool `json:"Enable"`

	EventType []string `json:"EventType"`

	ID string `json:"Id"`

	MatchRule string `json:"MatchRule"`
}

type Components18K1KvdSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesResourcetagsItems added in v1.0.140

type Components18K1KvdSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesResourcetagsItems struct {
	Key string `json:"Key"`

	Value string `json:"Value"`
}

type Components1T23IneSchemasGetallimagetemplatesresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems added in v1.0.140

type Components1T23IneSchemasGetallimagetemplatesresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems struct {
	Name string `json:"Name"`

	Param map[string]interface{} `json:"Param"`
}

type Components1Xh7Lz4SchemasDescribeimagexcompressusageresPropertiesResultPropertiesCompressdataItemsPropertiesOutsizeItems added in v1.0.140

type Components1Xh7Lz4SchemasDescribeimagexcompressusageresPropertiesResultPropertiesCompressdataItemsPropertiesOutsizeItems struct {
	TimeStamp string `json:"TimeStamp"`

	Value float64 `json:"Value"`
}

type Components8GbgysSchemasGettemplatesfrombinresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems added in v1.0.140

type Components8GbgysSchemasGettemplatesfrombinresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems struct {
	Name string `json:"Name"`

	Param map[string]interface{} `json:"Param"`
}

type ComponentsDgbrljSchemasGetimageaudittasksresPropertiesResultPropertiesTasksItemsPropertiesAudittaskPropertiesImageinfosItems added in v1.0.140

type ComponentsDgbrljSchemasGetimageaudittasksresPropertiesResultPropertiesTasksItemsPropertiesAudittaskPropertiesImageinfosItems struct {
	DataID string `json:"DataId"`

	ImageURI string `json:"ImageUri"`
}

type ComponentsDrd6S5SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesStorageItems added in v1.0.140

type ComponentsDrd6S5SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesStorageItems struct {
	AllTypes bool `json:"AllTypes"`

	BktName string `json:"BktName"`

	TTL int `json:"TTL"`
}

type ComponentsK7Ou2VSchemasGetimageocrv2ResPropertiesResultPropertiesLicenseresultAdditionalproperties added in v1.0.140

type ComponentsK7Ou2VSchemasGetimageocrv2ResPropertiesResultPropertiesLicenseresultAdditionalproperties struct {
	Content string `json:"Content"`

	Location []int `json:"Location"`
}

type ComponentsPqmsj3SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesMirrorItems added in v1.0.140

type ComponentsPqmsj3SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesMirrorItems struct {
	Headers map[string]string `json:"Headers"`

	Host string `json:"Host"`

	Hosts map[string]int `json:"Hosts"`

	Schema string `json:"Schema"`

	Source string `json:"Source"`
}

type CreateHiddenWatermarkImage added in v1.0.140

type CreateHiddenWatermarkImage struct{}

type CreateHiddenWatermarkImageBody added in v1.0.140

type CreateHiddenWatermarkImageBody struct {

	// REQUIRED; 获取盲水印图的算法模型,仅支持取值 tracev1。该模型可以生成带有水印的透明图像,但仅适用于纯色网页泄露溯源场景。该模型可有效抵抗常见的社交软件传播。然而,该算法对页面背景色的影响相对较大,因此不适合用于保护多彩页面或图片,例如商品页面。
	Algorithm string `json:"Algorithm"`

	// REQUIRED; 自定义盲水印文本信息。最大支持 128 个字符,若全部是中文则不超过 42 个字符。
	Info string `json:"Info"`

	// REQUIRED; 盲水印强度,取值如下所示:
	// * low:低强度,适用于对图像质量要求高。
	// * medium:中强度
	// * strong:高强度,适合图像纹理丰富时使用。
	Strength string `json:"Strength"`
}

type CreateHiddenWatermarkImageQuery added in v1.0.140

type CreateHiddenWatermarkImageQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateHiddenWatermarkImageReq added in v1.0.140

type CreateHiddenWatermarkImageReq struct {
	*CreateHiddenWatermarkImageQuery
	*CreateHiddenWatermarkImageBody
}

type CreateHiddenWatermarkImageRes added in v1.0.140

type CreateHiddenWatermarkImageRes struct {

	// REQUIRED
	ResponseMetadata *CreateHiddenWatermarkImageResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateHiddenWatermarkImageResResult `json:"Result,omitempty"`
}

type CreateHiddenWatermarkImageResResponseMetadata added in v1.0.140

type CreateHiddenWatermarkImageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateHiddenWatermarkImageResResult added in v1.0.140

type CreateHiddenWatermarkImageResResult struct {

	// REQUIRED; 盲水印图片 Url,当前仅支持输出 png 格式。 :::warning 经裁剪后仍可提取水印的原图最小尺寸限制为 320 * 192。 :::
	StoreURI string `json:"StoreUri"`
}

CreateHiddenWatermarkImageResResult - 视请求的接口而定

type CreateImageAnalyzeTask added in v1.0.140

type CreateImageAnalyzeTask struct{}

type CreateImageAnalyzeTaskBody added in v1.0.140

type CreateImageAnalyzeTaskBody struct {

	// REQUIRED; 自定义离线评估任务名称
	Name string `json:"Name"`

	// REQUIRED; 任务地区。当前仅支持取值 cn,表示国内。
	Region string `json:"Region"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 任务类型。取值如下所示:
	// * OnlineUrl(暂不支持)
	// * SdkUrl(暂不支持)
	// * UrlFile:在线提交 URL 离线评估,即在.txt 文件(评估文件)内填写了待评估图片文件 URL,并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	// * UriFile:在线提交 URI 离线评估,即在.txt 文件(评估文件)内填写了待评估图片文件 URI,并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	Type string `json:"Type"`

	// 任务描述,可作为该条任务的备注信息。
	Desc string `json:"Desc,omitempty"`

	// 仅当Type 取值 UriFile 时,配置有效。 是否模拟模板每阶段输出,取值如下所示:
	// * true:是,一个模版中可以选择多种图像处理, 模拟输出时会将所有的处理逐步叠加并编码为最终图片格式运行并输出评估结果。
	// * false:否。
	EvalPerStage bool `json:"EvalPerStage,omitempty"`

	// txt 评估文件的 Store URI,该文件需上传至指定服务对应存储中。
	// * Type 取值 UrlFile 时,填写合法 URL
	// * Type 取值 UriFile 时,填写指定服务的存储 URI
	ResURI []string `json:"ResUri,omitempty"`

	// 仅当Type 取值 UriFile 时,配置有效。 模板名称,您可通过调用 GetAllImageTemplates [https://www.volcengine.com/docs/508/9386] 获取服务下所有已创建的 TemplateName。
	Tpl string `json:"Tpl,omitempty"`
}

type CreateImageAnalyzeTaskQuery added in v1.0.140

type CreateImageAnalyzeTaskQuery struct{}

type CreateImageAnalyzeTaskReq added in v1.0.140

type CreateImageAnalyzeTaskReq struct {
	*CreateImageAnalyzeTaskQuery
	*CreateImageAnalyzeTaskBody
}

type CreateImageAnalyzeTaskRes added in v1.0.140

type CreateImageAnalyzeTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageAnalyzeTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageAnalyzeTaskResResult `json:"Result"`
}

type CreateImageAnalyzeTaskResResponseMetadata added in v1.0.140

type CreateImageAnalyzeTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageAnalyzeTaskResResult added in v1.0.140

type CreateImageAnalyzeTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageAuditTask added in v1.0.140

type CreateImageAuditTask struct{}

type CreateImageAuditTaskBody added in v1.0.140

type CreateImageAuditTaskBody struct {

	// REQUIRED; 审核能力,取值如下所示:
	// * 0:基础审核能力
	// * 1:智能审核能力
	AuditAbility int `json:"AuditAbility"`

	// REQUIRED; "porn" // 涉黄 "govern" // 涉政 "terror" // 涉恐 "illegal" // 违法违规 "sensitive1" // 涉敏1 "sensitive2" // 涉敏2 "forbidden"
	// // 违禁 "uncomfortable" // 引人不适 "qrcode" // 二维码 "badpicture" // 不良画面 "sexy" // 性感低俗 "age"
	// // 年龄 "underage" // 未成年 "quality" // 图片质量
	AuditDimensions []string `json:"AuditDimensions"`

	// REQUIRED; 任务地区。当前仅支持取值 cn,表示国内。
	Region string `json:"Region"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 任务类型,当前仅支持取值为 audit。
	TaskType string `json:"TaskType"`

	// REQUIRED; 图片审核任务场景。取值如下所示:
	// * UrlFile:存量图片处理,进针对已有存储内的图片请求获取审核结果。传入方式是 ResUri方式,即在.txt 文件(审核文件)内填写了待审核图片文件 URL,并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
	// * Url:URL 直传场景。传入方式为 ImageInfos 方式,即可直接传入待审核图片的 URL 及区分标识。
	// * Upload:图片上传场景,针对上传图片到指定服务下的场景。可在 EnableAuditRange下指定审核的范围,例如对指定上传到某目录下的图片进行审核。
	Type string `json:"Type"`

	// 仅当 EnableAuditRange 取值 1 时,配置生效。 指定前缀审核,若你希望对某个目录进行审核,请设置路径为对应的目录名,以/结尾。例如123/test/
	AuditPrefix []string `json:"AuditPrefix,omitempty"`

	// "ad" // 广告 "defraud" // 诈骗 "charillegal" // 文字违规
	AuditTextDimensions []string `json:"AuditTextDimensions,omitempty"`

	// 回调类型,取值需要与 AuditDimensions 审核维度保持一致或少于 AuditDimensions。
	// 例如,AuditDimensions 取值 ["pron","sexy"],AuditTextDimensions 取值 ["ad"],支持您将 FreezeDimensions 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"]
	// 和 ["sexy","ad"] 任意一种。
	CallbackDimensions []string `json:"CallbackDimensions,omitempty"`

	// 回调图片类型,取值如下所示:
	// * normal:正常图片
	//
	//
	// * problem:问题图片
	//
	//
	// * frozen:冻结图片
	//
	//
	// * fail:审核失败图片
	CallbackImageTypes []string `json:"CallbackImageTypes,omitempty"`

	// 回调 URL,veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/134676#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	CallbackURL string `json:"CallbackUrl,omitempty"`

	// 默认0
	EnableAuditRange int `json:"EnableAuditRange,omitempty"`

	// 是否开启回调,取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	EnableCallback bool `json:"EnableCallback,omitempty"`

	// 是否开启冻结,取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	EnableFreeze bool `json:"EnableFreeze,omitempty"`

	// 图片审核仅支持审核 5MB 以下的图片,若您的图片大小在 5MB~32MB,您可以开启大图审核功能,veImageX 会对图片压缩后再进行审核。开启后,将对压缩能力按照基础图片处理
	// [https://www.volcengine.com/docs/508/65935#%E5%9F%BA%E7%A1%80%E5%9B%BE%E5%83%8F%E5%A4%84%E7%90%86%E6%9C%8D%E5%8A%A1]进行计费。(您每月可使用
	// 20TB 的免费额度) 取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	// :::tip
	// * 若未开启大图审核且图片大小 ≥ 5 MB,可能会导致系统超时报错;
	// * 若已开启大图审核但图片大小 ≥ 32 MB,可能会导致系统超时报错。 :::
	EnableLargeImageDetect bool `json:"EnableLargeImageDetect,omitempty"`

	// 若开启冻结,则不可为空
	FreezeDimensions []string `json:"FreezeDimensions,omitempty"`

	// 若开启冻结,则不可为空
	FreezeStrategy int `json:"FreezeStrategy,omitempty"`

	// 若开启冻结,则不可为空
	FreezeType []string `json:"FreezeType,omitempty"`

	// 仅当 Type 为 Url 时,配置生效。
	// 批量提交图片 URL 列表
	ImageInfos []*CreateImageAuditTaskBodyImageInfosItem `json:"ImageInfos,omitempty"`

	// 仅当 EnableAuditRange 取值 1 时,配置生效。 指定前缀不审核,若你希望对某个目录不进行审核,请设置路径为对应的目录名,以/结尾。例如123/test/
	NoAuditPrefix []string `json:"NoAuditPrefix,omitempty"`

	// 仅当 Type 为 UrlFile 时,配置生效。
	// 审核文件的 StoreUri,为 .txt 文件,该文件需上传至指定服务对应存储中。该 txt 文件内需填写待审核图片文件的 URL,每行填写一个,最多可填写 10000 行。
	ResURI []string `json:"ResUri,omitempty"`
}

type CreateImageAuditTaskBodyImageInfosItem added in v1.0.140

type CreateImageAuditTaskBodyImageInfosItem struct {

	// 建议您根据实际业务情况,将该参数作为可区分审核图片 ImageUri 的自定义标识。
	DataID string `json:"DataId,omitempty"`

	// 待审核图片 URL,需满足公网可访问。
	ImageURI string `json:"ImageUri,omitempty"`
}

type CreateImageAuditTaskQuery added in v1.0.140

type CreateImageAuditTaskQuery struct{}

type CreateImageAuditTaskReq added in v1.0.118

type CreateImageAuditTaskReq struct {
	*CreateImageAuditTaskQuery
	*CreateImageAuditTaskBody
}

type CreateImageAuditTaskRes added in v1.0.140

type CreateImageAuditTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageAuditTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageAuditTaskResResult `json:"Result"`
}

type CreateImageAuditTaskResResponseMetadata added in v1.0.140

type CreateImageAuditTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageAuditTaskResResult added in v1.0.140

type CreateImageAuditTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageCompressTask added in v1.0.140

type CreateImageCompressTask struct{}

type CreateImageCompressTaskBody added in v1.0.140

type CreateImageCompressTaskBody struct {

	// REQUIRED; 压缩方法,取值如下所示:
	// * 0:ZIP DEFLATE 压缩打包方法
	//
	//
	// * 1:仅保存文件,不执行压缩打包
	ZipMode int `json:"ZipMode"`

	// POST 类型的回调 URL,用于接收相关回调 JSON 类型数据。
	Callback string `json:"Callback,omitempty"`

	// 与IndexFile,二选一。 压缩文件列表配置,压缩文件 URL 最多为 500 个,总文件大小不超过 45000 MB。若超出限制,则取消压缩打包操作,直接返回错误。
	FileList []*CreateImageCompressTaskBodyFileListItem `json:"FileList,omitempty"`

	// 与 FileList,二选一。 索引文件 StoreUri,为 .txt 文件,该索引文件需上传至指定服务对应存储中。 该索引文件内需填写待压缩文件的 StoreUri,每行填写一个,最多可填写 3000 行。总文件大小不超过 45000
	// MB。若超出限制,则取消压缩打包操作,直接返回错误。
	IndexFile string `json:"IndexFile,omitempty"`

	// 压缩后文件压缩包的指定名称,默认为随机 Key。
	Output string `json:"Output,omitempty"`
}

type CreateImageCompressTaskBodyFileListItem added in v1.0.140

type CreateImageCompressTaskBodyFileListItem struct {

	// REQUIRED; 公网可访问的待压缩文件 URL
	URL string `json:"Url"`

	// * 指定时,为 URL 文件所在压缩包中的别名。
	// * 不指定时,若能提取原文件名称时,则以 URL 原文件名称;否则,使用随机名称。
	Alias string `json:"Alias,omitempty"`

	// URL 对应资源在压缩包中的文件夹,不传时则将该资源存储至一级目录下。不能以/结尾。
	Folder string `json:"Folder,omitempty"`
}

type CreateImageCompressTaskQuery added in v1.0.140

type CreateImageCompressTaskQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateImageCompressTaskReq added in v1.0.110

type CreateImageCompressTaskReq struct {
	*CreateImageCompressTaskQuery
	*CreateImageCompressTaskBody
}

type CreateImageCompressTaskRes added in v1.0.140

type CreateImageCompressTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageCompressTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageCompressTaskResResult `json:"Result,omitempty"`
}

type CreateImageCompressTaskResResponseMetadata added in v1.0.140

type CreateImageCompressTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageCompressTaskResResult added in v1.0.140

type CreateImageCompressTaskResResult struct {

	// REQUIRED; 压缩任务 ID
	TaskID string `json:"TaskId"`
}

CreateImageCompressTaskResResult - 视请求的接口而定

type CreateImageContentTask added in v1.0.140

type CreateImageContentTask struct{}

type CreateImageContentTaskBody added in v1.0.140

type CreateImageContentTaskBody struct {

	// REQUIRED; refreshurl 刷新URL;refreshdir 刷新目录;preloadurl 预热URL;blockurl 禁用URL;unblock_url 解禁URL
	TaskType string `json:"TaskType"`

	// REQUIRED; 资源 URL 或者目录。
	// * 当TaskType取值refresh_url,一次可提交的最大限额为 2000 个;
	// * 当TaskType取值refresh_dir,一次可提交的最大限额为 50 个;
	// * 当TaskType取值preload_url,一次可提交的最大限额为 2000 个;
	// * 当TaskType取值block_url,一次可提交的最大限额为 2000 个;
	// * 当TaskType取值unblock_url,一次可提交的最大限额为 2000 个。
	Urls []string `json:"Urls"`
}

type CreateImageContentTaskQuery added in v1.0.140

type CreateImageContentTaskQuery struct {

	// REQUIRED; 服务 ID。您可以在veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。您也可以通过
	// OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateImageContentTaskReq

type CreateImageContentTaskReq struct {
	*CreateImageContentTaskQuery
	*CreateImageContentTaskBody
}

type CreateImageContentTaskRes added in v1.0.140

type CreateImageContentTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageContentTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageContentTaskResResult `json:"Result,omitempty"`
}

type CreateImageContentTaskResResponseMetadata added in v1.0.140

type CreateImageContentTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageContentTaskResResult added in v1.0.140

type CreateImageContentTaskResResult struct {

	// REQUIRED; 对应的任务 ID
	TaskID string `json:"TaskId"`
}

CreateImageContentTaskResResult - 视请求的接口而定

type CreateImageHmEmbed added in v1.0.140

type CreateImageHmEmbed struct{}

type CreateImageHmEmbedBody added in v1.0.140

type CreateImageHmEmbedBody struct {

	// REQUIRED; 自定义盲水印文本内容。
	// * 文本嵌入模型支持最长可嵌入115个水印内容字符。
	// * 画质自适应文本嵌入模型无水印内容长度限制。
	Info string `json:"Info"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待添加盲水印的原图 Uri。
	StoreURI string `json:"StoreUri"`

	// 算法模型,取值如下所示:
	// * default:文本嵌入模型,默认文本嵌入模型;
	// * adapt_resize:画质自适应文本嵌入模型。
	Algorithm string `json:"Algorithm,omitempty"`

	// 输出图片格式,默认 png,支持图片格式有:png、jpeg、webp。
	OutFormat string `json:"OutFormat,omitempty"`

	// 输出图片质量参数。取值范围为 [1,100],默认为 75。 对于 PNG 无损压缩,其他格式下其值越小,压缩率越高,画质越差。
	OutQuality int `json:"OutQuality,omitempty"`

	// 算法强度,强度越高,图像抵抗攻击性能越强。
	// 取值如下所示:
	// * low:低强度,适用于纯色图场景以及对图像质量要求高;
	// * medium:中强度,默认中强度;
	// * strong:高强度,适合图像纹理丰富时使用。
	StrengthLevel string `json:"StrengthLevel,omitempty"`
}

type CreateImageHmEmbedQuery added in v1.0.140

type CreateImageHmEmbedQuery struct{}

type CreateImageHmEmbedReq added in v1.0.140

type CreateImageHmEmbedReq struct {
	*CreateImageHmEmbedQuery
	*CreateImageHmEmbedBody
}

type CreateImageHmEmbedRes added in v1.0.140

type CreateImageHmEmbedRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageHmEmbedResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *CreateImageHmEmbedResResult `json:"Result,omitempty"`
}

type CreateImageHmEmbedResResponseMetadata added in v1.0.140

type CreateImageHmEmbedResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageHmEmbedResResult added in v1.0.140

type CreateImageHmEmbedResResult struct {

	// REQUIRED; 添加盲水印后的结果图 Uri。
	StoreURI string `json:"StoreUri"`
}

CreateImageHmEmbedResResult - 视请求的接口而定

type CreateImageHmExtract added in v1.0.140

type CreateImageHmExtract struct{}

type CreateImageHmExtractBody added in v1.0.140

type CreateImageHmExtractBody struct{}

type CreateImageHmExtractQuery added in v1.0.140

type CreateImageHmExtractQuery struct {

	// REQUIRED; 算法模型,取值如下所示:
	// * default:文本嵌入模型,默认文本嵌入模型;
	// * adapt_resize:画质自适应文本嵌入模型。
	// * adapt: 画质自适应文本嵌入模型。
	// * tracev1:获取暗水印前、背景图。
	// * natural: 适用于自然色彩的图片
	Algorithm string `json:"Algorithm" query:"Algorithm"`

	// REQUIRED; 待提取盲水印文件 URL,StoreUri 和 ImageUrl 都不为空时,以 StoreUri 为准。
	ImageURL string `json:"ImageUrl" query:"ImageUrl"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 待提取盲水印的图片 Uri,StoreUri 和 ImageUrl 都不为空时,以 StoreUri 为准。
	StoreURI string `json:"StoreUri" query:"StoreUri"`
}

type CreateImageHmExtractReq added in v1.0.140

type CreateImageHmExtractReq struct {
	*CreateImageHmExtractQuery
	*CreateImageHmExtractBody
}

type CreateImageHmExtractRes added in v1.0.140

type CreateImageHmExtractRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageHmExtractResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageHmExtractResResult `json:"Result"`
}

type CreateImageHmExtractResResponseMetadata added in v1.0.140

type CreateImageHmExtractResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageHmExtractResResult added in v1.0.140

type CreateImageHmExtractResResult struct {

	// REQUIRED; 提取出的盲水印文本信息。
	Info string `json:"Info"`

	// REQUIRED; 响应码,具体取值如下所示:
	// * -1:盲水印为空;
	// * 0:info不为空时表示盲水印提取成功。 :::tip 提取失败时显示接口错误。 :::
	StatusCode int `json:"StatusCode"`
}

type CreateImageMigrateTask added in v1.0.140

type CreateImageMigrateTask struct{}

type CreateImageMigrateTaskBody added in v1.0.140

type CreateImageMigrateTaskBody struct {

	// REQUIRED; 任务信息
	Task *CreateImageMigrateTaskBodyTask `json:"Task"`
}

type CreateImageMigrateTaskBodyTask added in v1.0.140

type CreateImageMigrateTaskBodyTask struct {

	// REQUIRED; 目的信息
	Dst *CreateImageMigrateTaskBodyTaskDst `json:"Dst"`

	// REQUIRED; 自定义迁移任务名称
	Name string `json:"Name"`

	// REQUIRED; 迁移源信息
	Source *CreateImageMigrateTaskBodyTaskSource `json:"Source"`

	// 回调信息。配置后,当任务执行完成时,将往该回调配置地址发送任务回调信息。
	CallbackCfg *CreateImageMigrateTaskBodyTaskCallbackCfg `json:"CallbackCfg,omitempty"`

	// 迁移策略
	RunStrategy *CreateImageMigrateTaskBodyTaskRunStrategy `json:"RunStrategy,omitempty"`

	// 转码配置
	Transcode *CreateImageMigrateTaskBodyTaskTranscode `json:"Transcode,omitempty"`
}

CreateImageMigrateTaskBodyTask - 任务信息

type CreateImageMigrateTaskBodyTaskCallbackCfg added in v1.0.140

type CreateImageMigrateTaskBodyTaskCallbackCfg struct {

	// REQUIRED; 回调地址。Method取值http时,填写公网可访问的 URL 地址,任务结束将向该地址发送 HTTP POST 请求。具体回调参数请参考回调内容。
	Addr string `json:"Addr"`

	// REQUIRED; 回调方法。仅支持取值为 http。
	Method string `json:"Method"`

	// 回调信息中是否包含具体迁移任务条目信息。取值如下所示:
	// * true:包含。仅包含迁移成功的任务条目信息,迁移失败的任务列表请在迁移完成后调用 ExportFailedMigrateTask [https://www.volcengine.com/docs/508/1108675] 接口获取。
	// * false:(默认)不包含。 :::warning 若任务中包含的条目数量过多,会导致回调消息体过大,增加回调失败的风险。因此建议仅在任务中条目量级不超过十万时使用该参数。 :::
	IncludeEntry bool `json:"IncludeEntry,omitempty"`
}

CreateImageMigrateTaskBodyTaskCallbackCfg - 回调信息。配置后,当任务执行完成时,将往该回调配置地址发送任务回调信息。

type CreateImageMigrateTaskBodyTaskDst added in v1.0.140

type CreateImageMigrateTaskBodyTaskDst struct {

	// REQUIRED; 迁移目标服务 ID,请提前新建服务 [https://www.volcengine.com/docs/508/357114#%E6%96%B0%E5%BB%BA%E6%9C%8D%E5%8A%A1]。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// 目标 key 前缀,即保存到到指定目录下。如需多重目录,请使用/分割,并以/结尾。 默认为空,表示迁移到根目录。
	// * 使用非 URL 方式迁移到根目录时:迁移后 存储 Key 与源存储 Bucket 的文件存储 Key 相同。
	// * 使用 Url 方式迁移到根目录时:迁移后存储 Key 与源 URL 中 Path 值相同。
	Prefix string `json:"Prefix,omitempty"`

	// 源 Bucket 名称保留规则。取值如下所示:
	// * true:不保留,迁移后资源访问 URI 中,不保留迁移源的 Bucket 名称。
	// * false:(默认)保留,迁移后资源访问 URI 中,会保留迁移源的 Bucket 名称。
	SkipBucket bool `json:"SkipBucket,omitempty"`

	// 同名文件覆盖规则配置。取值如下所示:
	// * 0:(默认)直接覆盖同名文件
	// * 1:增加文件名后缀,后缀为 任务 ID
	// * 2:跳过同名文件,即不做迁移
	// :::tip 同名文件指文件在对象存储中的访问 Key 相同的文件,调用 veImageX 服务时会用到文件访问 Key。 :::
	UploadConf int `json:"UploadConf,omitempty"`
}

CreateImageMigrateTaskBodyTaskDst - 目的信息

type CreateImageMigrateTaskBodyTaskRunStrategy added in v1.0.140

type CreateImageMigrateTaskBodyTaskRunStrategy struct {

	// 源下载 QPS 限制。如取值不为空,则长度必须为 24,表示一天 24 小时内各小时的 QPS 限制值。默认无限制。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadQPS []int `json:"ReadQps,omitempty"`

	// 源下载流量限制。单位为 Byte。如取值不为空,则长度必须为24,表示一天 24 小时内各小时的流量限制值。默认无限制。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadRate []int `json:"ReadRate,omitempty"`
}

CreateImageMigrateTaskBodyTaskRunStrategy - 迁移策略

type CreateImageMigrateTaskBodyTaskSource added in v1.0.140

type CreateImageMigrateTaskBodyTaskSource struct {

	// REQUIRED; 源端 Bucket。
	// * 仅当Vendor为URL时,需填写 URL 列表文件地址(公网 URL 地址)。
	// * 当Vendor为其他时,请填写对应云服务商所需迁移数据的 Bucket 名称。您可参考云数据迁移准备 [https://www.volcengine.com/docs/508/129213]获取对应阿里云OSS、腾讯云COS、七牛云KODO、百度云BOS、华为云OBS、
	// 优刻得(Ucloud File)、AWS国际站的 Bucket 名称。
	Bucket string `json:"Bucket"`

	// REQUIRED; 迁移云服务商。取值如下所示:
	// * OSS:阿里云
	// * COS:腾讯云
	// * KODO:七牛云
	// * BOS:百度云
	// * OBS:华为云
	// * Ucloud:Ucloud file
	// * AWS:AWS 国际站
	// * S3:其他 S3 协议存储
	// * URL:以上传 URL 列表的方式迁移
	Vendor string `json:"Vendor"`

	// 仅当Vendor非URL时为必填。 Access Key,与 Secret Key 同时填写,为了保证有访问源数据桶的权限。
	// * 请参考云数据迁移准备 [https://www.volcengine.com/docs/508/129213]获取对应阿里云OSS、腾讯云COS、七牛云KODO、百度云BOS、华为云OBS、 优刻得(Ucloud File)、AWS国际站的账号
	// AK/SK。
	// * 对于其他 S3 协议存储的AK/SK,请根据其具体源站信息填写。
	AK string `json:"AK,omitempty"`

	// 仅当Vendor非URL时为可填。 迁移源云服务商 CDN 域名,若不为空将使用该 CDN 域名下载三方云厂商的资源。
	CdnHost string `json:"CdnHost,omitempty"`

	// 仅当Vendor为S3时必填。 S3 协议 Endpoint,需以http://或https://开头。请根据源站信息填写。
	Endpoint string `json:"Endpoint,omitempty"`

	// 仅迁移匹配的前缀列表文件。文件路径前缀无需包含桶名称,但需要完整路径。 默认为空,表示对该存储 Bucket 内资源执行全量迁移。若不为空,表示仅做部分迁移,即指定迁移的文件路径前缀。
	Prefix []string `json:"Prefix,omitempty"`

	// 仅迁移匹配的正则表达式列表的文件。默认为空,表示对该存储 Bucket 内资源执行全量迁移。
	// :::tip
	// * 多条正则表达式之间是"或"的关系,即源文件匹配任何一条正则表达式即视为符合迁移条件。
	// * 正则过滤规则需要遍历源桶中的全部文件,如果源桶中文件数量较多会降低迁移速度。 :::
	Regex []string `json:"Regex,omitempty"`

	// Bucket 所在地区。仅当Vendor非URL/OSS/KODO/AWS时为必填。
	// * 请参考云数据迁移准备 [https://www.volcengine.com/docs/508/129213]获取对应阿里云OSS、腾讯云COS、七牛云KODO、百度云BOS、华为云OBS、 优刻得(Ucloud File)、AWS国际站的
	// Bucket 地区。
	// * 对于其他 S3 协议存储的 Bucket 地区,请根据其具体源站信息填写。
	Region string `json:"Region,omitempty"`

	// 仅当Vendor非URL时为必填。 Secret Key,与 Access Key 同时填写,为了保证有访问源数据桶的权限。
	// * 请参考云数据迁移准备 [https://www.volcengine.com/docs/508/129213]获取对应阿里云OSS、腾讯云COS、七牛云KODO、百度云BOS、华为云OBS、 优刻得(Ucloud File)、AWS国际站的账号
	// AK/SK。
	// * 对于其他 S3 协议存储的AK/SK,请根据其具体源站信息填写。
	SK string `json:"SK,omitempty"`

	// 是否丢弃源 Header。取值如下所示:
	// * true:丢弃源 Header
	// * false:(默认)保留源 Header
	SkipHeader bool `json:"SkipHeader,omitempty"`

	// 迁移文件结束时间点。默认为空。仅迁移该查询时间段内新增或变更的文件。 日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeEnd string `json:"TimeEnd,omitempty"`

	// 迁移文件起始时间点。仅迁移该查询时间段内新增或变更的文件。默认为空。 日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStart string `json:"TimeStart,omitempty"`
}

CreateImageMigrateTaskBodyTaskSource - 迁移源信息

type CreateImageMigrateTaskBodyTaskTranscode added in v1.0.140

type CreateImageMigrateTaskBodyTaskTranscode struct {

	// REQUIRED; 目标转码格式,仅针对静图执行转码策略。支持的格式有 png、jpeg、heic、avif、webp、vvic。
	Format string `json:"Format"`

	// REQUIRED; 转码质量参数,取值范围为 [1,100]。对于 PNG 为无损压缩,其他格式下其值越小,压缩率越高,画质越差。
	Quality int `json:"Quality"`

	// 包含透明通道的图片是否编码为降级格式。取值如下所示:
	// * true:降级
	// * false:(默认)不降级
	AlphaDemotion bool `json:"AlphaDemotion,omitempty"`

	// 降级编码格式,仅当AlphaDemotion为true时必填。支持的格式有 png、jpeg、heic、avif、webp、vvic。
	DemotionFmt string `json:"DemotionFmt,omitempty"`

	// 转码是否保留 exif 信息。取值如下所示:
	// * true:保留
	// * false:(默认)不保留
	EnableExif bool `json:"EnableExif,omitempty"`
}

CreateImageMigrateTaskBodyTaskTranscode - 转码配置

type CreateImageMigrateTaskQuery added in v1.0.140

type CreateImageMigrateTaskQuery struct{}

type CreateImageMigrateTaskReq added in v1.0.140

type CreateImageMigrateTaskReq struct {
	*CreateImageMigrateTaskQuery
	*CreateImageMigrateTaskBody
}

type CreateImageMigrateTaskRes added in v1.0.140

type CreateImageMigrateTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageMigrateTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageMigrateTaskResResult `json:"Result"`
}

type CreateImageMigrateTaskResResponseMetadata added in v1.0.140

type CreateImageMigrateTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageMigrateTaskResResult added in v1.0.140

type CreateImageMigrateTaskResResult struct {

	// REQUIRED; 创建成功的迁移任务 ID
	TaskID string `json:"TaskId"`
}

type CreateImageRetryAuditTask added in v1.0.140

type CreateImageRetryAuditTask struct{}

type CreateImageRetryAuditTaskBody added in v1.0.140

type CreateImageRetryAuditTaskBody struct {

	// REQUIRED; 失败图片 ID,您可通过调用获取审核任务结果 [https://www.volcengine.com/docs/508/1160410]查看待更新状态的图片条目 ID。
	Entry string `json:"Entry"`

	// REQUIRED; 任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId"`
}

type CreateImageRetryAuditTaskQuery added in v1.0.140

type CreateImageRetryAuditTaskQuery struct{}

type CreateImageRetryAuditTaskReq added in v1.0.118

type CreateImageRetryAuditTaskReq struct {
	*CreateImageRetryAuditTaskQuery
	*CreateImageRetryAuditTaskBody
}

type CreateImageRetryAuditTaskRes added in v1.0.140

type CreateImageRetryAuditTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageRetryAuditTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageRetryAuditTaskResResult `json:"Result"`
}

type CreateImageRetryAuditTaskResResponseMetadata added in v1.0.140

type CreateImageRetryAuditTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageRetryAuditTaskResResult added in v1.0.140

type CreateImageRetryAuditTaskResResult struct {

	// REQUIRED
	Result string `json:"Result"`
}

type CreateImageService added in v1.0.140

type CreateImageService struct{}

type CreateImageServiceBody added in v1.0.140

type CreateImageServiceBody struct {

	// REQUIRED; 服务名称,最多不超过32个字符
	ServiceName string `json:"ServiceName"`

	// REQUIRED; 服务所在区域,cn或va或sg
	ServiceRegion string `json:"ServiceRegion"`

	// 创建服务时绑定的域名列表
	Domains []*CreateImageServiceBodyDomainsItem `json:"Domains,omitempty"`

	// 服务绑定的项目。仅对ToB账号请求生效,默认default
	ProjectName string `json:"ProjectName,omitempty"`

	// 服务绑定的标签。仅对ToB账号请求生效,默认空,不绑定标签。
	ResourceTags []*CreateImageServiceBodyResourceTagsItem `json:"ResourceTags,omitempty"`

	// 取值为StaticRc时表示创建「静态资源托管服务」,取值为Image时表示创建「图片处理服务」。默认创建「图片处理服务」
	ServiceType string `json:"ServiceType,omitempty"`

	// 存储TTL,单位秒
	StorageTTL int `json:"StorageTTL,omitempty"`
}

type CreateImageServiceBodyDomainsItem added in v1.0.140

type CreateImageServiceBodyDomainsItem struct {

	// REQUIRED; 域名
	Domain string `json:"Domain"`

	// 证书ID
	CertID string `json:"CertID,omitempty"`
}

type CreateImageServiceBodyResourceTagsItem added in v1.0.140

type CreateImageServiceBodyResourceTagsItem struct {

	// REQUIRED; 标签键
	Key string `json:"Key"`

	// REQUIRED; 标签值
	Value string `json:"Value"`
}

type CreateImageServiceQuery added in v1.0.140

type CreateImageServiceQuery struct{}

type CreateImageServiceReq added in v1.0.140

type CreateImageServiceReq struct {
	*CreateImageServiceQuery
	*CreateImageServiceBody
}

type CreateImageServiceRes added in v1.0.140

type CreateImageServiceRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageServiceResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageServiceResResult `json:"Result"`
}

type CreateImageServiceResResponseMetadata added in v1.0.140

type CreateImageServiceResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED
	Error *CreateImageServiceResResponseMetadataError `json:"Error"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageServiceResResponseMetadataError added in v1.0.140

type CreateImageServiceResResponseMetadataError struct {

	// REQUIRED; 错误码
	Code string `json:"Code"`

	// REQUIRED; 错误信息
	Message string `json:"Message"`
}

type CreateImageServiceResResult added in v1.0.140

type CreateImageServiceResResult struct {

	// REQUIRED; 创建的服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 服务的名称。
	ServiceName string `json:"ServiceName"`
}

type CreateImageTemplate added in v1.0.140

type CreateImageTemplate struct{}

type CreateImageTemplateBody added in v1.0.140

type CreateImageTemplateBody struct {

	// REQUIRED; 模板名称,必须使用该服务的图片模板固定前缀,具体参考GetImageService接口的返回参数TemplatePrefix。模板名称能包含的字符正则集合为[a-zA-Z0-9_-]
	TemplateName string `json:"TemplateName"`

	// 图像格式自适应配置
	AdaptiveFmt *CreateImageTemplateBodyAdaptiveFmt `json:"AdaptiveFmt,omitempty"`

	// 仅当指定输出格式为静图时,配置有效。 动图截帧配置。
	AnimExtract *CreateImageTemplateBodyAnimExtract `json:"AnimExtract,omitempty"`

	// 视频转动图配置
	Animation *CreateImageTemplateBodyAnimation `json:"Animation,omitempty"`

	// 模板计划使用的降级格式,仅对heic静图有效
	DemotionFormat string `json:"DemotionFormat,omitempty"`

	// 是否直接更新模板。如果为true,已有的线上模板会同步更新,直接生效;如果为false,会新增一个模板,已有模板不受影响。
	DoUpdate bool `json:"DoUpdate,omitempty"`

	// 对结果图片执行的画质评估配置
	Evals []*CreateImageTemplateBodyEvalsItem `json:"Evals,omitempty"`

	// 仅当指定输出格式非动图时,配置有效。 保留 EXIF 信息配置。
	Exif *CreateImageTemplateBodyExif `json:"Exif,omitempty"`

	// 对图片的编辑操作
	Filters []*CreateImageTemplateBodyFiltersItem `json:"Filters,omitempty"`

	// 对图片编码使用的质量参数,默认为0
	OuputQuality int `json:"OuputQuality,omitempty"`

	// 用于图片服务输出时的图片编码
	OutputExtra *CreateImageTemplateBodyOutputExtra `json:"OutputExtra,omitempty"`

	// 该模板计划使用的输出格式
	OutputFormat string `json:"OutputFormat,omitempty"`

	// 图片模板使用的参数列表,URL中下发参数的顺序需要跟列表中的保持一致
	Parameters []string `json:"Parameters,omitempty"`

	// 处理结果持久化
	Persistence string `json:"Persistence,omitempty"`

	// 绝对质量/相对质量
	QualityMode string `json:"QualityMode,omitempty"`

	// URL的失效期,为Unix时间戳,一般配置为通过模板参数下发
	ReqDeadline string `json:"ReqDeadline,omitempty"`

	// 视频截帧配置
	Snapshot *CreateImageTemplateBodySnapshot `json:"Snapshot,omitempty"`

	// 是否同步处理,仅对heic图有效
	Sync bool `json:"Sync,omitempty"`

	// 是否为临时使用,取值如下所示:
	// * true:是
	// * false:否
	Temporary bool `json:"Temporary,omitempty"`

	// 是否开启鉴权,一般当通过模板参数下发敏感信息时,比如文字水印内容、URL失效期,需要对图片URL鉴权保护,防止内容被篡改
	WithSig bool `json:"WithSig,omitempty"`
}

type CreateImageTemplateBodyAdaptiveFmt added in v1.0.140

type CreateImageTemplateBodyAdaptiveFmt struct {

	// 动图自适应,可选"webp"/"heic"/"avif"/"dynamic"
	Animated string `json:"Animated,omitempty"`

	// 静图自适应,可选"webp"/"heic"/"avif"/"dynamic"
	Static string `json:"Static,omitempty"`
}

CreateImageTemplateBodyAdaptiveFmt - 图像格式自适应配置

type CreateImageTemplateBodyAnimExtract added in v1.0.140

type CreateImageTemplateBodyAnimExtract struct {

	// 动图截帧策略,取值如下所示:
	// * 0:智能模式,从动图首帧开始逐帧检测当前帧亮度是否大于 80,并最终返回第一个亮度大于 80 的帧。
	// * 1:全局最优,从动图首帧开始逐帧检测并返回亮度最大的一帧。
	Strategy int `json:"Strategy,omitempty"`

	// 动图异步处理超时时间,单位为 ms。默认为 1500,取值负数时表示无超时时间。若在指定时间范围内处理未完成则返回失败。
	Timeout int `json:"Timeout,omitempty"`
}

CreateImageTemplateBodyAnimExtract - 仅当指定输出格式为静图时,配置有效。 动图截帧配置。

type CreateImageTemplateBodyAnimation added in v1.0.140

type CreateImageTemplateBodyAnimation struct {

	// REQUIRED; 降级类型: image:抽取一帧降级返回 video:直接返回原视频降级
	DemotionType string `json:"DemotionType"`

	// REQUIRED; 动图时长(ms)
	Duration int `json:"Duration"`

	// REQUIRED; 帧率,1秒X帧
	FramePerSecond int `json:"FramePerSecond"`

	// REQUIRED; X秒1帧
	SecondPerFrame int `json:"SecondPerFrame"`

	// REQUIRED; 抽帧策略: fps:frame per second,1秒X帧 spf:second per frame,X秒1帧 key:抽取关键帧
	SelectFrameMode string `json:"SelectFrameMode"`

	// REQUIRED; 动图起始时间戳(ms)
	StartTime int `json:"StartTime"`

	// REQUIRED; 同步等待时长(s),超时未完成则根据DemotionType降级
	WaitTime int `json:"WaitTime"`
}

CreateImageTemplateBodyAnimation - 视频转动图配置

type CreateImageTemplateBodyEvalsItem added in v1.0.140

type CreateImageTemplateBodyEvalsItem struct {

	// REQUIRED; 评估名,画质评估固定取值为 quality。
	Name string `json:"Name"`

	// REQUIRED; 画质评估参数配置内容,Key 为 参数名称,Value 为 参数配置。具体详情请见图片编辑数据结构 [https://www.volcengine.com/docs/508/127820]。
	Param map[string]interface{} `json:"Param"`
}

type CreateImageTemplateBodyExif added in v1.0.140

type CreateImageTemplateBodyExif struct {

	// 是否开启保留全部 EXIF 信息。取值如下所示:
	// * true:是
	// * false:否
	AutoOrientOff bool `json:"AutoOrientOff,omitempty"`

	// 是否开启保留全部 EXIF 信息,取值如下所示:
	// * true:是
	// * false:否
	ExifReserve bool `json:"ExifReserve,omitempty"`

	// 保留部分 EXIF 信息的具体内容,多个之间用,分隔。更多信息请参考标准 EXIF 标签 [https://exiv2.org/tags.html]。
	ExifRetainNames []string `json:"ExifRetainNames,omitempty"`
}

CreateImageTemplateBodyExif - 仅当指定输出格式非动图时,配置有效。 保留 EXIF 信息配置。

type CreateImageTemplateBodyFiltersItem added in v1.0.140

type CreateImageTemplateBodyFiltersItem struct {

	// REQUIRED; 编辑操作的名称
	Name string `json:"Name"`

	// REQUIRED; 编辑操作的参数
	Param map[string]interface{} `json:"Param"`
}

type CreateImageTemplateBodyOutputExtra added in v1.0.140

type CreateImageTemplateBodyOutputExtra struct {

	// 是否带透明通道编码,"false"/"true"
	HeicAlphaReserve string `json:"heic.alpha.reserve,omitempty"`

	// heic位深,"8"/"10"
	HeicEncodeDepth string `json:"heic.encode.depth,omitempty"`

	// heic格式是否开启ROI编码"true"/"false"
	HeicRoi string `json:"heic.roi,omitempty"`

	// heic缩略图比例
	HeicThumbRatio string `json:"heic.thumb.ratio,omitempty"`

	// 是否采用jpeg渐进编码格式,取值为"true" / "false"
	JPEGProgressive string `json:"jpeg.progressive,omitempty"`

	// 是否压缩颜色空间,取值为"true" / "false"
	PNGUseQuant string `json:"png.use_quant,omitempty"`
}

CreateImageTemplateBodyOutputExtra - 用于图片服务输出时的图片编码

type CreateImageTemplateBodySnapshot added in v1.0.140

type CreateImageTemplateBodySnapshot struct {

	// REQUIRED; 截图类型,可选"default"/"offset",智能截图和指定时间戳截图
	Type string `json:"Type"`

	// 截图的时间戳(ms)
	TimeOffsetMs int `json:"TimeOffsetMs,omitempty"`

	// 当 Type 为 offset 时,在TimeOffsetMs 和 TimeOffsetMsStr 之间二选一。 指定截图时间为使用模板参数动态下发的方式,取值固定为${snapshot_time}。
	TimeOffsetMsStr string `json:"TimeOffsetMsStr,omitempty"`
}

CreateImageTemplateBodySnapshot - 视频截帧配置

type CreateImageTemplateQuery added in v1.0.140

type CreateImageTemplateQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateImageTemplateReq added in v1.0.140

type CreateImageTemplateReq struct {
	*CreateImageTemplateQuery
	*CreateImageTemplateBody
}

type CreateImageTemplateRes added in v1.0.140

type CreateImageTemplateRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageTemplateResResponseMetadata `json:"ResponseMetadata"`

	// title
	Result *CreateImageTemplateResResult `json:"Result,omitempty"`
}

type CreateImageTemplateResResponseMetadata added in v1.0.140

type CreateImageTemplateResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageTemplateResResult added in v1.0.140

type CreateImageTemplateResResult struct {

	// REQUIRED; 模板的创建时间
	CreateAt string `json:"CreateAt"`

	// REQUIRED; 服务id
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 创建的模板名称,如果基于原模板更新,则会生成一个新模板
	TemplateName string `json:"TemplateName"`

	// REQUIRED; 不支持的filter参数
	Unsupported []*CreateImageTemplateResResultUnsupportedItem `json:"Unsupported"`
}

CreateImageTemplateResResult - title

type CreateImageTemplateResResultUnsupportedItem added in v1.0.140

type CreateImageTemplateResResultUnsupportedItem struct {

	// REQUIRED; filter名称
	Name string `json:"Name"`

	// REQUIRED; 参数对象
	Param map[string]interface{} `json:"Param"`
}

type CreateImageTranscodeCallback added in v1.0.140

type CreateImageTranscodeCallback struct{}

type CreateImageTranscodeCallbackBody added in v1.0.140

type CreateImageTranscodeCallbackBody struct {

	// REQUIRED; 任务条目 ID
	EntryID string `json:"EntryId"`
}

type CreateImageTranscodeCallbackQuery added in v1.0.140

type CreateImageTranscodeCallbackQuery struct{}

type CreateImageTranscodeCallbackReq added in v1.0.140

type CreateImageTranscodeCallbackReq struct {
	*CreateImageTranscodeCallbackQuery
	*CreateImageTranscodeCallbackBody
}

type CreateImageTranscodeCallbackRes added in v1.0.140

type CreateImageTranscodeCallbackRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageTranscodeCallbackResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type CreateImageTranscodeCallbackResResponseMetadata added in v1.0.140

type CreateImageTranscodeCallbackResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateImageTranscodeQueue added in v1.0.140

type CreateImageTranscodeQueue struct{}

type CreateImageTranscodeQueueBody added in v1.0.140

type CreateImageTranscodeQueueBody struct {

	// REQUIRED; 是否启动队列,开始执行离线转码操作。取值如下所示:
	// * true:启动
	// * false:不启动
	IsStart bool `json:"IsStart"`

	// REQUIRED; 自定义任务队列名称
	Name string `json:"Name"`

	// 队列回调设置
	CallbackConf *CreateImageTranscodeQueueBodyCallbackConf `json:"CallbackConf,omitempty"`

	// 自定义任务队列描述,可用于备注该队列的用途。
	Desc string `json:"Desc,omitempty"`

	// 队列区域。默认当前区域。ToB支持取值:cn、va、sg。
	Region string `json:"Region,omitempty"`
}

type CreateImageTranscodeQueueBodyCallbackConf added in v1.0.140

type CreateImageTranscodeQueueBodyCallbackConf struct {

	// REQUIRED; 若配置CallbackConf则不为空
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 若配置CallbackConf则不为空
	Method string `json:"Method"`

	// 业务自定义回调参数,将在回调消息的callback_args中透传出去。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/1104726#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	Args string `json:"Args,omitempty"`

	// 回调数据格式。取值如下所示:
	// * XML
	// * JSON(默认)
	DataFormat string `json:"DataFormat,omitempty"`
}

CreateImageTranscodeQueueBodyCallbackConf - 队列回调设置

type CreateImageTranscodeQueueQuery added in v1.0.140

type CreateImageTranscodeQueueQuery struct{}

type CreateImageTranscodeQueueReq added in v1.0.140

type CreateImageTranscodeQueueReq struct {
	*CreateImageTranscodeQueueQuery
	*CreateImageTranscodeQueueBody
}

type CreateImageTranscodeQueueRes added in v1.0.140

type CreateImageTranscodeQueueRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageTranscodeQueueResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageTranscodeQueueResResult `json:"Result"`
}

type CreateImageTranscodeQueueResResponseMetadata added in v1.0.140

type CreateImageTranscodeQueueResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageTranscodeQueueResResult added in v1.0.140

type CreateImageTranscodeQueueResResult struct {

	// REQUIRED; 任务 ID
	QueueID string `json:"QueueId"`
}

type CreateImageTranscodeTask added in v1.0.140

type CreateImageTranscodeTask struct{}

type CreateImageTranscodeTaskBody added in v1.0.140

type CreateImageTranscodeTaskBody struct {

	// REQUIRED; 待转码的图片 uri 或 url 列表。DataList和Filelist都不为空时,DataList优先生效。 :::warning 若DataType取值uri,则待转码图片 URI 必须为指定ServiceId下的存储
	// URI。您可通过调用GetImageUploadFiles [https://www.volcengine.com/docs/508/9392]
	// 获取指定服务下全部的上传文件存储 URI。 :::
	DataList []string `json:"DataList"`

	// REQUIRED; 数据类型,取值如下所示:
	// * uri
	// * url
	DataType string `json:"DataType"`

	// REQUIRED; 待转码的图片 uri 或 url 文件列表。DataList和Filelist都不为空时,DataList优先生效。
	FileList []string `json:"FileList"`

	// REQUIRED; 服务 ID。若DataType取值uri,则提交的图片 URI 列表需在该服务可访问范围内。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 转码模板。您可通过调用GetAllImageTemplates [https://www.volcengine.com/docs/508/9386]获取指定服务下全部模版信息。
	Template string `json:"Template"`

	// 任务回调配置。缺省情况下默认使用队列回调配置。
	CallbackConf *CreateImageTranscodeTaskBodyCallbackConf `json:"CallbackConf,omitempty"`

	// 转码是否保留 exif。取值如下所示:
	// * true:保留
	// * false:(默认)不保留
	EnableExif bool `json:"EnableExif,omitempty"`

	// 任务队列名称 ID。缺省情况下提交至账号默认任务队列。您可通过调用GetImageTranscodeQueues [https://www.volcengine.com/docs/508/1107341]获取该账号下全部任务队列 ID。
	QueueID string `json:"QueueId,omitempty"`

	// 转码产物的 Storekey 列表,仅当DataList不为空时有效,长度需与DataList长度一致。不传时默认使用固定规则生成产物的 Storekey。
	ResKeyList []string `json:"ResKeyList,omitempty"`
}

type CreateImageTranscodeTaskBodyCallbackConf added in v1.0.140

type CreateImageTranscodeTaskBodyCallbackConf struct {

	// REQUIRED; Method=MQ时取值rmq:{topic}/{cluster}
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 还支持取值 MQ
	Method string `json:"Method"`

	// 业务自定义回调参数,将在回调消息的callback_args中透传出去。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/1104726#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	Args string `json:"Args,omitempty"`

	// 回调数据格式。取值如下所示:
	// * XML
	// * JSON(默认)
	DataFormat string `json:"DataFormat,omitempty"`
}

CreateImageTranscodeTaskBodyCallbackConf - 任务回调配置。缺省情况下默认使用队列回调配置。

type CreateImageTranscodeTaskQuery added in v1.0.140

type CreateImageTranscodeTaskQuery struct{}

type CreateImageTranscodeTaskReq added in v1.0.140

type CreateImageTranscodeTaskReq struct {
	*CreateImageTranscodeTaskQuery
	*CreateImageTranscodeTaskBody
}

type CreateImageTranscodeTaskRes added in v1.0.140

type CreateImageTranscodeTaskRes struct {

	// REQUIRED
	ResponseMetadata *CreateImageTranscodeTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *CreateImageTranscodeTaskResResult `json:"Result"`
}

type CreateImageTranscodeTaskResResponseMetadata added in v1.0.140

type CreateImageTranscodeTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type CreateImageTranscodeTaskResResult added in v1.0.140

type CreateImageTranscodeTaskResResult struct {

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`
}

type CreateTemplatesFromBin added in v1.0.140

type CreateTemplatesFromBin struct{}

type CreateTemplatesFromBinBody added in v1.0.140

type CreateTemplatesFromBinBody struct {

	// REQUIRED; 待恢复模板名称。 :::tip 您可以通过调用获取回收站中所有模板 [https://www.volcengine.com/docs/508/132241]获取所需的模板名称。 :::
	TemplateNames []string `json:"TemplateNames"`
}

type CreateTemplatesFromBinQuery added in v1.0.140

type CreateTemplatesFromBinQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type CreateTemplatesFromBinReq added in v1.0.140

type CreateTemplatesFromBinReq struct {
	*CreateTemplatesFromBinQuery
	*CreateTemplatesFromBinBody
}

type CreateTemplatesFromBinRes added in v1.0.140

type CreateTemplatesFromBinRes struct {

	// REQUIRED
	ResponseMetadata *CreateTemplatesFromBinResResponseMetadata `json:"ResponseMetadata"`
	Result           *CreateTemplatesFromBinResResult           `json:"Result,omitempty"`
}

type CreateTemplatesFromBinResResponseMetadata added in v1.0.140

type CreateTemplatesFromBinResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type CreateTemplatesFromBinResResult added in v1.0.140

type CreateTemplatesFromBinResResult struct {

	// REQUIRED; 返回各模版恢复的结果。
	Results []*CreateTemplatesFromBinResResultResultsItem `json:"Results"`
}

type CreateTemplatesFromBinResResultResultsItem added in v1.0.140

type CreateTemplatesFromBinResResultResultsItem struct {

	// REQUIRED; 回收站中的模版名。
	BinName string `json:"BinName"`

	// REQUIRED; 恢复后的模版名。
	NewName string `json:"NewName"`

	// REQUIRED; 是否恢复成功。
	Success bool `json:"Success"`
}

type DelDomain added in v1.0.140

type DelDomain struct{}

type DelDomainBody added in v1.0.140

type DelDomainBody struct {

	// REQUIRED; 域名,您可以通过 获取服务下全部域名 [https://www.volcengine.com/docs/508/9379] 获取服务下域名信息。
	Domain string `json:"Domain"`
}

type DelDomainQuery added in v1.0.140

type DelDomainQuery struct {

	// REQUIRED; imagex服务ID
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type DelDomainReq added in v1.0.140

type DelDomainReq struct {
	*DelDomainQuery
	*DelDomainBody
}

type DelDomainRes added in v1.0.140

type DelDomainRes struct {

	// REQUIRED
	ResponseMetadata *DelDomainResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type DelDomainResResponseMetadata added in v1.0.140

type DelDomainResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteImageAnalyzeTask added in v1.0.140

type DeleteImageAnalyzeTask struct{}

type DeleteImageAnalyzeTaskBody added in v1.0.140

type DeleteImageAnalyzeTaskBody struct {

	// REQUIRED; 待删除的任务 ID,您可以通过调用 GetImageAnalyzeTasks [https://www.volcengine.com/docs/508/1160417] 获取指定地区全部离线评估任务 ID。
	TaskID string `json:"TaskId"`
}

type DeleteImageAnalyzeTaskQuery added in v1.0.140

type DeleteImageAnalyzeTaskQuery struct{}

type DeleteImageAnalyzeTaskReq added in v1.0.140

type DeleteImageAnalyzeTaskReq struct {
	*DeleteImageAnalyzeTaskQuery
	*DeleteImageAnalyzeTaskBody
}

type DeleteImageAnalyzeTaskRes added in v1.0.140

type DeleteImageAnalyzeTaskRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageAnalyzeTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type DeleteImageAnalyzeTaskResResponseMetadata added in v1.0.140

type DeleteImageAnalyzeTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DeleteImageAnalyzeTaskRun added in v1.0.140

type DeleteImageAnalyzeTaskRun struct{}

type DeleteImageAnalyzeTaskRunBody added in v1.0.140

type DeleteImageAnalyzeTaskRunBody struct {

	// REQUIRED; 执行 ID,您可以通过调用 GetImageAnalyzeResult [https://www.volcengine.com/docs/508/1160419] 获取该任务全部的执行记录查看执行 ID。
	RunID string `json:"RunId"`

	// REQUIRED; 待删除执行记录的任务 ID,您可以通过调用 GetImageAnalyzeTasks [https://www.volcengine.com/docs/508/1160417] 获取指定地区全部离线评估任务 ID。
	TaskID string `json:"TaskId"`
}

type DeleteImageAnalyzeTaskRunQuery added in v1.0.140

type DeleteImageAnalyzeTaskRunQuery struct{}

type DeleteImageAnalyzeTaskRunReq added in v1.0.140

type DeleteImageAnalyzeTaskRunReq struct {
	*DeleteImageAnalyzeTaskRunQuery
	*DeleteImageAnalyzeTaskRunBody
}

type DeleteImageAnalyzeTaskRunRes added in v1.0.140

type DeleteImageAnalyzeTaskRunRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageAnalyzeTaskRunResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type DeleteImageAnalyzeTaskRunResResponseMetadata added in v1.0.140

type DeleteImageAnalyzeTaskRunResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DeleteImageAuditResult added in v1.0.140

type DeleteImageAuditResult struct{}

type DeleteImageAuditResultBody added in v1.0.140

type DeleteImageAuditResultBody struct {

	// REQUIRED; 审核结果 ID,您可通过调用获取审核任务结果 [https://www.volcengine.com/docs/508/1160410]查看待更新状态的图片条目 ID。
	EntryID string `json:"EntryId"`

	// REQUIRED; 任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId"`
}

type DeleteImageAuditResultQuery added in v1.0.140

type DeleteImageAuditResultQuery struct{}

type DeleteImageAuditResultReq added in v1.0.118

type DeleteImageAuditResultReq struct {
	*DeleteImageAuditResultQuery
	*DeleteImageAuditResultBody
}

type DeleteImageAuditResultRes added in v1.0.140

type DeleteImageAuditResultRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageAuditResultResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type DeleteImageAuditResultResResponseMetadata added in v1.0.140

type DeleteImageAuditResultResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DeleteImageMigrateTask added in v1.0.140

type DeleteImageMigrateTask struct{}

type DeleteImageMigrateTaskBody added in v1.0.140

type DeleteImageMigrateTaskBody struct{}

type DeleteImageMigrateTaskQuery added in v1.0.140

type DeleteImageMigrateTaskQuery struct {

	// REQUIRED; 仅当任务状态为非Running时生效。 任务 ID,请参考GetImageMigrateTasks [https://www.volcengine.com/docs/508/1108670]获取返回的任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`

	// 任务地区(即任务目标服务的地区),默认空,返回国内任务。
	// * cn:国内
	// * va:美东
	// * sg:新加坡
	Region string `json:"Region,omitempty" query:"Region"`
}

type DeleteImageMigrateTaskReq added in v1.0.140

type DeleteImageMigrateTaskReq struct {
	*DeleteImageMigrateTaskQuery
	*DeleteImageMigrateTaskBody
}

type DeleteImageMigrateTaskRes added in v1.0.140

type DeleteImageMigrateTaskRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageMigrateTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type DeleteImageMigrateTaskResResponseMetadata added in v1.0.140

type DeleteImageMigrateTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteImageService added in v1.0.140

type DeleteImageService struct{}

type DeleteImageServiceBody added in v1.0.140

type DeleteImageServiceBody struct{}

type DeleteImageServiceQuery added in v1.0.140

type DeleteImageServiceQuery struct {

	// 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId,omitempty" query:"ServiceId"`
}

type DeleteImageServiceReq added in v1.0.140

type DeleteImageServiceReq struct {
	*DeleteImageServiceQuery
	*DeleteImageServiceBody
}

type DeleteImageServiceRes added in v1.0.140

type DeleteImageServiceRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageServiceResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type DeleteImageServiceResResponseMetadata added in v1.0.140

type DeleteImageServiceResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteImageTemplate added in v1.0.140

type DeleteImageTemplate struct{}

type DeleteImageTemplateBody added in v1.0.140

type DeleteImageTemplateBody struct {

	// REQUIRED; 待删除模板名称,不能超过100个。模板需要从属于参数中的service。
	TemplateNames []string `json:"TemplateNames"`
}

type DeleteImageTemplateQuery added in v1.0.140

type DeleteImageTemplateQuery struct {

	// REQUIRED; imagex服务ID
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type DeleteImageTemplateReq added in v1.0.140

type DeleteImageTemplateReq struct {
	*DeleteImageTemplateQuery
	*DeleteImageTemplateBody
}

type DeleteImageTemplateRes added in v1.0.140

type DeleteImageTemplateRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageTemplateResResponseMetadata `json:"ResponseMetadata"`

	// title
	Result *DeleteImageTemplateResResult `json:"Result,omitempty"`
}

type DeleteImageTemplateResResponseMetadata added in v1.0.140

type DeleteImageTemplateResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteImageTemplateResResult added in v1.0.140

type DeleteImageTemplateResResult struct {

	// REQUIRED; 成功删除的模板名称。如果入参为单个模板,删除失败直接返回错误。如果为多个模板,全部删除失败,返回错误;否则返回成功删除的模板。
	TemplateNames []string `json:"TemplateNames"`
}

DeleteImageTemplateResResult - title

type DeleteImageTranscodeDetail added in v1.0.140

type DeleteImageTranscodeDetail struct{}

type DeleteImageTranscodeDetailBody added in v1.0.140

type DeleteImageTranscodeDetailBody struct {

	// 待删除的entry ID列表
	Entries []string `json:"Entries,omitempty"`

	// 待删除的entry ID
	EntryID string `json:"EntryId,omitempty"`
}

type DeleteImageTranscodeDetailQuery added in v1.0.140

type DeleteImageTranscodeDetailQuery struct{}

type DeleteImageTranscodeDetailReq added in v1.0.140

type DeleteImageTranscodeDetailReq struct {
	*DeleteImageTranscodeDetailQuery
	*DeleteImageTranscodeDetailBody
}

type DeleteImageTranscodeDetailRes added in v1.0.140

type DeleteImageTranscodeDetailRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageTranscodeDetailResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type DeleteImageTranscodeDetailResResponseMetadata added in v1.0.140

type DeleteImageTranscodeDetailResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DeleteImageTranscodeQueue added in v1.0.140

type DeleteImageTranscodeQueue struct{}

type DeleteImageTranscodeQueueBody added in v1.0.140

type DeleteImageTranscodeQueueBody struct {

	// REQUIRED; 待删除的队列 ID,您可通过调用GetImageTranscodeQueues [https://www.volcengine.com/docs/508/1107341]获取该账号下全部任务队列 ID。 账号内置默认任务队列不允许被删除。
	QueueID string `json:"QueueId"`
}

type DeleteImageTranscodeQueueQuery added in v1.0.140

type DeleteImageTranscodeQueueQuery struct{}

type DeleteImageTranscodeQueueReq added in v1.0.140

type DeleteImageTranscodeQueueReq struct {
	*DeleteImageTranscodeQueueQuery
	*DeleteImageTranscodeQueueBody
}

type DeleteImageTranscodeQueueRes added in v1.0.140

type DeleteImageTranscodeQueueRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageTranscodeQueueResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type DeleteImageTranscodeQueueResResponseMetadata added in v1.0.140

type DeleteImageTranscodeQueueResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DeleteImageUploadFiles added in v1.0.140

type DeleteImageUploadFiles struct{}

type DeleteImageUploadFilesBody added in v1.0.140

type DeleteImageUploadFilesBody struct {

	// REQUIRED; 文件 Uri 列表,最多传 1000 个。
	StoreUris []string `json:"StoreUris"`
}

type DeleteImageUploadFilesQuery added in v1.0.140

type DeleteImageUploadFilesQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type DeleteImageUploadFilesReq added in v1.0.140

type DeleteImageUploadFilesReq struct {
	*DeleteImageUploadFilesQuery
	*DeleteImageUploadFilesBody
}

type DeleteImageUploadFilesRes added in v1.0.140

type DeleteImageUploadFilesRes struct {

	// REQUIRED
	ResponseMetadata *DeleteImageUploadFilesResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *DeleteImageUploadFilesResResult `json:"Result,omitempty"`
}

type DeleteImageUploadFilesResResponseMetadata added in v1.0.140

type DeleteImageUploadFilesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteImageUploadFilesResResult added in v1.0.140

type DeleteImageUploadFilesResResult struct {

	// REQUIRED; 成功删除的文件 Uri 列表。
	DeletedFiles []string `json:"DeletedFiles"`
}

DeleteImageUploadFilesResResult - 视请求的接口而定

type DeleteTemplatesFromBin added in v1.0.140

type DeleteTemplatesFromBin struct{}

type DeleteTemplatesFromBinBody added in v1.0.140

type DeleteTemplatesFromBinBody struct {

	// REQUIRED; 待删除模板名称。 :::tip 您可以通过调用获取回收站中所有模板 [https://www.volcengine.com/docs/508/132241]获取所需的模板名称。 :::
	TemplateNames []string `json:"TemplateNames"`
}

type DeleteTemplatesFromBinQuery added in v1.0.140

type DeleteTemplatesFromBinQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type DeleteTemplatesFromBinReq added in v1.0.140

type DeleteTemplatesFromBinReq struct {
	*DeleteTemplatesFromBinQuery
	*DeleteTemplatesFromBinBody
}

type DeleteTemplatesFromBinRes added in v1.0.140

type DeleteTemplatesFromBinRes struct {

	// REQUIRED
	ResponseMetadata *DeleteTemplatesFromBinResResponseMetadata `json:"ResponseMetadata"`
	Result           *DeleteTemplatesFromBinResResult           `json:"Result,omitempty"`
}

type DeleteTemplatesFromBinResResponseMetadata added in v1.0.140

type DeleteTemplatesFromBinResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DeleteTemplatesFromBinResResult added in v1.0.140

type DeleteTemplatesFromBinResResult struct {

	// REQUIRED; 成功删除的模板名称。
	// * 如果指定为单个模板,删除失败直接返回错误。
	// * 如果指定多个模板,如果全部删除失败则返回错误;否则返回成功删除的模板。
	TemplateNames []string `json:"TemplateNames"`
}

type DescribeImageVolcCdnAccessLog added in v1.0.140

type DescribeImageVolcCdnAccessLog struct{}

type DescribeImageVolcCdnAccessLogBody added in v1.0.140

type DescribeImageVolcCdnAccessLogBody struct {

	// REQUIRED; 域名,您可以通过获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取服务下域名信息。
	Domain string `json:"Domain"`

	// REQUIRED; 指定一个结束时间对日志进行过滤,时间格式是 Unix 时间戳。 例子1:您指定 EndTime 为 1641953589,代表 2022-01-12 10:13:09 UTC。在查询返回的日志列表中,最后一个统计在内的日志包名称是
	// domain2022011210000020220112110000.gz。该日志包中包含该域名在 10:00:00 和 10:59:59 之间的访问日志。
	EndTime int `json:"EndTime"`

	// REQUIRED; 指定一个页码。系统只返回该页面上的那些日志包。 默认值为 1。如果指定的页码不存在,则返回空值。建议第一次提交查询时使用默认值。您可以根据响应正文中的 TotalCount 和 PageSize 参数的值计算结果页数。然后再查询中指定一个
	// PageNum 来获取该页面上的那些日志包。
	PageNum int `json:"PageNum"`

	// REQUIRED; 指定查询结果中每页包含的日志包数量。 默认值是 10,最大值是 100。
	PageSize int `json:"PageSize"`

	// REQUIRED; 指定一个加速区域对日志进行过滤。该参数仅当您通过提交工单启用了 中国大陆 以外的加速区域时才有效。 该参数有以下取值: chinesemainland:表示获取访问请求是来自 中国大陆 的日志。查询返回的日志包的名称不包含
	// outsideChineseMainland。 global:表示获取访问请求是来自 全球 的日志。 outsidechinese_mainland:表示获取访问请求是来自
	// 全球(除中国大陆) 的日志。查询返回的日志包的名称包含 outsideChineseMainland。 该参数的默认值是 global
	Region string `json:"Region"`

	// REQUIRED; 指定一个开始时间对日志进行过滤,时间格式是 Unix 时间戳。 例子1:您指定 StartTime 为 1641844915,代表 2022-01-11 04:01:55 UTC。在查询返回的日志列表中,第一个统计在内的日志包名称是domain2022011105000020220111060000.gz。该日志包中包含该域名在
	// 05:00:00 和 05:59:59 之间的访问日志。
	// StartTime 和 EndTime 之间的时间范围不能大于 30 天。
	StartTime int `json:"StartTime"`
}

type DescribeImageVolcCdnAccessLogQuery added in v1.0.140

type DescribeImageVolcCdnAccessLogQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type DescribeImageVolcCdnAccessLogRes added in v1.0.140

type DescribeImageVolcCdnAccessLogRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageVolcCdnAccessLogResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageVolcCdnAccessLogResResult `json:"Result"`
}

type DescribeImageVolcCdnAccessLogResResponseMetadata added in v1.0.140

type DescribeImageVolcCdnAccessLogResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED
	Error *DescribeImageVolcCdnAccessLogResResponseMetadataError `json:"Error"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageVolcCdnAccessLogResResponseMetadataError added in v1.0.140

type DescribeImageVolcCdnAccessLogResResponseMetadataError struct {

	// REQUIRED; 错误码
	Code string `json:"Code"`

	// REQUIRED; 错误信息
	Message string `json:"Message"`
}

type DescribeImageVolcCdnAccessLogResResult added in v1.0.140

type DescribeImageVolcCdnAccessLogResResult struct {

	// REQUIRED; 加速域名。
	Domain string `json:"Domain"`

	// REQUIRED; 查询的日志数据。
	Logs []*DescribeImageVolcCdnAccessLogResResultLogsItem `json:"Logs"`

	// REQUIRED; 指定的页码数。
	PageNum int `json:"PageNum"`

	// REQUIRED; 指定的每页日志包数量。
	PageSize int `json:"PageSize"`

	// REQUIRED; 日志包总数。
	TotalCount int `json:"TotalCount"`
}

type DescribeImageVolcCdnAccessLogResResultLogsItem added in v1.0.140

type DescribeImageVolcCdnAccessLogResResultLogsItem struct {

	// REQUIRED; 日志结束时间。
	EndTime int `json:"EndTime"`

	// REQUIRED; 日志包名称。
	LogName string `json:"LogName"`

	// REQUIRED; 日志包下载地址,下载链接有效时间为 10 分钟。
	LogPath string `json:"LogPath"`

	// REQUIRED; 日志包大小,单位为 byte。
	LogSize int `json:"LogSize"`

	// REQUIRED; 日志起始时间。
	StartTime int `json:"StartTime"`
}

type DescribeImageXBaseOpUsage added in v1.0.140

type DescribeImageXBaseOpUsage struct{}

type DescribeImageXBaseOpUsageBody added in v1.0.140

type DescribeImageXBaseOpUsageBody struct{}

type DescribeImageXBaseOpUsageQuery added in v1.0.140

type DescribeImageXBaseOpUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXBaseOpUsageRes added in v1.0.140

type DescribeImageXBaseOpUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXBaseOpUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXBaseOpUsageResResult `json:"Result"`
}

type DescribeImageXBaseOpUsageResResponseMetadata added in v1.0.140

type DescribeImageXBaseOpUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXBaseOpUsageResResult added in v1.0.140

type DescribeImageXBaseOpUsageResResult struct {

	// REQUIRED; 计量数据列表
	BaseOpData []*DescribeImageXBaseOpUsageResResultBaseOpDataItem `json:"BaseOpData"`
}

type DescribeImageXBaseOpUsageResResultBaseOpDataItem added in v1.0.140

type DescribeImageXBaseOpUsageResResultBaseOpDataItem struct {

	// REQUIRED; 计量数据
	Data []*DescribeImageXBaseOpUsageResResultBaseOpDataPropertiesItemsItem `json:"Data"`
}

type DescribeImageXBaseOpUsageResResultBaseOpDataPropertiesItemsItem added in v1.0.140

type DescribeImageXBaseOpUsageResResultBaseOpDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 基础处理量,单位Byte
	Value float64 `json:"Value"`
}

type DescribeImageXBillingRequestCntUsage added in v1.0.140

type DescribeImageXBillingRequestCntUsage struct{}

type DescribeImageXBillingRequestCntUsageBody added in v1.0.140

type DescribeImageXBillingRequestCntUsageBody struct{}

type DescribeImageXBillingRequestCntUsageQuery added in v1.0.140

type DescribeImageXBillingRequestCntUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。 日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 固定值,仅支持AdvFeat即附加组件。
	GroupBy string `json:"GroupBy" query:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。 日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 组件名称。为空时表示不筛选,支持查询多个AdvFeat,不同的AdvFeat使用逗号分隔。 您可通过调用GetImageAddOnConf [https://www.volcengine.com/docs/508/66145]查看Key返回值。
	AdvFeats string `json:"AdvFeats,omitempty" query:"AdvFeats"`

	// 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,不同的服务使用逗号分隔。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXBillingRequestCntUsageReq added in v1.0.140

type DescribeImageXBillingRequestCntUsageReq struct {
	*DescribeImageXBillingRequestCntUsageQuery
	*DescribeImageXBillingRequestCntUsageBody
}

type DescribeImageXBillingRequestCntUsageRes added in v1.0.140

type DescribeImageXBillingRequestCntUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXBillingRequestCntUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXBillingRequestCntUsageResResult `json:"Result"`
}

type DescribeImageXBillingRequestCntUsageResResponseMetadata added in v1.0.140

type DescribeImageXBillingRequestCntUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXBillingRequestCntUsageResResult added in v1.0.140

type DescribeImageXBillingRequestCntUsageResResult struct {

	// REQUIRED; 附加组件通用请求次数据。
	RequestCntData []*DescribeImageXBillingRequestCntUsageResResultRequestCntDataItem `json:"RequestCntData"`
}

type DescribeImageXBillingRequestCntUsageResResultRequestCntDataItem added in v1.0.140

type DescribeImageXBillingRequestCntUsageResResultRequestCntDataItem struct {

	// REQUIRED; 附加组件类型,如:enhance,smartcut。 取值为total,表示包含所选AdvFeat请求次数相加。
	AdvFeat string `json:"AdvFeat"`

	// REQUIRED; 时序数据列表。
	Data []*DescribeImageXBillingRequestCntUsageResResultRequestCntDataPropertiesItemsItem `json:"Data"`
}

type DescribeImageXBillingRequestCntUsageResResultRequestCntDataPropertiesItemsItem added in v1.0.140

type DescribeImageXBillingRequestCntUsageResResultRequestCntDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 请求次
	Value int `json:"Value"`
}

type DescribeImageXBucketUsage added in v1.0.140

type DescribeImageXBucketUsage struct{}

type DescribeImageXBucketUsageBody added in v1.0.140

type DescribeImageXBucketUsageBody struct{}

type DescribeImageXBucketUsageQuery added in v1.0.140

type DescribeImageXBucketUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// Bucket 名称。支持同时查询多个 BucketName,不同的 BucketNmae 使用逗号分隔。 您可以通过调用 GetAllImageServices [https://www.volcengine.com/docs/508/9360]
	// 获取所需的 Bucket 名称。
	BucketNames string `json:"BucketNames,omitempty" query:"BucketNames"`

	// 需要分组查询的参数,多个数据用逗号分隔。支持取值如下:
	// * ServiceId:服务 ID
	// * BucketName:Bucket 名称
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXBucketUsageRes added in v1.0.140

type DescribeImageXBucketUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXBucketUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXBucketUsageResResult `json:"Result"`
}

type DescribeImageXBucketUsageResResponseMetadata added in v1.0.140

type DescribeImageXBucketUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXBucketUsageResResult added in v1.0.140

type DescribeImageXBucketUsageResResult struct {

	// REQUIRED; 计量数据列表
	StorageData []*DescribeImageXBucketUsageResResultStorageDataItem `json:"StorageData"`
}

type DescribeImageXBucketUsageResResultStorageDataItem added in v1.0.140

type DescribeImageXBucketUsageResResultStorageDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXBucketUsageResResultStorageDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy中包含BucketName时出现
	BucketName string `json:"BucketName,omitempty"`

	// 当GroupBy中包含ServiceId时出现
	ServiceID string `json:"ServiceId,omitempty"`
}

type DescribeImageXBucketUsageResResultStorageDataPropertiesItemsItem added in v1.0.140

type DescribeImageXBucketUsageResResultStorageDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 单位:Byte
	Value float64 `json:"Value"`
}

type DescribeImageXCDNTopRequestData added in v1.0.140

type DescribeImageXCDNTopRequestData struct{}

type DescribeImageXCDNTopRequestDataBody added in v1.0.140

type DescribeImageXCDNTopRequestDataBody struct{}

type DescribeImageXCDNTopRequestDataQuery added in v1.0.140

type DescribeImageXCDNTopRequestDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 排序指标。取值如下所示:
	// * URL:生成的图片访问 URL
	// * UserAgent:用户代理
	// * Refer:请求 Refer
	// * ClientIP:客户端 IP
	// * Region:访问区域
	// * Domain:域名
	// * Isp:运营商
	KeyType string `json:"KeyType" query:"KeyType"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	StartTime string `json:"StartTime" query:"StartTime"`

	// REQUIRED; 排序依据,即获取按ValueType值排序的KeyType列表。取值如下所示:
	// * Traffic:按流量排序
	// * RequestCnt:按请求次数排序
	// :::tip 当KeyType取值为Domain时,ValueType仅支持取值为Traffic,即按照流量排序获取域名列表。 :::
	ValueType string `json:"ValueType" query:"ValueType"`

	// 数据访问区域。仅在KeyType取值为Region或Isp时生效,取值如下所示:
	// * China:中国。
	// * Other:中国境外的区域。
	Country string `json:"Country,omitempty" query:"Country"`

	// 域名。传入多个时用“,”作为分割符,缺省情况下表示不限制域名。您可以通过调用获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取所需的域名。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 网络协议。缺省情况下则表示不限制网络协议,取值如下所示:
	// * IPv4
	// * IPv6
	// :::tipKeyType取值为Domain时,IPVersion的取值无效。 :::
	IPVersion string `json:"IPVersion,omitempty" query:"IPVersion"`

	// 每页查询数据量,默认为0,即返回所有数据。
	Limit string `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量,默认取值为0。取值为10时,表示跳过前 10 条数据,从第 11 条数据开始取值。
	Offset string `json:"Offset,omitempty" query:"Offset"`

	// 服务 ID。传入多个时用“,”作为分割符,缺省情况下表示不限制服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXCDNTopRequestDataRes added in v1.0.140

type DescribeImageXCDNTopRequestDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCDNTopRequestDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCDNTopRequestDataResResult `json:"Result"`
}

type DescribeImageXCDNTopRequestDataResResponseMetadata added in v1.0.140

type DescribeImageXCDNTopRequestDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCDNTopRequestDataResResult added in v1.0.140

type DescribeImageXCDNTopRequestDataResResult struct {

	// REQUIRED; 可展示的数据总数量。
	Count int `json:"Count"`

	// REQUIRED; 数据列表,按Value降序排列。
	TopValue []*DescribeImageXCDNTopRequestDataResResultTopValueItem `json:"TopValue"`

	// REQUIRED; 全量Traffic/RequestCnt的总量,用于计算占比。Traffic单位:Byte。RequestCnt单位:次。
	TotalValue float64 `json:"TotalValue"`
}

type DescribeImageXCDNTopRequestDataResResultTopValueItem added in v1.0.140

type DescribeImageXCDNTopRequestDataResResultTopValueItem struct {

	// REQUIRED; 对应于参数KeyType,维度。
	Key string `json:"Key"`

	// REQUIRED; Traffic/RequestCnt,指标值。Traffic单位:Byte。RequestCnt单位:次。
	Value float64 `json:"Value"`
}

type DescribeImageXCdnDurationAll added in v1.0.140

type DescribeImageXCdnDurationAll struct{}

type DescribeImageXCdnDurationAllBody added in v1.0.140

type DescribeImageXCdnDurationAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 Domain:域名; Region:地区; Isp:运营商。
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnDurationAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 排序依据。 Duration:按耗时排序。 Count:(默认)按上报量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnDurationAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnDurationAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnDurationAllQuery added in v1.0.140

type DescribeImageXCdnDurationAllQuery struct{}

type DescribeImageXCdnDurationAllRes added in v1.0.140

type DescribeImageXCdnDurationAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnDurationAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnDurationAllResResult `json:"Result"`
}

type DescribeImageXCdnDurationAllResResponseMetadata added in v1.0.140

type DescribeImageXCdnDurationAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnDurationAllResResult added in v1.0.140

type DescribeImageXCdnDurationAllResResult struct {

	// REQUIRED; 网络耗时数据。
	DurationData []*DescribeImageXCdnDurationAllResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXCdnDurationAllResResultDurationDataItem added in v1.0.140

type DescribeImageXCdnDurationAllResResultDurationDataItem struct {

	// REQUIRED; 上报数据量。
	Count int `json:"Count"`

	// REQUIRED; 网络耗时,单位毫秒
	Value float64 `json:"Value"`

	// 当GroupBy取值Domain时出现,则表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 Country表示国家。 Province表示省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXCdnDurationDetailByTime added in v1.0.140

type DescribeImageXCdnDurationDetailByTime struct{}

type DescribeImageXCdnDurationDetailByTimeBody added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnDurationDetailByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:Duration(拆分网络耗时分位数据)、Phase(拆分网络耗时分布数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 指定查询特定阶段的耗时数据。默认空,返回总耗时数据。 dns: DNS 耗时,即网络阶段的 DNS 平均耗时。 ssl: SSL 耗时,即网络阶段的 SSL 握手平均耗时。 connect:连接耗时,即网络阶段的 TCP 建立连接平均耗时。
	// send:发送耗时,即网络阶段的发送数据平均耗时。 wait:等待耗时,即网络阶段发送完数据后等待首个回包字节的耗时。
	// receive:接收耗时,即网络阶段的接收数据耗时。 proxy:代理耗时,即网络阶段的建立代理连接的耗时。
	Phase string `json:"Phase,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnDurationDetailByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnDurationDetailByTimeQuery added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeQuery struct{}

type DescribeImageXCdnDurationDetailByTimeRes added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnDurationDetailByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnDurationDetailByTimeResResult `json:"Result"`
}

type DescribeImageXCdnDurationDetailByTimeResResponseMetadata added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnDurationDetailByTimeResResult added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeResResult struct {

	// REQUIRED; 网络耗时数据
	DurationData []*DescribeImageXCdnDurationDetailByTimeResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXCdnDurationDetailByTimeResResultDurationDataItem added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeResResultDurationDataItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的网络耗时数据列表。
	Data []*DescribeImageXCdnDurationDetailByTimeResResultDurationDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 当GroupBy为空时,取值为:Total。 当GroupBy为Duration时,取值为:pct25、pct50、pct90、pct99、avg。 当GroupBy为Phase时,取值为:dns、ssl、connect、send、wait、receive、proxy。
	// 除上述外取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXCdnDurationDetailByTimeResResultDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnDurationDetailByTimeResResultDurationDataPropertiesItemsItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 平均耗时,单位毫秒
	Value float64 `json:"Value"`
}

type DescribeImageXCdnErrorCodeAll added in v1.0.140

type DescribeImageXCdnErrorCodeAll struct{}

type DescribeImageXCdnErrorCodeAllBody added in v1.0.140

type DescribeImageXCdnErrorCodeAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 Domain:域名; ErrorCode:错误码; Region:地区; Isp:运营商。
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnErrorCodeAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnErrorCodeAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnErrorCodeAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnErrorCodeAllQuery added in v1.0.140

type DescribeImageXCdnErrorCodeAllQuery struct{}

type DescribeImageXCdnErrorCodeAllRes added in v1.0.140

type DescribeImageXCdnErrorCodeAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnErrorCodeAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnErrorCodeAllResResult `json:"Result"`
}

type DescribeImageXCdnErrorCodeAllResResponseMetadata added in v1.0.140

type DescribeImageXCdnErrorCodeAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnErrorCodeAllResResult added in v1.0.140

type DescribeImageXCdnErrorCodeAllResResult struct {

	// REQUIRED; 错误码数据
	ErrorCodeData []*DescribeImageXCdnErrorCodeAllResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXCdnErrorCodeAllResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXCdnErrorCodeAllResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量
	Value int `json:"Value"`

	// 当GroupBy取值非ErrorCode时出现,表示错误码详细信息。
	Details []*DescribeImageXCdnErrorCodeAllResResultErrorCodeDataPropertiesItemsItem `json:"Details,omitempty"`

	// 当GroupBy取值Domain时出现,则表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码内容。
	ErrorCode string `json:"ErrorCode,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码的描述信息。
	ErrorCodeDesc string `json:"ErrorCodeDesc,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 取值Country时,表示国家; 取值Province时,表示省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXCdnErrorCodeAllResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnErrorCodeAllResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码内容
	ErrorCode string `json:"ErrorCode"`

	// REQUIRED; 错误码的描述信息
	ErrorCodeDesc string `json:"ErrorCodeDesc"`

	// REQUIRED; 错误码数量
	Value int `json:"Value"`
}

type DescribeImageXCdnErrorCodeByTime added in v1.0.140

type DescribeImageXCdnErrorCodeByTime struct{}

type DescribeImageXCdnErrorCodeByTimeBody added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnErrorCodeByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnErrorCodeByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnErrorCodeByTimeQuery added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeQuery struct{}

type DescribeImageXCdnErrorCodeByTimeRes added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnErrorCodeByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnErrorCodeByTimeResResult `json:"Result"`
}

type DescribeImageXCdnErrorCodeByTimeResResponseMetadata added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnErrorCodeByTimeResResult added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeResResult struct {

	// REQUIRED; 所有错误码数据。
	ErrorCodeData []*DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量
	Count int `json:"Count"`

	// REQUIRED; 错误码对应的时序数据。
	Data []*DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 错误码
	ErrorCode string `json:"ErrorCode"`
}

type DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码数量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 错误码数量
	Value int `json:"Value"`
}

type DescribeImageXCdnProtocolRateByTime added in v1.0.140

type DescribeImageXCdnProtocolRateByTime struct{}

type DescribeImageXCdnProtocolRateByTimeBody added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnProtocolRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnProtocolRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnProtocolRateByTimeQuery added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeQuery struct{}

type DescribeImageXCdnProtocolRateByTimeRes added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnProtocolRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnProtocolRateByTimeResResult `json:"Result"`
}

type DescribeImageXCdnProtocolRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnProtocolRateByTimeResResult added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeResResult struct {

	// REQUIRED; 各协议占比数据
	ProtocolRateData []*DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataItem `json:"ProtocolRateData"`
}

type DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataItem added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的协议占比数据列表。
	Data []*DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 网络协议类型。 取值为:http、https
	Type string `json:"Type"`
}

type DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnProtocolRateByTimeResResultProtocolRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 网络协议占比
	Value float64 `json:"Value"`
}

type DescribeImageXCdnReuseRateAll added in v1.0.140

type DescribeImageXCdnReuseRateAll struct{}

type DescribeImageXCdnReuseRateAllBody added in v1.0.140

type DescribeImageXCdnReuseRateAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度 Domain:域名; Region:地区; Isp:运营商。
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnReuseRateAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 维度区分,不传或者传空默认按上报量排序。 ReuseRate:按连接复用率排序; Count:按上报量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnReuseRateAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnReuseRateAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnReuseRateAllQuery added in v1.0.140

type DescribeImageXCdnReuseRateAllQuery struct{}

type DescribeImageXCdnReuseRateAllRes added in v1.0.140

type DescribeImageXCdnReuseRateAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnReuseRateAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnReuseRateAllResResult `json:"Result"`
}

type DescribeImageXCdnReuseRateAllResResponseMetadata added in v1.0.140

type DescribeImageXCdnReuseRateAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnReuseRateAllResResult added in v1.0.140

type DescribeImageXCdnReuseRateAllResResult struct {

	// REQUIRED; 连接复用率数据。
	ReuseRateData []*DescribeImageXCdnReuseRateAllResResultReuseRateDataItem `json:"ReuseRateData"`
}

type DescribeImageXCdnReuseRateAllResResultReuseRateDataItem added in v1.0.140

type DescribeImageXCdnReuseRateAllResResultReuseRateDataItem struct {

	// REQUIRED; 上报数据量。
	Count int `json:"Count"`

	// REQUIRED; 连接复用率。
	Value float64 `json:"Value"`

	// 当GroupBy取值Domain时出现,表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值Isp时出现,表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 取值Country,表示国家。 取值Province,表示省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXCdnReuseRateByTime added in v1.0.140

type DescribeImageXCdnReuseRateByTime struct{}

type DescribeImageXCdnReuseRateByTimeBody added in v1.0.140

type DescribeImageXCdnReuseRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnReuseRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnReuseRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnReuseRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnReuseRateByTimeQuery added in v1.0.140

type DescribeImageXCdnReuseRateByTimeQuery struct{}

type DescribeImageXCdnReuseRateByTimeRes added in v1.0.140

type DescribeImageXCdnReuseRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnReuseRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnReuseRateByTimeResResult `json:"Result"`
}

type DescribeImageXCdnReuseRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXCdnReuseRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnReuseRateByTimeResResult added in v1.0.140

type DescribeImageXCdnReuseRateByTimeResResult struct {

	// REQUIRED; 连接复用率数据
	ReuseRateData []*DescribeImageXCdnReuseRateByTimeResResultReuseRateDataItem `json:"ReuseRateData"`
}

type DescribeImageXCdnReuseRateByTimeResResultReuseRateDataItem added in v1.0.140

type DescribeImageXCdnReuseRateByTimeResResultReuseRateDataItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的连接复用率数据列表。
	Data []*DescribeImageXCdnReuseRateByTimeResResultReuseRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXCdnReuseRateByTimeResResultReuseRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnReuseRateByTimeResResultReuseRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 网络连接复用率。
	Value float64 `json:"Value"`
}

type DescribeImageXCdnSuccessRateAll added in v1.0.140

type DescribeImageXCdnSuccessRateAll struct{}

type DescribeImageXCdnSuccessRateAllBody added in v1.0.140

type DescribeImageXCdnSuccessRateAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 Domain:域名; Region:地区; Isp:运营商。
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnSuccessRateAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 取值为SuccessRate时,表示按网络成功率排序; 取值为Count时,表示按上报量排序; 不传或者传空默认按上报量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnSuccessRateAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnSuccessRateAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnSuccessRateAllQuery added in v1.0.140

type DescribeImageXCdnSuccessRateAllQuery struct{}

type DescribeImageXCdnSuccessRateAllRes added in v1.0.140

type DescribeImageXCdnSuccessRateAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnSuccessRateAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnSuccessRateAllResResult `json:"Result"`
}

type DescribeImageXCdnSuccessRateAllResResponseMetadata added in v1.0.140

type DescribeImageXCdnSuccessRateAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnSuccessRateAllResResult added in v1.0.140

type DescribeImageXCdnSuccessRateAllResResult struct {

	// REQUIRED; 网络成功率数据。
	SuccessRateData []*DescribeImageXCdnSuccessRateAllResResultSuccessRateDataItem `json:"SuccessRateData"`
}

type DescribeImageXCdnSuccessRateAllResResultSuccessRateDataItem added in v1.0.140

type DescribeImageXCdnSuccessRateAllResResultSuccessRateDataItem struct {

	// REQUIRED; 上报数据量。
	Count int `json:"Count"`

	// REQUIRED; 网络成功率
	Value float64 `json:"Value"`

	// 当GroupBy取值Domain时出现,则表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 取值Country,表示国家; 取值Province,表示省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXCdnSuccessRateByTime added in v1.0.140

type DescribeImageXCdnSuccessRateByTime struct{}

type DescribeImageXCdnSuccessRateByTimeBody added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXCdnSuccessRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXCdnSuccessRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXCdnSuccessRateByTimeQuery added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeQuery struct{}

type DescribeImageXCdnSuccessRateByTimeRes added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCdnSuccessRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCdnSuccessRateByTimeResResult `json:"Result"`
}

type DescribeImageXCdnSuccessRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCdnSuccessRateByTimeResResult added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeResResult struct {

	// REQUIRED; 网络成功率数据
	SuccessRateData []*DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataItem `json:"SuccessRateData"`
}

type DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataItem added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCdnSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 网络成功率
	Value float64 `json:"Value"`
}

type DescribeImageXClientCountByTime added in v1.0.140

type DescribeImageXClientCountByTime struct{}

type DescribeImageXClientCountByTimeBody added in v1.0.140

type DescribeImageXClientCountByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientCountByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientCountByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientCountByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientCountByTimeQuery added in v1.0.140

type DescribeImageXClientCountByTimeQuery struct{}

type DescribeImageXClientCountByTimeRes added in v1.0.140

type DescribeImageXClientCountByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientCountByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientCountByTimeResResult `json:"Result"`
}

type DescribeImageXClientCountByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientCountByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientCountByTimeResResult added in v1.0.140

type DescribeImageXClientCountByTimeResResult struct {

	// REQUIRED; 客户端上报量数据。
	ClientCountData []*DescribeImageXClientCountByTimeResResultClientCountDataItem `json:"ClientCountData"`
}

type DescribeImageXClientCountByTimeResResultClientCountDataItem added in v1.0.140

type DescribeImageXClientCountByTimeResResultClientCountDataItem struct {

	// REQUIRED; 该数据类型对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的客户端上报量数据列表。
	Data []*DescribeImageXClientCountByTimeResResultClientCountDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientCountByTimeResResultClientCountDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientCountByTimeResResultClientCountDataPropertiesItemsItem struct {

	// REQUIRED; 上报量数据
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上报量数据
	Value int `json:"Value"`
}

type DescribeImageXClientDecodeDurationByTime added in v1.0.140

type DescribeImageXClientDecodeDurationByTime struct{}

type DescribeImageXClientDecodeDurationByTimeBody added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientDecodeDurationByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(拆分分位数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientDecodeDurationByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientDecodeDurationByTimeQuery added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeQuery struct{}

type DescribeImageXClientDecodeDurationByTimeRes added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientDecodeDurationByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientDecodeDurationByTimeResResult `json:"Result"`
}

type DescribeImageXClientDecodeDurationByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientDecodeDurationByTimeResResult added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeResResult struct {

	// REQUIRED; 解码耗时数据
	DurationData []*DescribeImageXClientDecodeDurationByTimeResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXClientDecodeDurationByTimeResResultDurationDataItem added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeResResultDurationDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的解码耗时数据列表。
	Data []*DescribeImageXClientDecodeDurationByTimeResResultDurationDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。当GroupBy为空或Duration时,取值avg/pct25/pct50/pct90/pct99/min/max,否则取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXClientDecodeDurationByTimeResResultDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientDecodeDurationByTimeResResultDurationDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 平均耗时,单位毫秒
	Value float64 `json:"Value"`
}

type DescribeImageXClientDecodeSuccessRateByTime added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTime struct{}

type DescribeImageXClientDecodeSuccessRateByTimeBody added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientDecodeSuccessRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientDecodeSuccessRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientDecodeSuccessRateByTimeQuery added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeQuery struct{}

type DescribeImageXClientDecodeSuccessRateByTimeRes added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientDecodeSuccessRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientDecodeSuccessRateByTimeResResult `json:"Result"`
}

type DescribeImageXClientDecodeSuccessRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientDecodeSuccessRateByTimeResResult added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeResResult struct {

	// REQUIRED; 解码成功率数据
	SuccessRateData []*DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataItem `json:"SuccessRateData"`
}

type DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataItem added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的解码成功率数据列表。
	Data []*DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientDecodeSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 解码成功率
	Value float64 `json:"Value"`
}

type DescribeImageXClientDemotionRateByTime added in v1.0.140

type DescribeImageXClientDemotionRateByTime struct{}

type DescribeImageXClientDemotionRateByTimeBody added in v1.0.140

type DescribeImageXClientDemotionRateByTimeBody struct {

	// REQUIRED; 降级类型。取值如下所示: heic:查询 heic 降级率 heif:查询 heif 降级率 avif:查询 avif 降级率
	DemotionType string `json:"DemotionType"`

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientDemotionRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(拆分分位数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientDemotionRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientDemotionRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientDemotionRateByTimeQuery added in v1.0.140

type DescribeImageXClientDemotionRateByTimeQuery struct{}

type DescribeImageXClientDemotionRateByTimeRes added in v1.0.140

type DescribeImageXClientDemotionRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientDemotionRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientDemotionRateByTimeResResult `json:"Result"`
}

type DescribeImageXClientDemotionRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientDemotionRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientDemotionRateByTimeResResult added in v1.0.140

type DescribeImageXClientDemotionRateByTimeResResult struct {

	// REQUIRED; 降级率数据
	DemotionRateData []*DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataItem `json:"DemotionRateData"`
}

type DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataItem added in v1.0.140

type DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientDemotionRateByTimeResResultDemotionRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 降级率
	Value float64 `json:"Value"`
}

type DescribeImageXClientErrorCodeAll added in v1.0.140

type DescribeImageXClientErrorCodeAll struct{}

type DescribeImageXClientErrorCodeAllBody added in v1.0.140

type DescribeImageXClientErrorCodeAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 Domain:域名; ErrorCode:错误码; Region:地区; Isp:运营商。
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientErrorCodeAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientErrorCodeAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientErrorCodeAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientErrorCodeAllQuery added in v1.0.140

type DescribeImageXClientErrorCodeAllQuery struct{}

type DescribeImageXClientErrorCodeAllRes added in v1.0.140

type DescribeImageXClientErrorCodeAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientErrorCodeAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientErrorCodeAllResResult `json:"Result"`
}

type DescribeImageXClientErrorCodeAllResResponseMetadata added in v1.0.140

type DescribeImageXClientErrorCodeAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientErrorCodeAllResResult added in v1.0.140

type DescribeImageXClientErrorCodeAllResResult struct {

	// REQUIRED; 错误码数据
	ErrorCodeData []*DescribeImageXClientErrorCodeAllResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXClientErrorCodeAllResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXClientErrorCodeAllResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量
	Value int `json:"Value"`

	// 当GroupBy取值非ErrorCode时出现,表示错误码详细信息。
	Details []*DescribeImageXClientErrorCodeAllResResultErrorCodeDataPropertiesItemsItem `json:"Details,omitempty"`

	// 当GroupBy取值Domain时出现,则表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码内容。
	ErrorCode string `json:"ErrorCode,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码的描述信息。
	ErrorCodeDesc string `json:"ErrorCodeDesc,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 取值Country,表示国家。 取值Province,表示省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXClientErrorCodeAllResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientErrorCodeAllResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码内容
	ErrorCode string `json:"ErrorCode"`

	// REQUIRED; 错误码的描述信息
	ErrorCodeDesc string `json:"ErrorCodeDesc"`

	// REQUIRED; 错误码数量
	Value int `json:"Value"`
}

type DescribeImageXClientErrorCodeByTime added in v1.0.140

type DescribeImageXClientErrorCodeByTime struct{}

type DescribeImageXClientErrorCodeByTimeBody added in v1.0.140

type DescribeImageXClientErrorCodeByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientErrorCodeByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientErrorCodeByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientErrorCodeByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientErrorCodeByTimeQuery added in v1.0.140

type DescribeImageXClientErrorCodeByTimeQuery struct{}

type DescribeImageXClientErrorCodeByTimeRes added in v1.0.140

type DescribeImageXClientErrorCodeByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientErrorCodeByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientErrorCodeByTimeResResult `json:"Result"`
}

type DescribeImageXClientErrorCodeByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientErrorCodeByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientErrorCodeByTimeResResult added in v1.0.140

type DescribeImageXClientErrorCodeByTimeResResult struct {

	// REQUIRED; 所有错误码数据
	ErrorCodeData []*DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量
	Count int `json:"Count"`

	// REQUIRED; 错误码对应的时序数据。
	Data []*DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 错误码
	ErrorCode string `json:"ErrorCode"`
}

type DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码数量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 错误码数量
	Value int `json:"Value"`
}

type DescribeImageXClientFailureRate added in v1.0.140

type DescribeImageXClientFailureRate struct{}

type DescribeImageXClientFailureRateBody added in v1.0.140

type DescribeImageXClientFailureRateBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientFailureRateBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientFailureRateBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientFailureRateBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientFailureRateQuery added in v1.0.140

type DescribeImageXClientFailureRateQuery struct{}

type DescribeImageXClientFailureRateRes added in v1.0.140

type DescribeImageXClientFailureRateRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientFailureRateResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientFailureRateResResult `json:"Result"`
}

type DescribeImageXClientFailureRateResResponseMetadata added in v1.0.140

type DescribeImageXClientFailureRateResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientFailureRateResResult added in v1.0.140

type DescribeImageXClientFailureRateResResult struct {

	// REQUIRED; 用户感知失败率数据
	FailureRateData []*DescribeImageXClientFailureRateResResultFailureRateDataItem `json:"FailureRateData"`
}

type DescribeImageXClientFailureRateResResultFailureRateDataItem added in v1.0.140

type DescribeImageXClientFailureRateResResultFailureRateDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的用户感知失败率数据列表。
	Data []*DescribeImageXClientFailureRateResResultFailureRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientFailureRateResResultFailureRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientFailureRateResResultFailureRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 用户感知失败率
	Value float64 `json:"Value"`
}

type DescribeImageXClientFileSize added in v1.0.140

type DescribeImageXClientFileSize struct{}

type DescribeImageXClientFileSizeBody added in v1.0.140

type DescribeImageXClientFileSizeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientFileSizeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(拆分分位数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientFileSizeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientFileSizeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientFileSizeQuery added in v1.0.140

type DescribeImageXClientFileSizeQuery struct{}

type DescribeImageXClientFileSizeRes added in v1.0.140

type DescribeImageXClientFileSizeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientFileSizeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientFileSizeResResult `json:"Result"`
}

type DescribeImageXClientFileSizeResResponseMetadata added in v1.0.140

type DescribeImageXClientFileSizeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientFileSizeResResult added in v1.0.140

type DescribeImageXClientFileSizeResResult struct {

	// REQUIRED; 客户端文件大小分布数据
	FSizeData []*DescribeImageXClientFileSizeResResultFSizeDataItem `json:"FSizeData"`
}

type DescribeImageXClientFileSizeResResultFSizeDataItem added in v1.0.140

type DescribeImageXClientFileSizeResResultFSizeDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的文件大小数据列表。
	Data []*DescribeImageXClientFileSizeResResultFSizeDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 当GroupBy为空或Duration时,取值avg/pct25/pct50/pct90/pct99/min/max,否则取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXClientFileSizeResResultFSizeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientFileSizeResResultFSizeDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 文件大小,单位byte
	Value float64 `json:"Value"`
}

type DescribeImageXClientLoadDuration added in v1.0.140

type DescribeImageXClientLoadDuration struct{}

type DescribeImageXClientLoadDurationAll added in v1.0.140

type DescribeImageXClientLoadDurationAll struct{}

type DescribeImageXClientLoadDurationAllBody added in v1.0.140

type DescribeImageXClientLoadDurationAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 Domain:域名 Region:地区 Isp:运营商
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientLoadDurationAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientLoadDurationAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientLoadDurationAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientLoadDurationAllQuery added in v1.0.140

type DescribeImageXClientLoadDurationAllQuery struct{}

type DescribeImageXClientLoadDurationAllRes added in v1.0.140

type DescribeImageXClientLoadDurationAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientLoadDurationAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientLoadDurationAllResResult `json:"Result"`
}

type DescribeImageXClientLoadDurationAllResResponseMetadata added in v1.0.140

type DescribeImageXClientLoadDurationAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientLoadDurationAllResResult added in v1.0.140

type DescribeImageXClientLoadDurationAllResResult struct {

	// REQUIRED; 网络耗时数据
	DurationData []*DescribeImageXClientLoadDurationAllResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXClientLoadDurationAllResResultDurationDataItem added in v1.0.140

type DescribeImageXClientLoadDurationAllResResultDurationDataItem struct {

	// REQUIRED; 上报数据量
	Count int `json:"Count"`

	// REQUIRED; 加载耗时,单位为毫秒
	Value float64 `json:"Value"`

	// 当GroupBy取值Domain时出现,则表示域名信息。
	Domain string `json:"Domain,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 Country:国家。 Province:省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXClientLoadDurationBody added in v1.0.140

type DescribeImageXClientLoadDurationBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientLoadDurationBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(拆分分位数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientLoadDurationBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientLoadDurationBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientLoadDurationQuery added in v1.0.140

type DescribeImageXClientLoadDurationQuery struct{}

type DescribeImageXClientLoadDurationRes added in v1.0.140

type DescribeImageXClientLoadDurationRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientLoadDurationResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientLoadDurationResResult `json:"Result"`
}

type DescribeImageXClientLoadDurationResResponseMetadata added in v1.0.140

type DescribeImageXClientLoadDurationResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientLoadDurationResResult added in v1.0.140

type DescribeImageXClientLoadDurationResResult struct {

	// REQUIRED; 加载耗时数据
	DurationData []*DescribeImageXClientLoadDurationResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXClientLoadDurationResResultDurationDataItem added in v1.0.140

type DescribeImageXClientLoadDurationResResultDurationDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的加载耗时数据列表
	Data []*DescribeImageXClientLoadDurationResResultDurationDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。当GroupBy为空或Duration时,取值avg/pct25/pct50/pct75/pct90/pct95/pct99/min/max,否则取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXClientLoadDurationResResultDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientLoadDurationResResultDurationDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 平均耗时,单位毫秒
	Value float64 `json:"Value"`
}

type DescribeImageXClientQualityRateByTime added in v1.0.140

type DescribeImageXClientQualityRateByTime struct{}

type DescribeImageXClientQualityRateByTimeBody added in v1.0.140

type DescribeImageXClientQualityRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 质量类型。取值如下所示: whitesuspected:查询白屏率 blacksuspected:查询黑屏率 transparent_suspected:查询透明图率
	QualityType string `json:"QualityType"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientQualityRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientQualityRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientQualityRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientQualityRateByTimeQuery added in v1.0.140

type DescribeImageXClientQualityRateByTimeQuery struct{}

type DescribeImageXClientQualityRateByTimeRes added in v1.0.140

type DescribeImageXClientQualityRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientQualityRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientQualityRateByTimeResResult `json:"Result"`
}

type DescribeImageXClientQualityRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientQualityRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientQualityRateByTimeResResult added in v1.0.140

type DescribeImageXClientQualityRateByTimeResResult struct {

	// REQUIRED; 黑白屏率数据
	QualityRateData []*DescribeImageXClientQualityRateByTimeResResultQualityRateDataItem `json:"QualityRateData"`
}

type DescribeImageXClientQualityRateByTimeResResultQualityRateDataItem added in v1.0.140

type DescribeImageXClientQualityRateByTimeResResultQualityRateDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXClientQualityRateByTimeResResultQualityRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientQualityRateByTimeResResultQualityRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientQualityRateByTimeResResultQualityRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 黑白屏率
	Value float64 `json:"Value"`
}

type DescribeImageXClientQueueDurationByTime added in v1.0.140

type DescribeImageXClientQueueDurationByTime struct{}

type DescribeImageXClientQueueDurationByTimeBody added in v1.0.140

type DescribeImageXClientQueueDurationByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientQueueDurationByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(拆分分位数据)、公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientQueueDurationByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientQueueDurationByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientQueueDurationByTimeQuery added in v1.0.140

type DescribeImageXClientQueueDurationByTimeQuery struct{}

type DescribeImageXClientQueueDurationByTimeRes added in v1.0.140

type DescribeImageXClientQueueDurationByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientQueueDurationByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientQueueDurationByTimeResResult `json:"Result"`
}

type DescribeImageXClientQueueDurationByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientQueueDurationByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientQueueDurationByTimeResResult added in v1.0.140

type DescribeImageXClientQueueDurationByTimeResResult struct {

	// REQUIRED; 排队耗时数据
	DurationData []*DescribeImageXClientQueueDurationByTimeResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXClientQueueDurationByTimeResResultDurationDataItem added in v1.0.140

type DescribeImageXClientQueueDurationByTimeResResultDurationDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 对应的排队耗时数据列表
	Data []*DescribeImageXClientQueueDurationByTimeResResultDurationDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 当GroupBy为空或Duration时,取值avg/pct25/pct50/pct90/pct99/min/max,否则取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXClientQueueDurationByTimeResResultDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientQueueDurationByTimeResResultDurationDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 平均耗时,单位毫秒
	Value float64 `json:"Value"`
}

type DescribeImageXClientScoreByTime added in v1.0.140

type DescribeImageXClientScoreByTime struct{}

type DescribeImageXClientScoreByTimeBody added in v1.0.140

type DescribeImageXClientScoreByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 打分类型。取值如下所示: vq:查询vqscore指标 aes:查询美学指标 noi:查询噪声指标 psnr:查询psnr指标 ssim:查询ssim指标 vmaf:查询vmaf指标
	ScoreType string `json:"ScoreType"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientScoreByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType,Country,Province,Isp,Domain),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientScoreByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientScoreByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientScoreByTimeQuery added in v1.0.140

type DescribeImageXClientScoreByTimeQuery struct{}

type DescribeImageXClientScoreByTimeRes added in v1.0.140

type DescribeImageXClientScoreByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientScoreByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientScoreByTimeResResult `json:"Result"`
}

type DescribeImageXClientScoreByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientScoreByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientScoreByTimeResResult added in v1.0.140

type DescribeImageXClientScoreByTimeResResult struct {

	// REQUIRED; 画质打分数据
	ScoreData []*DescribeImageXClientScoreByTimeResResultScoreDataItem `json:"ScoreData"`
}

type DescribeImageXClientScoreByTimeResResultScoreDataItem added in v1.0.140

type DescribeImageXClientScoreByTimeResResultScoreDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXClientScoreByTimeResResultScoreDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXClientScoreByTimeResResultScoreDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientScoreByTimeResResultScoreDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 画质打分
	Value float64 `json:"Value"`
}

type DescribeImageXClientSdkVerByTime added in v1.0.140

type DescribeImageXClientSdkVerByTime struct{}

type DescribeImageXClientSdkVerByTimeBody added in v1.0.140

type DescribeImageXClientSdkVerByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的域名,不传则匹配所有域名
	Domain []string `json:"Domain,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXClientSdkVerByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXClientSdkVerByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXClientSdkVerByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXClientSdkVerByTimeQuery added in v1.0.140

type DescribeImageXClientSdkVerByTimeQuery struct{}

type DescribeImageXClientSdkVerByTimeRes added in v1.0.140

type DescribeImageXClientSdkVerByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientSdkVerByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientSdkVerByTimeResResult `json:"Result"`
}

type DescribeImageXClientSdkVerByTimeResResponseMetadata added in v1.0.140

type DescribeImageXClientSdkVerByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientSdkVerByTimeResResult added in v1.0.140

type DescribeImageXClientSdkVerByTimeResResult struct {

	// REQUIRED; SDK版本数据
	SdkVerData []*DescribeImageXClientSdkVerByTimeResResultSdkVerDataItem `json:"SdkVerData"`
}

type DescribeImageXClientSdkVerByTimeResResultSdkVerDataItem added in v1.0.140

type DescribeImageXClientSdkVerByTimeResResultSdkVerDataItem struct {

	// REQUIRED; 该 SDK 版本对应的总上报量。
	Count int `json:"Count"`

	// REQUIRED; 对应的版本数据列表。
	Data []*DescribeImageXClientSdkVerByTimeResResultSdkVerDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; SDK版本号
	SdkVer string `json:"SdkVer"`
}

type DescribeImageXClientSdkVerByTimeResResultSdkVerDataPropertiesItemsItem added in v1.0.140

type DescribeImageXClientSdkVerByTimeResResultSdkVerDataPropertiesItemsItem struct {

	// REQUIRED; 版本数量。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 版本数量。
	Value int `json:"Value"`
}

type DescribeImageXClientTopDemotionURL added in v1.0.140

type DescribeImageXClientTopDemotionURL struct{}

type DescribeImageXClientTopDemotionURLBody added in v1.0.140

type DescribeImageXClientTopDemotionURLBody struct {

	// REQUIRED; 降级类型。取值如下所示: heic:HEIC 降级 heif:HEIF 降级 avif:AVIF 降级
	DemotionType string `json:"DemotionType"`

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 查询 Top URL 条数,取值范围为 [0,1000],默认 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXClientTopDemotionURLQuery added in v1.0.140

type DescribeImageXClientTopDemotionURLQuery struct{}

type DescribeImageXClientTopDemotionURLRes added in v1.0.140

type DescribeImageXClientTopDemotionURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientTopDemotionURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientTopDemotionURLResResult `json:"Result"`
}

type DescribeImageXClientTopDemotionURLResResponseMetadata added in v1.0.140

type DescribeImageXClientTopDemotionURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientTopDemotionURLResResult added in v1.0.140

type DescribeImageXClientTopDemotionURLResResult struct {

	// REQUIRED; Top URL数据
	TopURLData []*DescribeImageXClientTopDemotionURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXClientTopDemotionURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXClientTopDemotionURLResResultTopURLDataItem struct {

	// REQUIRED; 上报数据量
	Count int `json:"Count"`

	// REQUIRED; 文件URL
	URL string `json:"Url"`
}

type DescribeImageXClientTopFileSize added in v1.0.140

type DescribeImageXClientTopFileSize struct{}

type DescribeImageXClientTopFileSizeBody added in v1.0.140

type DescribeImageXClientTopFileSizeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 查询 Top URL 条数,取值范围为[0,1000],默认值为 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXClientTopFileSizeQuery added in v1.0.140

type DescribeImageXClientTopFileSizeQuery struct{}

type DescribeImageXClientTopFileSizeRes added in v1.0.140

type DescribeImageXClientTopFileSizeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientTopFileSizeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientTopFileSizeResResult `json:"Result"`
}

type DescribeImageXClientTopFileSizeResResponseMetadata added in v1.0.140

type DescribeImageXClientTopFileSizeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientTopFileSizeResResult added in v1.0.140

type DescribeImageXClientTopFileSizeResResult struct {

	// REQUIRED; Top URL数据
	TopURLData []*DescribeImageXClientTopFileSizeResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXClientTopFileSizeResResultTopURLDataItem added in v1.0.140

type DescribeImageXClientTopFileSizeResResultTopURLDataItem struct {

	// REQUIRED; 上报数据量
	Count int `json:"Count"`

	// REQUIRED; 文件URL
	URL string `json:"Url"`

	// REQUIRED; 文件大小,单位byte
	Value float64 `json:"Value"`
}

type DescribeImageXClientTopQualityURL added in v1.0.140

type DescribeImageXClientTopQualityURL struct{}

type DescribeImageXClientTopQualityURLBody added in v1.0.140

type DescribeImageXClientTopQualityURLBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 类型。取值如下所示: transparentsuspected:透明图 whitesuspected:白屏 black_suspected:黑屏
	QualityType string `json:"QualityType"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 查询 Top URL 条数,取值范围为 [0,1000],默认 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXClientTopQualityURLQuery added in v1.0.140

type DescribeImageXClientTopQualityURLQuery struct{}

type DescribeImageXClientTopQualityURLRes added in v1.0.140

type DescribeImageXClientTopQualityURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXClientTopQualityURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXClientTopQualityURLResResult `json:"Result"`
}

type DescribeImageXClientTopQualityURLResResponseMetadata added in v1.0.140

type DescribeImageXClientTopQualityURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXClientTopQualityURLResResult added in v1.0.140

type DescribeImageXClientTopQualityURLResResult struct {

	// REQUIRED; Top URL数据
	TopURLData []*DescribeImageXClientTopQualityURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXClientTopQualityURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXClientTopQualityURLResResultTopURLDataItem struct {

	// REQUIRED; 上报数据量
	Count int `json:"Count"`

	// REQUIRED; 文件URL
	URL string `json:"Url"`
}

type DescribeImageXCompressUsage added in v1.0.140

type DescribeImageXCompressUsage struct{}

type DescribeImageXCompressUsageBody added in v1.0.140

type DescribeImageXCompressUsageBody struct{}

type DescribeImageXCompressUsageQuery added in v1.0.140

type DescribeImageXCompressUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位为秒。缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXCompressUsageRes added in v1.0.140

type DescribeImageXCompressUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXCompressUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXCompressUsageResResult `json:"Result"`
}

type DescribeImageXCompressUsageResResponseMetadata added in v1.0.140

type DescribeImageXCompressUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXCompressUsageResResult added in v1.0.140

type DescribeImageXCompressUsageResResult struct {

	// REQUIRED; 压缩量数据
	CompressData []*DescribeImageXCompressUsageResResultCompressDataItem `json:"CompressData"`
}

type DescribeImageXCompressUsageResResultCompressDataItem added in v1.0.140

type DescribeImageXCompressUsageResResultCompressDataItem struct {

	// REQUIRED; 压缩前大小,单位为 byte。
	InSize []*DescribeImageXCompressUsageResResultCompressDataPropertiesItemsItem `json:"InSize"`

	// REQUIRED; 压缩后大小,单位为 byte。
	OutSize []*Components1Xh7Lz4SchemasDescribeimagexcompressusageresPropertiesResultPropertiesCompressdataItemsPropertiesOutsizeItems `json:"OutSize"`
}

type DescribeImageXCompressUsageResResultCompressDataPropertiesItemsItem added in v1.0.140

type DescribeImageXCompressUsageResResultCompressDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 压缩前大小,单位Byte
	Value float64 `json:"Value"`
}

type DescribeImageXDomainBandwidthData added in v1.0.140

type DescribeImageXDomainBandwidthData struct{}

type DescribeImageXDomainBandwidthDataBody added in v1.0.140

type DescribeImageXDomainBandwidthDataBody struct{}

type DescribeImageXDomainBandwidthDataQuery added in v1.0.140

type DescribeImageXDomainBandwidthDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 过滤计费区域。不传表示不过滤,传入多个用英文逗号分隔。支持取值如下:
	// * CHN:中国内地
	// * AP1:亚太一区
	// * AP2:亚太二区
	// * AP3:亚太三区
	// * EU:欧洲
	// * ME:中东和非洲
	// * SA:南美
	// * NA:北美
	// * OTHER:其他
	BillingRegion string `json:"BillingRegion,omitempty" query:"BillingRegion"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 需要分组查询的参数。不传表示不拆分维度,传入多个用英文逗号分隔。支持取值如下:
	// * ServiceId:服务 ID
	// * DomainName:域名
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval int `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXDomainBandwidthDataRes added in v1.0.140

type DescribeImageXDomainBandwidthDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXDomainBandwidthDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXDomainBandwidthDataResResult `json:"Result"`
}

type DescribeImageXDomainBandwidthDataResResponseMetadata added in v1.0.140

type DescribeImageXDomainBandwidthDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXDomainBandwidthDataResResult added in v1.0.140

type DescribeImageXDomainBandwidthDataResResult struct {

	// REQUIRED; 计量数据列表
	BpsData []*DescribeImageXDomainBandwidthDataResResultBpsDataItem `json:"BpsData"`
}

type DescribeImageXDomainBandwidthDataResResultBpsDataItem added in v1.0.140

type DescribeImageXDomainBandwidthDataResResultBpsDataItem struct {

	// REQUIRED; 具体数据。
	Data []*DescribeImageXDomainBandwidthDataResResultBpsDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy中包含DomainName时出现
	DomainName string `json:"DomainName,omitempty"`

	// 当GroupBy中包含ServiceId时出现
	ServiceID string `json:"ServiceId,omitempty"`
}

type DescribeImageXDomainBandwidthDataResResultBpsDataPropertiesItemsItem added in v1.0.140

type DescribeImageXDomainBandwidthDataResResultBpsDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 带宽单位:bps
	Value float64 `json:"Value"`
}

type DescribeImageXDomainBandwidthNinetyFiveData added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveData struct{}

type DescribeImageXDomainBandwidthNinetyFiveDataBody added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveDataBody struct{}

type DescribeImageXDomainBandwidthNinetyFiveDataQuery added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 过滤计费区域。不传表示不过滤,传入多个用英文逗号分隔。支持取值如下:
	// * CHN:中国内地
	// * AP1:亚太一区
	// * AP2:亚太二区
	// * AP3:亚太三区
	// * EU:欧洲
	// * ME:中东和非洲
	// * SA:南美
	// * NA:北美
	// * OTHER:其他
	BillingRegion string `json:"BillingRegion,omitempty" query:"BillingRegion"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXDomainBandwidthNinetyFiveDataRes added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXDomainBandwidthNinetyFiveDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXDomainBandwidthNinetyFiveDataResResult `json:"Result"`
}

type DescribeImageXDomainBandwidthNinetyFiveDataResResponseMetadata added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXDomainBandwidthNinetyFiveDataResResult added in v1.0.140

type DescribeImageXDomainBandwidthNinetyFiveDataResResult struct {

	// REQUIRED; 带宽95值,单位bps
	BpsData float64 `json:"BpsData"`
}

type DescribeImageXDomainTrafficData added in v1.0.140

type DescribeImageXDomainTrafficData struct{}

type DescribeImageXDomainTrafficDataBody added in v1.0.140

type DescribeImageXDomainTrafficDataBody struct{}

type DescribeImageXDomainTrafficDataQuery added in v1.0.140

type DescribeImageXDomainTrafficDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 过滤计费区域。不传表示不过滤。传入多个用英文逗号分隔。支持取值如下:
	// * CHN:中国内地
	// * AP1:亚太一区
	// * AP2:亚太二区
	// * AP3:亚太三区
	// * EU:欧洲
	// * ME:中东和非洲
	// * SA:南美
	// * NA:北美
	// * OTHER:其他
	BillingRegion string `json:"BillingRegion,omitempty" query:"BillingRegion"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 需要分组查询的参数。不传表示不拆分维度,传入多个用英文逗号分隔。支持取值如下:
	// * ServiceId:服务 ID
	// * DomainName:域名
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXDomainTrafficDataRes added in v1.0.140

type DescribeImageXDomainTrafficDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXDomainTrafficDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXDomainTrafficDataResResult `json:"Result"`
}

type DescribeImageXDomainTrafficDataResResponseMetadata added in v1.0.140

type DescribeImageXDomainTrafficDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXDomainTrafficDataResResult added in v1.0.140

type DescribeImageXDomainTrafficDataResResult struct {

	// REQUIRED; 计量数据列表
	TrafficData []*DescribeImageXDomainTrafficDataResResultTrafficDataItem `json:"TrafficData"`
}

type DescribeImageXDomainTrafficDataResResultTrafficDataItem added in v1.0.140

type DescribeImageXDomainTrafficDataResResultTrafficDataItem struct {

	// REQUIRED; 具体数据。
	Data []*DescribeImageXDomainTrafficDataResResultTrafficDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy中包含DomainName时出现
	DomainName string `json:"DomainName,omitempty"`

	// 当GroupBy中包含ServiceId时出现
	ServiceID string `json:"ServiceId,omitempty"`
}

type DescribeImageXDomainTrafficDataResResultTrafficDataPropertiesItemsItem added in v1.0.140

type DescribeImageXDomainTrafficDataResResultTrafficDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 流量单位:Byte。
	Value float64 `json:"Value"`
}

type DescribeImageXEdgeRequest added in v1.0.140

type DescribeImageXEdgeRequest struct{}

type DescribeImageXEdgeRequestBandwidth added in v1.0.140

type DescribeImageXEdgeRequestBandwidth struct{}

type DescribeImageXEdgeRequestBandwidthBody added in v1.0.140

type DescribeImageXEdgeRequestBandwidthBody struct{}

type DescribeImageXEdgeRequestBandwidthQuery added in v1.0.140

type DescribeImageXEdgeRequestBandwidthQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 分组依据,仅支持取值DomainName。
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示:
	// * 电信
	// * 联通
	// * 移动
	// * 鹏博士
	// * 教育网
	// * 广电网
	// * 其它
	Isp string `json:"Isp,omitempty" query:"Isp"`

	// 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示:
	// * HTTP
	// * HTTPS
	Protocols string `json:"Protocols,omitempty" query:"Protocols"`

	// 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示:
	// * 中国大陆
	// * 亚太一区
	// * 亚太二区
	// * 亚太三区
	// * 欧洲区
	// * 北美区
	// * 南美区
	// * 中东区
	Regions string `json:"Regions,omitempty" query:"Regions"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`

	// 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端国家。取值如下所示:
	// * 海外,除中国外全部国家。
	// * 具体国家取值,如中国、美国。
	UserCountry string `json:"UserCountry,omitempty" query:"UserCountry"`

	// 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端省份。
	UserProvince string `json:"UserProvince,omitempty" query:"UserProvince"`
}

type DescribeImageXEdgeRequestBandwidthRes added in v1.0.140

type DescribeImageXEdgeRequestBandwidthRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXEdgeRequestBandwidthResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXEdgeRequestBandwidthResResult `json:"Result"`
}

type DescribeImageXEdgeRequestBandwidthResResponseMetadata added in v1.0.140

type DescribeImageXEdgeRequestBandwidthResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXEdgeRequestBandwidthResResult added in v1.0.140

type DescribeImageXEdgeRequestBandwidthResResult struct {

	// REQUIRED; 带宽数据。
	BpsData []*DescribeImageXEdgeRequestBandwidthResResultBpsDataItem `json:"BpsData"`
}

type DescribeImageXEdgeRequestBandwidthResResultBpsDataItem added in v1.0.140

type DescribeImageXEdgeRequestBandwidthResResultBpsDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXEdgeRequestBandwidthResResultBpsDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy带有DomainName时出现
	DomainName string `json:"DomainName,omitempty"`
}

type DescribeImageXEdgeRequestBandwidthResResultBpsDataPropertiesItemsItem added in v1.0.140

type DescribeImageXEdgeRequestBandwidthResResultBpsDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 带宽,单位为 bps。
	Value float64 `json:"Value"`
}

type DescribeImageXEdgeRequestBody added in v1.0.140

type DescribeImageXEdgeRequestBody struct{}

type DescribeImageXEdgeRequestQuery added in v1.0.140

type DescribeImageXEdgeRequestQuery struct {

	// REQUIRED; 状态码。传入多个时用英文逗号分隔。支持以下取值:
	// * req_cnt:返回所有状态码数据
	// * 2xx:返回 2xx 状态码汇总数据
	// * 3xx:返回 3xx 状态码汇总数据
	// * 4xx:返回 4xx 状态码汇总数据
	// * 5xx:返回 5xx 状态码汇总数据。
	DataTypes string `json:"DataTypes" query:"DataTypes"`

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 是否拆分状态码。取值如下所示:
	// * true:拆分
	// * false:(默认)不拆分
	DetailedCode bool `json:"DetailedCode,omitempty" query:"DetailedCode"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 需要分组查询的参数。传入多个用英文逗号分割。支持以下取值:
	// * DomainName:域名
	// * DataType:状态码
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示:
	// * 电信
	// * 联通
	// * 移动
	// * 鹏博士
	// * 教育网
	// * 广电网
	// * 其它
	Isp string `json:"Isp,omitempty" query:"Isp"`

	// 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示:
	// * HTTP
	// * HTTPS
	Protocols string `json:"Protocols,omitempty" query:"Protocols"`

	// 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示:
	// * 中国大陆
	// * 亚太一区
	// * 亚太二区
	// * 亚太三区
	// * 欧洲区
	// * 北美区
	// * 南美区
	// * 中东区
	Regions string `json:"Regions,omitempty" query:"Regions"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`

	// 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端国家。取值如下所示:
	// * 海外,除中国外全部国家。
	// * 具体国家取值,如中国、美国。
	UserCountry string `json:"UserCountry,omitempty" query:"UserCountry"`

	// 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端省份。
	UserProvince string `json:"UserProvince,omitempty" query:"UserProvince"`
}

type DescribeImageXEdgeRequestRegions added in v1.0.140

type DescribeImageXEdgeRequestRegions struct{}

type DescribeImageXEdgeRequestRegionsBody added in v1.0.140

type DescribeImageXEdgeRequestRegionsBody struct{}

type DescribeImageXEdgeRequestRegionsQuery added in v1.0.140

type DescribeImageXEdgeRequestRegionsQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
	// 起始时间与结束时间间隔小于等于 90 天。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
	// 起始时间与结束时间间隔小于等于 90 天。
	StartTime string `json:"StartTime" query:"StartTime"`
}

type DescribeImageXEdgeRequestRegionsRes added in v1.0.140

type DescribeImageXEdgeRequestRegionsRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXEdgeRequestRegionsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXEdgeRequestRegionsResResult `json:"Result"`
}

type DescribeImageXEdgeRequestRegionsResResponseMetadata added in v1.0.140

type DescribeImageXEdgeRequestRegionsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXEdgeRequestRegionsResResult added in v1.0.140

type DescribeImageXEdgeRequestRegionsResResult struct {

	// REQUIRED; 客户端国家
	UserCountry []string `json:"UserCountry"`

	// REQUIRED; 客户端省份
	UserProvince []string `json:"UserProvince"`
}

type DescribeImageXEdgeRequestRes added in v1.0.140

type DescribeImageXEdgeRequestRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXEdgeRequestResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXEdgeRequestResResult `json:"Result"`
}

type DescribeImageXEdgeRequestResResponseMetadata added in v1.0.140

type DescribeImageXEdgeRequestResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXEdgeRequestResResult added in v1.0.140

type DescribeImageXEdgeRequestResResult struct {

	// REQUIRED; 数据列表 :::tip
	// * 若未设置Interval,则上报一条StartTime与EndTime时间段内查询的全部请求次数据;
	// * 若设置了Interval,则按Interval粒度分段上报查询的时间粒度内请求次数据; :::
	RequestCnt []*DescribeImageXEdgeRequestResResultRequestCntItem `json:"RequestCnt"`
}

type DescribeImageXEdgeRequestResResultRequestCntItem added in v1.0.140

type DescribeImageXEdgeRequestResResultRequestCntItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXEdgeRequestResResultRequestCntPropertiesItemsItem `json:"Data"`

	// 当GroupBy带有DataType时出现
	DataType string `json:"DataType,omitempty"`

	// 当GroupBy带有DomainName时出现
	DomainName string `json:"DomainName,omitempty"`
}

type DescribeImageXEdgeRequestResResultRequestCntPropertiesItemsItem added in v1.0.140

type DescribeImageXEdgeRequestResResultRequestCntPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 请求次数,单位为次。
	Value int `json:"Value"`
}

type DescribeImageXEdgeRequestTraffic added in v1.0.140

type DescribeImageXEdgeRequestTraffic struct{}

type DescribeImageXEdgeRequestTrafficBody added in v1.0.140

type DescribeImageXEdgeRequestTrafficBody struct{}

type DescribeImageXEdgeRequestTrafficQuery added in v1.0.140

type DescribeImageXEdgeRequestTrafficQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 分组依据,仅支持取值DomainName。
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示:
	// * 电信
	// * 联通
	// * 移动
	// * 鹏博士
	// * 教育网
	// * 广电网
	// * 其它
	Isp string `json:"Isp,omitempty" query:"Isp"`

	// 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示:
	// * HTTP
	// * HTTPS
	Protocols string `json:"Protocols,omitempty" query:"Protocols"`

	// 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示:
	// * 中国大陆
	// * 亚太一区
	// * 亚太二区
	// * 亚太三区
	// * 欧洲区
	// * 北美区
	// * 南美区
	// * 中东区
	Regions string `json:"Regions,omitempty" query:"Regions"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`

	// 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端国家。取值如下所示:
	// * 海外,除中国外全部国家。
	// * 具体国家取值,如中国、美国。
	UserCountry string `json:"UserCountry,omitempty" query:"UserCountry"`

	// 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用获取边缘分发地区列表 [https://www.volcengine.com/docs/508/177111]获取 IP 解析后的客户端省份。
	UserProvince string `json:"UserProvince,omitempty" query:"UserProvince"`
}

type DescribeImageXEdgeRequestTrafficRes added in v1.0.140

type DescribeImageXEdgeRequestTrafficRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXEdgeRequestTrafficResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXEdgeRequestTrafficResResult `json:"Result"`
}

type DescribeImageXEdgeRequestTrafficResResponseMetadata added in v1.0.140

type DescribeImageXEdgeRequestTrafficResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXEdgeRequestTrafficResResult added in v1.0.140

type DescribeImageXEdgeRequestTrafficResResult struct {

	// REQUIRED; 查询数据
	TrafficData []*DescribeImageXEdgeRequestTrafficResResultTrafficDataItem `json:"TrafficData"`
}

type DescribeImageXEdgeRequestTrafficResResultTrafficDataItem added in v1.0.140

type DescribeImageXEdgeRequestTrafficResResultTrafficDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXEdgeRequestTrafficResResultTrafficDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy带有DomainName时出现
	DomainName string `json:"DomainName,omitempty"`
}

type DescribeImageXEdgeRequestTrafficResResultTrafficDataPropertiesItemsItem added in v1.0.140

type DescribeImageXEdgeRequestTrafficResResultTrafficDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 流量,单位为 byte。
	Value float64 `json:"Value"`
}

type DescribeImageXHitRateRequestData added in v1.0.140

type DescribeImageXHitRateRequestData struct{}

type DescribeImageXHitRateRequestDataBody added in v1.0.140

type DescribeImageXHitRateRequestDataBody struct{}

type DescribeImageXHitRateRequestDataQuery added in v1.0.140

type DescribeImageXHitRateRequestDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 限制查询的域名,传入多个时用英文逗号分割。缺省情况下表示不限制域名。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 需要分组查询的参数。仅支持取值DomainName。
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度,单位为秒。缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 限制查询的服务 ID,传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXHitRateRequestDataRes added in v1.0.140

type DescribeImageXHitRateRequestDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXHitRateRequestDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXHitRateRequestDataResResult `json:"Result"`
}

type DescribeImageXHitRateRequestDataResResponseMetadata added in v1.0.140

type DescribeImageXHitRateRequestDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXHitRateRequestDataResResult added in v1.0.140

type DescribeImageXHitRateRequestDataResResult struct {

	// REQUIRED; 命中率数据
	HitRateData []*DescribeImageXHitRateRequestDataResResultHitRateDataItem `json:"HitRateData"`
}

type DescribeImageXHitRateRequestDataResResultHitRateDataItem added in v1.0.140

type DescribeImageXHitRateRequestDataResResultHitRateDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXHitRateRequestDataResResultHitRateDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy=DomainName时出现
	DomainName string `json:"DomainName,omitempty"`
}

type DescribeImageXHitRateRequestDataResResultHitRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXHitRateRequestDataResResultHitRateDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 请求命中率
	Value float64 `json:"Value"`
}

type DescribeImageXHitRateTrafficData added in v1.0.140

type DescribeImageXHitRateTrafficData struct{}

type DescribeImageXHitRateTrafficDataBody added in v1.0.140

type DescribeImageXHitRateTrafficDataBody struct{}

type DescribeImageXHitRateTrafficDataQuery added in v1.0.140

type DescribeImageXHitRateTrafficDataQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 限制查询的域名,传入多个时用英文逗号分割。缺省情况下表示不限制域名。 您可以通过调用GetServiceDomains [https://www.volcengine.com/docs/508/9379]获取服务下所有域名信息。
	DomainNames string `json:"DomainNames,omitempty" query:"DomainNames"`

	// 需要分组查询的参数。仅支持取值DomainName。
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度,单位为秒。缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 限制查询的服务 ID,传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXHitRateTrafficDataRes added in v1.0.140

type DescribeImageXHitRateTrafficDataRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXHitRateTrafficDataResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXHitRateTrafficDataResResult `json:"Result"`
}

type DescribeImageXHitRateTrafficDataResResponseMetadata added in v1.0.140

type DescribeImageXHitRateTrafficDataResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXHitRateTrafficDataResResult added in v1.0.140

type DescribeImageXHitRateTrafficDataResResult struct {

	// REQUIRED; 命中率数据
	HitRateData []*DescribeImageXHitRateTrafficDataResResultHitRateDataItem `json:"HitRateData"`
}

type DescribeImageXHitRateTrafficDataResResultHitRateDataItem added in v1.0.140

type DescribeImageXHitRateTrafficDataResResultHitRateDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXHitRateTrafficDataResResultHitRateDataPropertiesItemsItem `json:"Data"`

	// 当GroupBy=DomainName时出现
	DomainName string `json:"DomainName,omitempty"`
}

type DescribeImageXHitRateTrafficDataResResultHitRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXHitRateTrafficDataResResultHitRateDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 流量命中率。
	Value float64 `json:"Value"`
}

type DescribeImageXMirrorRequestBandwidth added in v1.0.140

type DescribeImageXMirrorRequestBandwidth struct{}

type DescribeImageXMirrorRequestBandwidthBody added in v1.0.140

type DescribeImageXMirrorRequestBandwidthBody struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 限制查询的域名,传入多个用英文逗号分割。不传为不限制。
	DomainNames []string `json:"DomainNames,omitempty"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty"`

	// 限制查询的服务id,传入多个用英文逗号分割。不传为不限制。
	ServiceIDs []string `json:"ServiceIds,omitempty"`
}

type DescribeImageXMirrorRequestBandwidthQuery added in v1.0.140

type DescribeImageXMirrorRequestBandwidthQuery struct{}

type DescribeImageXMirrorRequestBandwidthRes added in v1.0.140

type DescribeImageXMirrorRequestBandwidthRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXMirrorRequestBandwidthResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXMirrorRequestBandwidthResResult `json:"Result"`
}

type DescribeImageXMirrorRequestBandwidthResResponseMetadata added in v1.0.140

type DescribeImageXMirrorRequestBandwidthResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXMirrorRequestBandwidthResResult added in v1.0.140

type DescribeImageXMirrorRequestBandwidthResResult struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXMirrorRequestBandwidthResResultDataItem `json:"Data"`
}

type DescribeImageXMirrorRequestBandwidthResResultDataItem added in v1.0.140

type DescribeImageXMirrorRequestBandwidthResResultDataItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 带宽,单位bps
	Value float64 `json:"Value"`
}

type DescribeImageXMirrorRequestHTTPCodeByTime added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTime struct{}

type DescribeImageXMirrorRequestHTTPCodeByTimeBody added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeBody struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	StartTime string `json:"StartTime"`

	// 状态码是否聚合。取值:true/false。默认为false
	AggregateCode string `json:"AggregateCode,omitempty"`

	// 限制查询的域名,传入多个用英文逗号分割。不传为不限制。
	DomainNames []string `json:"DomainNames,omitempty"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty"`

	// 限制查询的服务id,传入多个用英文逗号分割。不传为不限制。
	ServiceIDs []string `json:"ServiceIds,omitempty"`
}

type DescribeImageXMirrorRequestHTTPCodeByTimeQuery added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeQuery struct{}

type DescribeImageXMirrorRequestHTTPCodeByTimeRes added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXMirrorRequestHTTPCodeByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXMirrorRequestHTTPCodeByTimeResResult `json:"Result"`
}

type DescribeImageXMirrorRequestHTTPCodeByTimeResResponseMetadata added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXMirrorRequestHTTPCodeByTimeResResult added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeResResult struct {

	// REQUIRED; 数据列表
	Data []*DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataItem `json:"Data"`
}

type DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataItem added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 状态码
	HTTPCode string `json:"HttpCode"`
}

type DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataPropertiesItemsItem added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeByTimeResResultDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 请求次数
	Value int `json:"Value"`
}

type DescribeImageXMirrorRequestHTTPCodeOverview added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverview struct{}

type DescribeImageXMirrorRequestHTTPCodeOverviewBody added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewBody struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	StartTime string `json:"StartTime"`

	// 状态码是否聚合。取值:true/false。默认为false
	AggregateCode string `json:"AggregateCode,omitempty"`

	// 限制查询的域名,传入多个用英文逗号分割。不传为不限制。
	DomainNames []string `json:"DomainNames,omitempty"`

	// 限制查询的服务id,传入多个用英文逗号分割。不传为不限制。
	ServiceIDs []string `json:"ServiceIds,omitempty"`
}

type DescribeImageXMirrorRequestHTTPCodeOverviewQuery added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewQuery struct{}

type DescribeImageXMirrorRequestHTTPCodeOverviewRes added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXMirrorRequestHTTPCodeOverviewResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXMirrorRequestHTTPCodeOverviewResResult `json:"Result"`
}

type DescribeImageXMirrorRequestHTTPCodeOverviewResResponseMetadata added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXMirrorRequestHTTPCodeOverviewResResult added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewResResult struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataItem `json:"Data"`
}

type DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataItem added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataItem struct {

	// REQUIRED; 总请求次数
	Count int `json:"Count"`

	// REQUIRED; 详细数据
	Details []*DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataPropertiesItemsItem `json:"Details"`

	// REQUIRED; 域名
	Domain string `json:"Domain"`
}

type DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataPropertiesItemsItem added in v1.0.140

type DescribeImageXMirrorRequestHTTPCodeOverviewResResultDataPropertiesItemsItem struct {

	// REQUIRED; Http 状态码
	HTTPCode string `json:"HttpCode"`

	// REQUIRED; http状态码对应的请求次数
	Value int `json:"Value"`
}

type DescribeImageXMirrorRequestTraffic added in v1.0.140

type DescribeImageXMirrorRequestTraffic struct{}

type DescribeImageXMirrorRequestTrafficBody added in v1.0.140

type DescribeImageXMirrorRequestTrafficBody struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	EndTime string `json:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	StartTime string `json:"StartTime"`

	// 限制查询的域名,传入多个用英文逗号分割。不传为不限制。
	DomainNames []string `json:"DomainNames,omitempty"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty"`

	// 限制查询的服务id,传入多个用英文逗号分割。不传为不限制。
	ServiceIDs []string `json:"ServiceIds,omitempty"`
}

type DescribeImageXMirrorRequestTrafficQuery added in v1.0.140

type DescribeImageXMirrorRequestTrafficQuery struct{}

type DescribeImageXMirrorRequestTrafficRes added in v1.0.140

type DescribeImageXMirrorRequestTrafficRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXMirrorRequestTrafficResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXMirrorRequestTrafficResResult `json:"Result"`
}

type DescribeImageXMirrorRequestTrafficResResponseMetadata added in v1.0.140

type DescribeImageXMirrorRequestTrafficResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXMirrorRequestTrafficResResult added in v1.0.140

type DescribeImageXMirrorRequestTrafficResResult struct {

	// REQUIRED; 数据列表
	Data []*DescribeImageXMirrorRequestTrafficResResultDataItem `json:"Data"`
}

type DescribeImageXMirrorRequestTrafficResResultDataItem added in v1.0.140

type DescribeImageXMirrorRequestTrafficResResultDataItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 流量,单位byte
	Value int `json:"Value"`
}

type DescribeImageXMultiCompressUsage added in v1.0.140

type DescribeImageXMultiCompressUsage struct{}

type DescribeImageXMultiCompressUsageBody added in v1.0.140

type DescribeImageXMultiCompressUsageBody struct{}

type DescribeImageXMultiCompressUsageQuery added in v1.0.140

type DescribeImageXMultiCompressUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位为秒,缺省时查询StartTime和EndTime时间段全部数据,此时单次查询最大时间跨度为 93 天。支持以下取值:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,不同的服务使用逗号分隔。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXMultiCompressUsageReq added in v1.0.140

type DescribeImageXMultiCompressUsageReq struct {
	*DescribeImageXMultiCompressUsageQuery
	*DescribeImageXMultiCompressUsageBody
}

type DescribeImageXMultiCompressUsageRes added in v1.0.140

type DescribeImageXMultiCompressUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXMultiCompressUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXMultiCompressUsageResResult `json:"Result"`
}

type DescribeImageXMultiCompressUsageResResponseMetadata added in v1.0.140

type DescribeImageXMultiCompressUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXMultiCompressUsageResResult added in v1.0.140

type DescribeImageXMultiCompressUsageResResult struct {

	// REQUIRED; 多文件压缩用量数据。
	CompressData []*DescribeImageXMultiCompressUsageResResultCompressDataItem `json:"CompressData"`
}

type DescribeImageXMultiCompressUsageResResultCompressDataItem added in v1.0.140

type DescribeImageXMultiCompressUsageResResultCompressDataItem struct {

	// REQUIRED
	Data []*DescribeImageXMultiCompressUsageResResultCompressDataPropertiesItemsItem `json:"Data"`
}

type DescribeImageXMultiCompressUsageResResultCompressDataPropertiesItemsItem added in v1.0.140

type DescribeImageXMultiCompressUsageResResultCompressDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 压缩量,单位Byte。
	Value float64 `json:"Value"`
}

type DescribeImageXRequestCntUsage added in v1.0.140

type DescribeImageXRequestCntUsage struct{}

type DescribeImageXRequestCntUsageBody added in v1.0.140

type DescribeImageXRequestCntUsageBody struct{}

type DescribeImageXRequestCntUsageQuery added in v1.0.140

type DescribeImageXRequestCntUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近一年历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2010-11-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 组件名称。为空时表示不筛选,支持查询多个AdvFeat,不同的AdvFeat使用英文逗号分隔。 您可通过调用 GetImageAddOnConf [https://www.volcengine.com/docs/508/66145] 查看Key返回值。
	AdvFeats string `json:"AdvFeats,omitempty" query:"AdvFeats"`

	// 维度拆分的维度值。不传表示不拆分维度,只能传入单个参数。支持取值如下:
	// * ServiceId
	// * AdvFeat
	GroupBy string `json:"GroupBy,omitempty" query:"GroupBy"`

	// 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用英文逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`

	// 模版。为空时表示不筛选,支持查询多个模板,不同的模板使用英文逗号分隔。 您可通过调用 GetAllImageTemplates [https://www.volcengine.com/docs/508/9386] 获取服务下全部模版信息。
	Templates string `json:"Templates,omitempty" query:"Templates"`
}

type DescribeImageXRequestCntUsageRes added in v1.0.140

type DescribeImageXRequestCntUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXRequestCntUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXRequestCntUsageResResult `json:"Result"`
}

type DescribeImageXRequestCntUsageResResponseMetadata added in v1.0.140

type DescribeImageXRequestCntUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXRequestCntUsageResResult added in v1.0.140

type DescribeImageXRequestCntUsageResResult struct {

	// REQUIRED; 请求次数据。
	RequestCntData []*DescribeImageXRequestCntUsageResResultRequestCntDataItem `json:"RequestCntData"`
}

type DescribeImageXRequestCntUsageResResultRequestCntDataItem added in v1.0.140

type DescribeImageXRequestCntUsageResResultRequestCntDataItem struct {

	// REQUIRED; 具体数据
	Data []*DescribeImageXRequestCntUsageResResultRequestCntDataPropertiesItemsItem `json:"Data"`

	// 附加组件类型,GroupBy包含AdvFeat时有返回值。如:enhance,smartcut。取值为total,表示包含所选AdvFeat实际请求次数。
	AdvFeat string `json:"AdvFeat,omitempty"`

	// 服务 ID,GroupBy包含ServiceId时有返回值。
	ServiceID string `json:"ServiceId,omitempty"`
}

type DescribeImageXRequestCntUsageResResultRequestCntDataPropertiesItemsItem added in v1.0.140

type DescribeImageXRequestCntUsageResResultRequestCntDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片结束时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 请求次
	Value int `json:"Value"`
}

type DescribeImageXScreenshotUsage added in v1.0.140

type DescribeImageXScreenshotUsage struct{}

type DescribeImageXScreenshotUsageBody added in v1.0.140

type DescribeImageXScreenshotUsageBody struct{}

type DescribeImageXScreenshotUsageQuery added in v1.0.140

type DescribeImageXScreenshotUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位:秒。支持300,600,1200,1800,3600,86400,604800。缺省时查询StartTime和EndTime时间段全部数据。
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 为空时表示不筛选,支持查询多个 Service,不同的 Service 使用逗号(,)分隔。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXScreenshotUsageReq added in v1.0.140

type DescribeImageXScreenshotUsageReq struct {
	*DescribeImageXScreenshotUsageQuery
	*DescribeImageXScreenshotUsageBody
}

type DescribeImageXScreenshotUsageRes added in v1.0.140

type DescribeImageXScreenshotUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXScreenshotUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXScreenshotUsageResResult `json:"Result"`
}

type DescribeImageXScreenshotUsageResResponseMetadata added in v1.0.140

type DescribeImageXScreenshotUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXScreenshotUsageResResult added in v1.0.140

type DescribeImageXScreenshotUsageResResult struct {

	// REQUIRED
	ScreenshotData []*DescribeImageXScreenshotUsageResResultScreenshotDataItem `json:"ScreenshotData"`
}

type DescribeImageXScreenshotUsageResResultScreenshotDataItem added in v1.0.140

type DescribeImageXScreenshotUsageResResultScreenshotDataItem struct {

	// REQUIRED
	Data []*DescribeImageXScreenshotUsageResResultScreenshotDataPropertiesItemsItem `json:"Data"`
}

type DescribeImageXScreenshotUsageResResultScreenshotDataPropertiesItemsItem added in v1.0.140

type DescribeImageXScreenshotUsageResResultScreenshotDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 截帧使用次数
	Value int `json:"Value"`
}

type DescribeImageXSensibleCacheHitRateByTime added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTime struct{}

type DescribeImageXSensibleCacheHitRateByTimeBody added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// REQUIRED; 缓存类型。支持以下取值: 1:查询内存命中率数据; 2:查询磁盘命中率数据。
	Type string `json:"Type"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleCacheHitRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXSensibleCacheHitRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleCacheHitRateByTimeQuery added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeQuery struct{}

type DescribeImageXSensibleCacheHitRateByTimeRes added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleCacheHitRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleCacheHitRateByTimeResResult `json:"Result"`
}

type DescribeImageXSensibleCacheHitRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSensibleCacheHitRateByTimeResResult added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeResResult struct {

	// REQUIRED; 命中率数据
	CacheHitData []*DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataItem `json:"CacheHitData"`
}

type DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataItem added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataPropertiesItemsItem added in v1.0.140

type DescribeImageXSensibleCacheHitRateByTimeResResultCacheHitDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应的上报量
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 内存/磁盘命中率
	Value float64 `json:"Value"`
}

type DescribeImageXSensibleCountByTime added in v1.0.140

type DescribeImageXSensibleCountByTime struct{}

type DescribeImageXSensibleCountByTimeBody added in v1.0.140

type DescribeImageXSensibleCountByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleCountByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,ImageType),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXSensibleCountByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleCountByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleCountByTimeQuery added in v1.0.140

type DescribeImageXSensibleCountByTimeQuery struct{}

type DescribeImageXSensibleCountByTimeRes added in v1.0.140

type DescribeImageXSensibleCountByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleCountByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleCountByTimeResResult `json:"Result"`
}

type DescribeImageXSensibleCountByTimeResResponseMetadata added in v1.0.140

type DescribeImageXSensibleCountByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSensibleCountByTimeResResult added in v1.0.140

type DescribeImageXSensibleCountByTimeResResult struct {

	// REQUIRED; 采集样本量数据
	SensibleCountData []*DescribeImageXSensibleCountByTimeResResultSensibleCountDataItem `json:"SensibleCountData"`
}

type DescribeImageXSensibleCountByTimeResResultSensibleCountDataItem added in v1.0.140

type DescribeImageXSensibleCountByTimeResResultSensibleCountDataItem struct {

	// REQUIRED; 该数据类型对应的总上报量
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXSensibleCountByTimeResResultSensibleCountDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXSensibleCountByTimeResResultSensibleCountDataPropertiesItemsItem added in v1.0.140

type DescribeImageXSensibleCountByTimeResResultSensibleCountDataPropertiesItemsItem struct {

	// REQUIRED; 上报量数据
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上报量数据,与Count数值相同。
	Value int `json:"Value"`
}

type DescribeImageXSensibleTopRAMURL added in v1.0.140

type DescribeImageXSensibleTopRAMURL struct{}

type DescribeImageXSensibleTopRAMURLBody added in v1.0.140

type DescribeImageXSensibleTopRAMURLBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 支持以下取值: 1:按上报次数排序; 2:按内存大小排序。
	OrderByIdx int `json:"OrderByIdx"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleTopRAMURLBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXSensibleTopRAMURLBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleTopRAMURLBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleTopRAMURLQuery added in v1.0.140

type DescribeImageXSensibleTopRAMURLQuery struct{}

type DescribeImageXSensibleTopRAMURLReq added in v1.0.140

type DescribeImageXSensibleTopRAMURLReq struct {
	*DescribeImageXSensibleTopRAMURLQuery
	*DescribeImageXSensibleTopRAMURLBody
}

type DescribeImageXSensibleTopRAMURLRes added in v1.0.140

type DescribeImageXSensibleTopRAMURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleTopRAMURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleTopRAMURLResResult `json:"Result"`
}

type DescribeImageXSensibleTopRAMURLResResponseMetadata added in v1.0.140

type DescribeImageXSensibleTopRAMURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSensibleTopRAMURLResResult added in v1.0.140

type DescribeImageXSensibleTopRAMURLResResult struct {

	// REQUIRED; Top URL 数据
	TopURLData []*DescribeImageXSensibleTopRAMURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXSensibleTopRAMURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXSensibleTopRAMURLResResultTopURLDataItem struct {

	// REQUIRED; Activity+View 树,控件信息。
	ActivityViewTree string `json:"ActivityViewTree"`

	// REQUIRED; 业务标识
	BizTag string `json:"BizTag"`

	// REQUIRED; 上报次数
	Count int `json:"Count"`

	// REQUIRED; 图片内存大小
	RAMSize int `json:"RamSize"`

	// REQUIRED; 图片URL
	URL string `json:"URL"`
}

type DescribeImageXSensibleTopResolutionURL added in v1.0.140

type DescribeImageXSensibleTopResolutionURL struct{}

type DescribeImageXSensibleTopResolutionURLBody added in v1.0.140

type DescribeImageXSensibleTopResolutionURLBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 支持以下取值: 1:按上报次数排序; 2:按图片分辨率排序; 3:按 view 分辨率排序。
	OrderByIdx int `json:"OrderByIdx"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleTopResolutionURLBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXSensibleTopResolutionURLBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleTopResolutionURLBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleTopResolutionURLQuery added in v1.0.140

type DescribeImageXSensibleTopResolutionURLQuery struct{}

type DescribeImageXSensibleTopResolutionURLRes added in v1.0.140

type DescribeImageXSensibleTopResolutionURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleTopResolutionURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleTopResolutionURLResResult `json:"Result"`
}

type DescribeImageXSensibleTopResolutionURLResResponseMetadata added in v1.0.140

type DescribeImageXSensibleTopResolutionURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSensibleTopResolutionURLResResult added in v1.0.140

type DescribeImageXSensibleTopResolutionURLResResult struct {

	// REQUIRED; 具体数据
	TopURLData []*DescribeImageXSensibleTopResolutionURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXSensibleTopResolutionURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXSensibleTopResolutionURLResResultTopURLDataItem struct {

	// REQUIRED; Activity+View 树,控件信息。
	ActivityViewTree string `json:"ActivityViewTree"`

	// REQUIRED; 业务标识
	BizTag string `json:"BizTag"`

	// REQUIRED; 上报次数
	Count int `json:"Count"`

	// REQUIRED; 图片高
	ImageHeight int `json:"ImageHeight"`

	// REQUIRED; 图片宽
	ImageWidth int `json:"ImageWidth"`

	// REQUIRED; 图片URL
	URL string `json:"URL"`

	// REQUIRED; 图片展示背景 view 高。
	ViewHeight int `json:"ViewHeight"`

	// REQUIRED; 图片展示背景 view 宽。
	ViewWidth int `json:"ViewWidth"`
}

type DescribeImageXSensibleTopSizeURL added in v1.0.140

type DescribeImageXSensibleTopSizeURL struct{}

type DescribeImageXSensibleTopSizeURLBody added in v1.0.140

type DescribeImageXSensibleTopSizeURLBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 支持以下取值: 1:按上报次数排序; 2:按文件体积排序。
	OrderByIdx int `json:"OrderByIdx"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleTopSizeURLBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXSensibleTopSizeURLBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleTopSizeURLBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleTopSizeURLQuery added in v1.0.140

type DescribeImageXSensibleTopSizeURLQuery struct{}

type DescribeImageXSensibleTopSizeURLRes added in v1.0.140

type DescribeImageXSensibleTopSizeURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleTopSizeURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleTopSizeURLResResult `json:"Result"`
}

type DescribeImageXSensibleTopSizeURLResResponseMetadata added in v1.0.140

type DescribeImageXSensibleTopSizeURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSensibleTopSizeURLResResult added in v1.0.140

type DescribeImageXSensibleTopSizeURLResResult struct {

	// REQUIRED; Top URL数据
	TopURLData []*DescribeImageXSensibleTopSizeURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXSensibleTopSizeURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXSensibleTopSizeURLResResultTopURLDataItem struct {

	// REQUIRED; Activity+View 树,控件信息。
	ActivityViewTree string `json:"ActivityViewTree"`

	// REQUIRED; 业务标识
	BizTag string `json:"BizTag"`

	// REQUIRED; 上报次数
	Count int `json:"Count"`

	// REQUIRED; 文件URL
	URL string `json:"URL"`

	// REQUIRED; 文件体积
	Value int `json:"Value"`
}

type DescribeImageXSensibleTopUnknownURL added in v1.0.140

type DescribeImageXSensibleTopUnknownURL struct{}

type DescribeImageXSensibleTopUnknownURLBody added in v1.0.140

type DescribeImageXSensibleTopUnknownURLBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 支持以下取值: 1:按上报量排序 2:按内存大小排序 3:按文件大小排序 4:按图片分辨率排序 5:按 view 分辨率排序
	OrderByIdx int `json:"OrderByIdx"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXSensibleTopUnknownURLBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的图片类型,不传则匹配所有图片类型。 GIF PNG JPEG HEIF HEIC WEBP AWEBP VVIC 其他
	ImageType []string `json:"ImageType,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。
	Top int `json:"Top,omitempty"`
}

type DescribeImageXSensibleTopUnknownURLBodyExtraDimsItem added in v1.0.140

type DescribeImageXSensibleTopUnknownURLBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXSensibleTopUnknownURLQuery added in v1.0.140

type DescribeImageXSensibleTopUnknownURLQuery struct{}

type DescribeImageXSensibleTopUnknownURLRes added in v1.0.140

type DescribeImageXSensibleTopUnknownURLRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSensibleTopUnknownURLResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSensibleTopUnknownURLResResult `json:"Result"`
}

type DescribeImageXSensibleTopUnknownURLResResponseMetadata added in v1.0.140

type DescribeImageXSensibleTopUnknownURLResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type DescribeImageXSensibleTopUnknownURLResResult added in v1.0.140

type DescribeImageXSensibleTopUnknownURLResResult struct {

	// REQUIRED
	TopURLData []*DescribeImageXSensibleTopUnknownURLResResultTopURLDataItem `json:"TopUrlData"`
}

type DescribeImageXSensibleTopUnknownURLResResultTopURLDataItem added in v1.0.140

type DescribeImageXSensibleTopUnknownURLResResultTopURLDataItem struct {
	ActivityViewTree string `json:"ActivityViewTree,omitempty"`
	BizTag           string `json:"BizTag,omitempty"`
	Count            int    `json:"Count,omitempty"`
	FileSize         int    `json:"FileSize,omitempty"`
	ImageHeight      int    `json:"ImageHeight,omitempty"`
	ImageWidth       int    `json:"ImageWidth,omitempty"`
	RAMSize          int    `json:"RamSize,omitempty"`
	URL              string `json:"URL,omitempty"`
	ViewHeight       int    `json:"ViewHeight,omitempty"`
	ViewWidth        int    `json:"ViewWidth,omitempty"`
}

type DescribeImageXServerQPSUsage added in v1.0.140

type DescribeImageXServerQPSUsage struct{}

type DescribeImageXServerQPSUsageBody added in v1.0.140

type DescribeImageXServerQPSUsageBody struct{}

type DescribeImageXServerQPSUsageQuery added in v1.0.140

type DescribeImageXServerQPSUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。 :::tip 由于仅支持查询近 93 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-21T00:00:00+08:00。
	// :::
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位为秒。支持以下取值:
	// * 1: 单次查询最大时间跨度为 6 小时
	// * 60:单次查询最大时间跨度为 6 小时
	// * 120:单次查询最大时间跨度为 6 小时
	// * 300:单次查询最大时间跨度为 31 天
	// * 600:单次查询最大时间跨度为 31 天
	// * 1200:单次查询最大时间跨度为 31 天
	// * 1800:单次查询最大时间跨度为 31 天
	// * 3600:单次查询最大时间跨度为 93 天
	// * 86400:单次查询最大时间跨度为 93 天
	// * 604800:单次查询最大时间跨度为 93 天
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXServerQPSUsageReq added in v1.0.140

type DescribeImageXServerQPSUsageReq struct {
	*DescribeImageXServerQPSUsageQuery
	*DescribeImageXServerQPSUsageBody
}

type DescribeImageXServerQPSUsageRes added in v1.0.140

type DescribeImageXServerQPSUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXServerQPSUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; 视请求的接口而定
	Result *DescribeImageXServerQPSUsageResResult `json:"Result"`
}

type DescribeImageXServerQPSUsageResResponseMetadata added in v1.0.140

type DescribeImageXServerQPSUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXServerQPSUsageResResult added in v1.0.140

type DescribeImageXServerQPSUsageResResult struct {

	// REQUIRED; 数据列表。
	QPSData []*DescribeImageXServerQPSUsageResResultQPSDataItem `json:"QPSData"`
}

DescribeImageXServerQPSUsageResResult - 视请求的接口而定

type DescribeImageXServerQPSUsageResResultQPSDataItem added in v1.0.140

type DescribeImageXServerQPSUsageResResultQPSDataItem struct {

	// REQUIRED; 时序数据。
	Data []*DescribeImageXServerQPSUsageResResultQPSDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; QPS 类型,取值:
	// * Request:专有图像处理和高效压缩
	// * Mirror:资源下载与镜像代理
	QPSType string `json:"QPSType"`
}

type DescribeImageXServerQPSUsageResResultQPSDataPropertiesItemsItem added in v1.0.140

type DescribeImageXServerQPSUsageResResultQPSDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; QPS 用量的值。单位为 "次/秒",表示每秒处理的请求数量。
	Value int `json:"Value"`
}

type DescribeImageXServiceQuality added in v1.0.140

type DescribeImageXServiceQuality struct{}

type DescribeImageXServiceQualityBody added in v1.0.140

type DescribeImageXServiceQualityBody struct{}

type DescribeImageXServiceQualityQuery added in v1.0.140

type DescribeImageXServiceQualityQuery struct {

	// 获取指定地区的数据。默认为空,表示获取国内数据。
	// * cn:国内。
	// * va:美东。
	// * sg:新加坡。
	Region string `json:"Region,omitempty" query:"Region"`
}

type DescribeImageXServiceQualityRes added in v1.0.140

type DescribeImageXServiceQualityRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXServiceQualityResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; 视请求的接口而定
	Result *DescribeImageXServiceQualityResResult `json:"Result"`
}

type DescribeImageXServiceQualityResResponseMetadata added in v1.0.140

type DescribeImageXServiceQualityResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXServiceQualityResResult added in v1.0.140

type DescribeImageXServiceQualityResResult struct {

	// REQUIRED; 下行概览数据,为当日 0 点至今整体数据。
	CdnData *DescribeImageXServiceQualityResResultCdnData `json:"CdnData"`

	// REQUIRED; 客户端概览数据,为当日 0 点查询时间的整体数据。
	ClientData *DescribeImageXServiceQualityResResultClientData `json:"ClientData"`

	// REQUIRED; 用户感知失败率,为当日 0 点至查询时间的整体数据。
	FailureRate float64 `json:"FailureRate"`

	// REQUIRED; 上传概览数据,为当日 0 点查询时间的整体数据。
	UploadData *DescribeImageXServiceQualityResResultUploadData `json:"UploadData"`
}

DescribeImageXServiceQualityResResult - 视请求的接口而定

type DescribeImageXServiceQualityResResultCdnData added in v1.0.140

type DescribeImageXServiceQualityResResultCdnData struct {

	// REQUIRED; 网络平均耗时,单位为 ms。
	AvgDuration float64 `json:"AvgDuration"`

	// REQUIRED; 网络成功率
	SuccessRate float64 `json:"SuccessRate"`

	// REQUIRED; 下行总上报数据量。
	TotalCount int `json:"TotalCount"`
}

DescribeImageXServiceQualityResResultCdnData - 下行概览数据,为当日 0 点至今整体数据。

type DescribeImageXServiceQualityResResultClientData added in v1.0.140

type DescribeImageXServiceQualityResResultClientData struct {

	// REQUIRED; 平均解码耗时,单位为 ms。
	AvgDecodeDuration float64 `json:"AvgDecodeDuration"`

	// REQUIRED; 平均加载耗时,单位为 ms。
	AvgLoadDuration float64 `json:"AvgLoadDuration"`

	// REQUIRED; 平均排队耗时,单位为 ms。
	AvgQueueDuration float64 `json:"AvgQueueDuration"`

	// REQUIRED; 解码成功率
	SuccessRate float64 `json:"SuccessRate"`

	// REQUIRED; 客户端总上报数据量。
	TotalCount int `json:"TotalCount"`
}

DescribeImageXServiceQualityResResultClientData - 客户端概览数据,为当日 0 点查询时间的整体数据。

type DescribeImageXServiceQualityResResultUploadData added in v1.0.140

type DescribeImageXServiceQualityResResultUploadData struct {

	// REQUIRED; 上传平均耗时,单位为 ms。
	AvgDuration float64 `json:"AvgDuration"`

	// REQUIRED; 上传文件平均大小,单位字节。
	AvgSize float64 `json:"AvgSize"`

	// REQUIRED; 上传成功率
	SuccessRate float64 `json:"SuccessRate"`

	// REQUIRED; 上传总上报数据量。
	TotalCount int `json:"TotalCount"`

	// REQUIRED; 上传有效次数
	UploadCount int `json:"UploadCount"`
}

DescribeImageXServiceQualityResResultUploadData - 上传概览数据,为当日 0 点查询时间的整体数据。

type DescribeImageXSummary added in v1.0.140

type DescribeImageXSummary struct{}

type DescribeImageXSummaryBody added in v1.0.140

type DescribeImageXSummaryBody struct{}

type DescribeImageXSummaryQuery added in v1.0.140

type DescribeImageXSummaryQuery struct {

	// REQUIRED; 数据查询时间段,即Timestamp所在月份的 1 日 0 时起至传入时间Timestamp的时间范围。 格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	Timestamp string `json:"Timestamp" query:"Timestamp"`

	// 限制查询的服务 ID,传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考GetAllImageServices [https://www.volcengine.com/docs/508/9360]。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXSummaryReq

type DescribeImageXSummaryReq struct {
	*DescribeImageXSummaryQuery
	*DescribeImageXSummaryBody
}

type DescribeImageXSummaryRes added in v1.0.140

type DescribeImageXSummaryRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXSummaryResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXSummaryResResult `json:"Result"`
}

type DescribeImageXSummaryResResponseMetadata added in v1.0.140

type DescribeImageXSummaryResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXSummaryResResult added in v1.0.140

type DescribeImageXSummaryResResult struct {

	// REQUIRED; 当月图像处理量
	BaseOpData *DescribeImageXSummaryResResultBaseOpData `json:"BaseOpData"`

	// REQUIRED; 当月带宽用量
	CdnBandwidthData *DescribeImageXSummaryResResultCdnBandwidthData `json:"CdnBandwidthData"`

	// REQUIRED; 当月流量用量
	CdnTrafficData *DescribeImageXSummaryResResultCdnTrafficData `json:"CdnTrafficData"`

	// REQUIRED; 当月源站请求次数
	RequestCntData *DescribeImageXSummaryResResultRequestCntData `json:"RequestCntData"`

	// REQUIRED; 当月资源占用量
	StorageData *DescribeImageXSummaryResResultStorageData `json:"StorageData"`
}

type DescribeImageXSummaryResResultBaseOpData added in v1.0.140

type DescribeImageXSummaryResResultBaseOpData struct {

	// REQUIRED; 当月图像处理量,单位为:Byte
	Value int `json:"Value"`
}

DescribeImageXSummaryResResultBaseOpData - 当月图像处理量

type DescribeImageXSummaryResResultCdnBandwidthData added in v1.0.140

type DescribeImageXSummaryResResultCdnBandwidthData struct {

	// REQUIRED; 当月带宽用量,单位为:bps
	Value float64 `json:"Value"`
}

DescribeImageXSummaryResResultCdnBandwidthData - 当月带宽用量

type DescribeImageXSummaryResResultCdnTrafficData added in v1.0.140

type DescribeImageXSummaryResResultCdnTrafficData struct {

	// REQUIRED; 当月流量用量,单位为:Byte
	Value int `json:"Value"`
}

DescribeImageXSummaryResResultCdnTrafficData - 当月流量用量

type DescribeImageXSummaryResResultRequestCntData added in v1.0.140

type DescribeImageXSummaryResResultRequestCntData struct {

	// REQUIRED; 当月源站请求次数,单位为:次
	Value int `json:"Value"`
}

DescribeImageXSummaryResResultRequestCntData - 当月源站请求次数

type DescribeImageXSummaryResResultStorageData added in v1.0.140

type DescribeImageXSummaryResResultStorageData struct {

	// REQUIRED; 当月最新一日资源占用量,单位为:Byte
	Value float64 `json:"Value"`
}

DescribeImageXSummaryResResultStorageData - 当月资源占用量

type DescribeImageXUploadCountByTime added in v1.0.140

type DescribeImageXUploadCountByTime struct{}

type DescribeImageXUploadCountByTimeBody added in v1.0.140

type DescribeImageXUploadCountByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadCountByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadCountByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadCountByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadCountByTimeQuery added in v1.0.140

type DescribeImageXUploadCountByTimeQuery struct{}

type DescribeImageXUploadCountByTimeRes added in v1.0.140

type DescribeImageXUploadCountByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadCountByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadCountByTimeResResult `json:"Result"`
}

type DescribeImageXUploadCountByTimeResResponseMetadata added in v1.0.140

type DescribeImageXUploadCountByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadCountByTimeResResult added in v1.0.140

type DescribeImageXUploadCountByTimeResResult struct {

	// REQUIRED; 上传有效次数数据。
	UploadCountData []*DescribeImageXUploadCountByTimeResResultUploadCountDataItem `json:"UploadCountData"`
}

type DescribeImageXUploadCountByTimeResResultUploadCountDataItem added in v1.0.140

type DescribeImageXUploadCountByTimeResResultUploadCountDataItem struct {

	// REQUIRED; 对应的总上传有效次数。
	Count int `json:"Count"`

	// REQUIRED; 对应的上传有效次数数据列表。
	Data []*DescribeImageXUploadCountByTimeResResultUploadCountDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXUploadCountByTimeResResultUploadCountDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadCountByTimeResResultUploadCountDataPropertiesItemsItem struct {

	// REQUIRED; 上传有效次数
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上传有效次数
	Value int `json:"Value"`
}

type DescribeImageXUploadDuration added in v1.0.140

type DescribeImageXUploadDuration struct{}

type DescribeImageXUploadDurationBody added in v1.0.140

type DescribeImageXUploadDurationBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadDurationBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(分位数据)、Phase(分阶段数据,只有当UploadType=2时才能取该值)、公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadDurationBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadDurationBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadDurationQuery added in v1.0.140

type DescribeImageXUploadDurationQuery struct{}

type DescribeImageXUploadDurationRes added in v1.0.140

type DescribeImageXUploadDurationRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadDurationResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadDurationResResult `json:"Result"`
}

type DescribeImageXUploadDurationResResponseMetadata added in v1.0.140

type DescribeImageXUploadDurationResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadDurationResResult added in v1.0.140

type DescribeImageXUploadDurationResResult struct {

	// REQUIRED; 上传耗时数据
	DurationData []*DescribeImageXUploadDurationResResultDurationDataItem `json:"DurationData"`
}

type DescribeImageXUploadDurationResResultDurationDataItem added in v1.0.140

type DescribeImageXUploadDurationResResultDurationDataItem struct {

	// REQUIRED; 对应的总次数。
	Count int `json:"Count"`

	// REQUIRED; 上传耗时数据列表。
	Data []*DescribeImageXUploadDurationResResultDurationDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 当GroupBy为空或Duration时,取值为:pct25、pct50、pct90、pct99、avg。 当GroupBy取值为Phase时,取值为:1001、1002、1003、1004、1005。 除上述外取值为指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXUploadDurationResResultDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadDurationResResultDurationDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应上传次数。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上传耗时,单位为 ms。
	Value float64 `json:"Value"`
}

type DescribeImageXUploadErrorCodeAll added in v1.0.140

type DescribeImageXUploadErrorCodeAll struct{}

type DescribeImageXUploadErrorCodeAllBody added in v1.0.140

type DescribeImageXUploadErrorCodeAllBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 聚合维度。 ErrorCode:错误码 Region:地区 Isp:运营商
	GroupBy string `json:"GroupBy"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadErrorCodeAllBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 是否升序排序。不传则默认降序排序。
	OrderAsc bool `json:"OrderAsc,omitempty"`

	// 目前仅支持传入Count按错误码数量排序。不传或者传空默认按错误码数量排序。
	OrderBy string `json:"OrderBy,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadErrorCodeAllBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadErrorCodeAllBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadErrorCodeAllQuery added in v1.0.140

type DescribeImageXUploadErrorCodeAllQuery struct{}

type DescribeImageXUploadErrorCodeAllRes added in v1.0.140

type DescribeImageXUploadErrorCodeAllRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadErrorCodeAllResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadErrorCodeAllResResult `json:"Result"`
}

type DescribeImageXUploadErrorCodeAllResResponseMetadata added in v1.0.140

type DescribeImageXUploadErrorCodeAllResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadErrorCodeAllResResult added in v1.0.140

type DescribeImageXUploadErrorCodeAllResResult struct {

	// REQUIRED; 错误码数据。
	ErrorCodeData []*DescribeImageXUploadErrorCodeAllResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXUploadErrorCodeAllResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXUploadErrorCodeAllResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量。
	Value int `json:"Value"`

	// 当GroupBy取值非ErrorCode时出现,表示错误码详细信息。
	Details []*DescribeImageXUploadErrorCodeAllResResultErrorCodeDataPropertiesItemsItem `json:"Details,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码内容。
	ErrorCode string `json:"ErrorCode,omitempty"`

	// 当GroupBy取值ErrorCode时出现,表示错误码的描述信息。
	ErrorCodeDesc string `json:"ErrorCodeDesc,omitempty"`

	// 当GroupBy取值Isp时出现,则表示运营商信息。
	Isp string `json:"Isp,omitempty"`

	// 当GroupBy取值Region时出现,表示地区信息。
	Region string `json:"Region,omitempty"`

	// 当GroupBy取值Region时出现,表示地区类型。 Country:国家; Province:省份。
	RegionType string `json:"RegionType,omitempty"`
}

type DescribeImageXUploadErrorCodeAllResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadErrorCodeAllResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码内容
	ErrorCode string `json:"ErrorCode"`

	// REQUIRED; 错误码的描述信息
	ErrorCodeDesc string `json:"ErrorCodeDesc"`

	// REQUIRED; 错误码数量
	Value int `json:"Value"`
}

type DescribeImageXUploadErrorCodeByTime added in v1.0.140

type DescribeImageXUploadErrorCodeByTime struct{}

type DescribeImageXUploadErrorCodeByTimeBody added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadErrorCodeByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadErrorCodeByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadErrorCodeByTimeQuery added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeQuery struct{}

type DescribeImageXUploadErrorCodeByTimeRes added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadErrorCodeByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadErrorCodeByTimeResResult `json:"Result"`
}

type DescribeImageXUploadErrorCodeByTimeResResponseMetadata added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadErrorCodeByTimeResResult added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeResResult struct {

	// REQUIRED; 所有错误码数据。
	ErrorCodeData []*DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataItem `json:"ErrorCodeData"`
}

type DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataItem added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataItem struct {

	// REQUIRED; 错误码数量。
	Count int `json:"Count"`

	// REQUIRED; 错误码对应的时序数据。
	Data []*DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 错误码。
	ErrorCode string `json:"ErrorCode"`
}

type DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadErrorCodeByTimeResResultErrorCodeDataPropertiesItemsItem struct {

	// REQUIRED; 错误码数量。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 错误码数量。
	Value int `json:"Value"`
}

type DescribeImageXUploadFileSize added in v1.0.140

type DescribeImageXUploadFileSize struct{}

type DescribeImageXUploadFileSizeBody added in v1.0.140

type DescribeImageXUploadFileSizeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadFileSizeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(分位数据)、公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadFileSizeBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadFileSizeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadFileSizeQuery added in v1.0.140

type DescribeImageXUploadFileSizeQuery struct{}

type DescribeImageXUploadFileSizeRes added in v1.0.140

type DescribeImageXUploadFileSizeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadFileSizeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadFileSizeResResult `json:"Result"`
}

type DescribeImageXUploadFileSizeResResponseMetadata added in v1.0.140

type DescribeImageXUploadFileSizeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadFileSizeResResult added in v1.0.140

type DescribeImageXUploadFileSizeResResult struct {

	// REQUIRED; 上传文件大小分布数据。
	FSizeData []*DescribeImageXUploadFileSizeResResultFSizeDataItem `json:"FSizeData"`
}

type DescribeImageXUploadFileSizeResResultFSizeDataItem added in v1.0.140

type DescribeImageXUploadFileSizeResResultFSizeDataItem struct {

	// REQUIRED; 对应的总次数。
	Count int `json:"Count"`

	// REQUIRED; 对应的文件大小数据列表。
	Data []*DescribeImageXUploadFileSizeResResultFSizeDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 GroupBy为空或Duration时,取值为:pct25、pct50、pct90、pct99、avg。 GroupBy取值为其他时,则指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXUploadFileSizeResResultFSizeDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadFileSizeResResultFSizeDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应次数。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 对应文件大小。
	Value float64 `json:"Value"`
}

type DescribeImageXUploadSegmentSpeedByTime added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTime struct{}

type DescribeImageXUploadSegmentSpeedByTimeBody added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// REQUIRED; 上传类型,固定值传入2,表示上传 2.0 数据。
	UploadType int `json:"UploadType"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadSegmentSpeedByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(分位数据)、公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`
}

type DescribeImageXUploadSegmentSpeedByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadSegmentSpeedByTimeQuery added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeQuery struct{}

type DescribeImageXUploadSegmentSpeedByTimeRes added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadSegmentSpeedByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadSegmentSpeedByTimeResResult `json:"Result"`
}

type DescribeImageXUploadSegmentSpeedByTimeResResponseMetadata added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadSegmentSpeedByTimeResResult added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeResResult struct {

	// REQUIRED; 上传速度数据
	SpeedData []*DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataItem `json:"SpeedData"`
}

type DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataItem added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataItem struct {

	// REQUIRED; 总上传次数
	Count int `json:"Count"`

	// REQUIRED; 具体数据
	Data []*DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 GroupBy为空或Duration时,取值为:pct25、pct50、pct90、pct99、avg。 GroupBy取值为其他时,则指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadSegmentSpeedByTimeResResultSpeedDataPropertiesItemsItem struct {

	// REQUIRED; 上传次数
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上传分片速度,单位KB/s
	Value float64 `json:"Value"`
}

type DescribeImageXUploadSpeed added in v1.0.140

type DescribeImageXUploadSpeed struct{}

type DescribeImageXUploadSpeedBody added in v1.0.140

type DescribeImageXUploadSpeedBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadSpeedBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,表示拆分分位数据。支持取值:Duration(分位数据)、公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadSpeedBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadSpeedBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadSpeedQuery added in v1.0.140

type DescribeImageXUploadSpeedQuery struct{}

type DescribeImageXUploadSpeedRes added in v1.0.140

type DescribeImageXUploadSpeedRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadSpeedResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadSpeedResResult `json:"Result"`
}

type DescribeImageXUploadSpeedResResponseMetadata added in v1.0.140

type DescribeImageXUploadSpeedResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadSpeedResResult added in v1.0.140

type DescribeImageXUploadSpeedResResult struct {

	// REQUIRED; 上传速度数据
	SpeedData []*DescribeImageXUploadSpeedResResultSpeedDataItem `json:"SpeedData"`
}

type DescribeImageXUploadSpeedResResultSpeedDataItem added in v1.0.140

type DescribeImageXUploadSpeedResResultSpeedDataItem struct {

	// REQUIRED; 对应的总次数。
	Count int `json:"Count"`

	// REQUIRED; 对应的上传速度数据列表。
	Data []*DescribeImageXUploadSpeedResResultSpeedDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型。 GroupBy为空或Duration时,取值为:pct25、pct50、pct90、pct99、avg。 GroupBy取值为其他时,则指定拆分维度的各个值。
	Type string `json:"Type"`
}

type DescribeImageXUploadSpeedResResultSpeedDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadSpeedResResultSpeedDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应上传次数。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 平均速度,单位为 KB/s。
	Value float64 `json:"Value"`
}

type DescribeImageXUploadSuccessRateByTime added in v1.0.140

type DescribeImageXUploadSuccessRateByTime struct{}

type DescribeImageXUploadSuccessRateByTimeBody added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeBody struct {

	// REQUIRED; 获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	EndTime string `json:"EndTime"`

	// REQUIRED; 返回数据的时间粒度。 5m:为 5 分钟; 1h:为 1 小时; 1d:为 1 天。
	Granularity string `json:"Granularity"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
	StartTime string `json:"StartTime"`

	// 需要匹配的 App 版本,不传则匹配 App 的所有版本。
	AppVer []string `json:"AppVer,omitempty"`

	// 应用 ID。默认为空,匹配账号下的所有的App ID。
	Appid string `json:"Appid,omitempty"`

	// 需要匹配的国家名称。 不传则匹配所有国家。 取值为海外时,匹配海外所有国家。
	Country string `json:"Country,omitempty"`

	// 需要匹配的自定义维度项
	ExtraDims []*DescribeImageXUploadSuccessRateByTimeBodyExtraDimsItem `json:"ExtraDims,omitempty"`

	// 拆分维度。默认为空,不拆分。支持取值:公共维度(Appid,OS,AppVer,SdkVer,Country,Province,Isp),自定义维度(通过"获取自定义维度列表"接口获取)
	GroupBy string `json:"GroupBy,omitempty"`

	// 需要匹配的运营商名称,不传则匹配所有运营商。支持取值如下: 电信 联通 移动 铁通 鹏博士 教育网 其他
	Isp []string `json:"Isp,omitempty"`

	// 需要匹配的系统类型,不传则匹配非WEB端所有系统。取值如下所示: iOS Android WEB
	OS string `json:"OS,omitempty"`

	// 需要匹配的省份名称,不传则匹配所有省份
	Province string `json:"Province,omitempty"`

	// 需要匹配的SDK版本,不传则匹配所有版本
	SdkVer []string `json:"SdkVer,omitempty"`

	// 上传类型,默认为空,返回上传 1.0 数据。 1:上传 1.0。 2:上传 2.0。
	UploadType int `json:"UploadType,omitempty"`
}

type DescribeImageXUploadSuccessRateByTimeBodyExtraDimsItem added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeBodyExtraDimsItem struct {

	// REQUIRED; 自定义维度名称。
	Dim string `json:"Dim"`

	// REQUIRED; 需要匹配的对应维度值
	Vals []string `json:"Vals"`
}

type DescribeImageXUploadSuccessRateByTimeQuery added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeQuery struct{}

type DescribeImageXUploadSuccessRateByTimeRes added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXUploadSuccessRateByTimeResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXUploadSuccessRateByTimeResResult `json:"Result"`
}

type DescribeImageXUploadSuccessRateByTimeResResponseMetadata added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXUploadSuccessRateByTimeResResult added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeResResult struct {

	// REQUIRED; 上传成功率数据。
	SuccessRateData []*DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataItem `json:"SuccessRateData"`
}

type DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataItem added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataItem struct {

	// REQUIRED; 对应的总上传有效次数。
	Count int `json:"Count"`

	// REQUIRED; 对应的上传成功率数据列表。
	Data []*DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem `json:"Data"`

	// REQUIRED; 数据类型,不拆分时值为Total,拆分时为具体的维度值
	Type string `json:"Type"`
}

type DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem added in v1.0.140

type DescribeImageXUploadSuccessRateByTimeResResultSuccessRateDataPropertiesItemsItem struct {

	// REQUIRED; 数据对应上传有效次数。
	Count int `json:"Count"`

	// REQUIRED; 数据对应时间点,按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。
	Timestamp string `json:"Timestamp"`

	// REQUIRED; 上传成功率
	Value float64 `json:"Value"`
}

type DescribeImageXVideoClipDurationUsage added in v1.0.140

type DescribeImageXVideoClipDurationUsage struct{}

type DescribeImageXVideoClipDurationUsageBody added in v1.0.140

type DescribeImageXVideoClipDurationUsageBody struct{}

type DescribeImageXVideoClipDurationUsageQuery added in v1.0.140

type DescribeImageXVideoClipDurationUsageQuery struct {

	// REQUIRED; 获取数据结束时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	EndTime string `json:"EndTime" query:"EndTime"`

	// REQUIRED; 获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	StartTime string `json:"StartTime" query:"StartTime"`

	// 查询数据的时间粒度。单位:秒。支持300,600,1200,1800,3600,86400,604800。缺省时查询StartTime和EndTime时间段全部数据。
	Interval string `json:"Interval,omitempty" query:"Interval"`

	// 为空时表示不筛选,支持查询多个 Service,不同的 Service 使用逗号(,)分隔。
	ServiceIDs string `json:"ServiceIds,omitempty" query:"ServiceIds"`
}

type DescribeImageXVideoClipDurationUsageReq added in v1.0.140

type DescribeImageXVideoClipDurationUsageReq struct {
	*DescribeImageXVideoClipDurationUsageQuery
	*DescribeImageXVideoClipDurationUsageBody
}

type DescribeImageXVideoClipDurationUsageRes added in v1.0.140

type DescribeImageXVideoClipDurationUsageRes struct {

	// REQUIRED
	ResponseMetadata *DescribeImageXVideoClipDurationUsageResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *DescribeImageXVideoClipDurationUsageResResult `json:"Result"`
}

type DescribeImageXVideoClipDurationUsageResResponseMetadata added in v1.0.140

type DescribeImageXVideoClipDurationUsageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type DescribeImageXVideoClipDurationUsageResResult added in v1.0.140

type DescribeImageXVideoClipDurationUsageResResult struct {

	// REQUIRED
	VideoClipDurationData []*DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataItem `json:"VideoClipDurationData"`
}

type DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataItem added in v1.0.140

type DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataItem struct {

	// REQUIRED
	Data []*DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataPropertiesItemsItem `json:"Data"`
}

type DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataPropertiesItemsItem added in v1.0.140

type DescribeImageXVideoClipDurationUsageResResultVideoClipDurationDataPropertiesItemsItem struct {

	// REQUIRED; 统计时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00。
	TimeStamp string `json:"TimeStamp"`

	// REQUIRED; 转换时长,单位ms
	Value float64 `json:"Value"`
}

type Encryption

type Encryption struct {
	Uri       string            `json:"Uri"`
	SecretKey string            `json:"SecretKey"`
	Algorithm string            `json:"Algorithm"`
	Version   string            `json:"Version"`
	SourceMd5 string            `json:"SourceMd5"`
	Extra     map[string]string `json:"Extra"`
}

type EncryptionInput

type EncryptionInput struct {
	Config       map[string]string `json:"Config"`
	PolicyParams map[string]string `json:"PolicyParams"`
}

type ExportFailedMigrateTask added in v1.0.140

type ExportFailedMigrateTask struct{}

type ExportFailedMigrateTaskBody added in v1.0.140

type ExportFailedMigrateTaskBody struct{}

type ExportFailedMigrateTaskQuery added in v1.0.140

type ExportFailedMigrateTaskQuery struct {

	// REQUIRED; 任务地区(即任务目标服务的地区),默认空,返回国内任务。
	// * cn:国内
	// * va:美东
	// * sg:新加坡
	Region string `json:"Region" query:"Region"`

	// REQUIRED; 任务 ID,请参考CreateImageMigrateTask [https://www.volcengine.com/docs/508/1009929]获取返回的任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`
}

type ExportFailedMigrateTaskReq added in v1.0.140

type ExportFailedMigrateTaskReq struct {
	*ExportFailedMigrateTaskQuery
	*ExportFailedMigrateTaskBody
}

type ExportFailedMigrateTaskRes added in v1.0.140

type ExportFailedMigrateTaskRes struct {

	// REQUIRED
	ResponseMetadata *ExportFailedMigrateTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *ExportFailedMigrateTaskResResult `json:"Result,omitempty"`
}

type ExportFailedMigrateTaskResResponseMetadata added in v1.0.140

type ExportFailedMigrateTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type ExportFailedMigrateTaskResResult added in v1.0.140

type ExportFailedMigrateTaskResResult struct {

	// REQUIRED; 迁移失败文件列表。仅当任务状态为Partial时有值。
	Entries []*ExportFailedMigrateTaskResResultEntriesItem `json:"Entries"`
}

ExportFailedMigrateTaskResResult - 视请求的接口而定

type ExportFailedMigrateTaskResResultEntriesItem added in v1.0.140

type ExportFailedMigrateTaskResResultEntriesItem struct {

	// REQUIRED; 失败错误码
	ErrCode int `json:"ErrCode"`

	// REQUIRED; 失败原因
	ErrMsg string `json:"ErrMsg"`

	// REQUIRED; 文件地址
	Key string `json:"Key"`
}

type FetchImageURL added in v1.0.140

type FetchImageURL struct{}

type FetchImageURLBody added in v1.0.140

type FetchImageURLBody struct {

	// REQUIRED; 目标服务 ID,迁移后的文件将上传至该服务绑定的存储。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待抓取上传的文件 URL。
	URL string `json:"Url"`

	// 是否采用异步,取值如下所示:
	// * true:采用异步
	// * false:(默认)不采用异步
	// :::tip 若您的资源大小小于 5 G,但预估资源迁移超时时间超过 20 s,建议您选择异步处理。 :::
	Async bool `json:"Async,omitempty"`

	// 回调 URL,veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。当Async取值为true,即采用异步处理时,为必填。
	Callback string `json:"Callback,omitempty"`

	// 透传给业务的回调内容格式。当CallbackBody不为空时为必填。取值如下所示:
	// * application/json
	// * application/x-www-form-urlencoded
	CallbackBody string `json:"CallbackBody,omitempty"`

	// 透传给业务的回调内容,当Callback不为空时为必填,取值需要符合CallbackBodyType指定格式。
	CallbackBodyType string `json:"CallbackBodyType,omitempty"`

	// 回调时使用的 IP 地址
	CallbackHost string `json:"CallbackHost,omitempty"`

	// 文件在抓取时,是否不执行解码操作,取值如下所示:
	// * true:文件仅下载上传,不执行解码操作。
	// * false:(默认)文件在下载上传同时执行解码操作。
	FetchOnly bool `json:"FetchOnly,omitempty"`

	// 迁移资源的 IP 地址
	Host string `json:"Host,omitempty"`

	// 服务存储中存在相同的存储 key 时,是否忽略本次迁移操作。取值如下所示:
	// * true:忽略本次迁移操作。
	// * false:(默认)继续迁移并覆盖相同 key 的资源。
	IgnoreSameKey bool `json:"IgnoreSameKey,omitempty"`

	// 校验下载文件的 MD5,若校验不一致则停止文件的上传。
	MD5 string `json:"MD5,omitempty"`

	// 请求 header
	RequestHeader map[string][]string `json:"RequestHeader,omitempty"`

	// 指定存储 key,不包含 bucket 部分。默认使用随机生成的 key。 :::tip 若指定 key 已存在,则会覆盖服务中 StoreKey 对应的已有文件,此时服务中保存文件的数量未发生变化。 :::
	StoreKey string `json:"StoreKey,omitempty"`

	// 资源下载超时时间。
	// * 同步处理下最大超时为 20 秒;
	// * 异步处理下最大超时为 90 秒。
	TimeOut int `json:"TimeOut,omitempty"`
}

type FetchImageURLQuery added in v1.0.140

type FetchImageURLQuery struct{}

type FetchImageURLReq added in v1.0.140

type FetchImageURLReq struct {
	*FetchImageURLQuery
	*FetchImageURLBody
}

type FetchImageURLRes added in v1.0.140

type FetchImageURLRes struct {

	// REQUIRED
	ResponseMetadata *FetchImageURLResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *FetchImageURLResResult `json:"Result,omitempty"`
}

type FetchImageURLResResponseMetadata added in v1.0.140

type FetchImageURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type FetchImageURLResResult added in v1.0.140

type FetchImageURLResResult struct {

	// REQUIRED; 源文件 URL
	URL string `json:"Url"`

	// 动图持续时间,在同步处理情况下、迁移至图像处理服务且为图片资源时有返回值。
	Duration int `json:"Duration,omitempty"`

	// 任务结束执行时间戳,UTC 时间,单位为 ns。
	EndTime int `json:"EndTime,omitempty"`

	// 文件大小,单位为 byte。同步处理情况下有返回值。
	FSize int `json:"FSize,omitempty"`

	// 图片帧数,在同步处理情况下、迁移至图像处理服务且为图片资源时有返回值。
	FrameCnt int `json:"FrameCnt,omitempty"`

	// 图片类型,在同步处理情况下、迁移至图像处理服务且为图片资源时有返回值。
	ImageFormat string `json:"ImageFormat,omitempty"`

	// 图片高,在同步处理情况下、迁移至图像处理服务且为图片资源时有返回值。
	ImageHeight int `json:"ImageHeight,omitempty"`

	// 图片宽,在同步处理情况下、迁移至图像处理服务且为图片资源时有返回值。
	ImageWidth int `json:"ImageWidth,omitempty"`

	// 任务开始执行时间戳,UTC 时间,单位为 ns。
	StartTime int `json:"StartTime,omitempty"`

	// 迁移后的文件 URI,包含 bucket/key 两部分。
	StoreURI string `json:"StoreUri,omitempty"`

	// 异步任务 ID,仅当Async取值true,即采用异步时有返回值。
	TaskID string `json:"TaskId,omitempty"`

	// 完成任务总耗时,单位为毫秒。
	TimeCost int `json:"TimeCost,omitempty"`
}

FetchImageURLResResult - 视请求的接口而定

type Function

type Function struct {
	Name  string      `json:"Name"`
	Input interface{} `json:"Input"`
}

type GetAllImageServices added in v1.0.140

type GetAllImageServices struct{}

type GetAllImageServicesBody added in v1.0.140

type GetAllImageServicesBody struct{}

type GetAllImageServicesQuery added in v1.0.140

type GetAllImageServicesQuery struct {

	// 筛选服务的参数,当该值为空时返回所有服务,指定后返回服务名或者 ID 中包含该字符串的服务。
	SearchPtn string `json:"SearchPtn,omitempty" query:"SearchPtn"`
}

type GetAllImageServicesReq added in v1.0.140

type GetAllImageServicesReq struct {
	*GetAllImageServicesQuery
	*GetAllImageServicesBody
}

type GetAllImageServicesRes added in v1.0.140

type GetAllImageServicesRes struct {

	// REQUIRED
	ResponseMetadata *GetAllImageServicesResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetAllImageServicesResResult `json:"Result,omitempty"`
}

type GetAllImageServicesResResponseMetadata added in v1.0.140

type GetAllImageServicesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetAllImageServicesResResult added in v1.0.140

type GetAllImageServicesResResult struct {

	// REQUIRED; 所有的服务信息。
	Services []*GetAllImageServicesResResultServicesItem `json:"Services"`
}

GetAllImageServicesResResult - 视请求的接口而定

type GetAllImageServicesResResultServicesItem added in v1.0.140

type GetAllImageServicesResResultServicesItem struct {

	// REQUIRED; 服务的授权 Bucket 列表。
	AllowBkts []string `json:"AllowBkts"`

	// REQUIRED; 是否允许配置其他镜像站类型,取值如下所示:
	// * true:是
	// * false:否
	AllowMirrorTypes bool `json:"AllowMirrorTypes"`

	// REQUIRED; 是否开启精简 URL,取值如下所示:
	// * true:是
	// * false:否
	CompactURL string `json:"CompactURL"`

	// REQUIRED; 服务创建时间,即创建时当地服务器时间。
	CreateAt string `json:"CreateAt"`

	// REQUIRED; 绑定域名的相关信息。
	DomainInfos []*GetAllImageServicesResResultServicesPropertiesItemsItem `json:"DomainInfos"`

	// REQUIRED; 是否配置鉴权 key,取值如下所示:
	// * true:是
	// * false:否
	HasSigkey bool `json:"HasSigkey"`

	// REQUIRED; 自定义处理样式具体配置
	ImageYAttribute *GetAllImageServicesResResultServicesItemImageYAttribute `json:"ImageYAttribute"`

	// REQUIRED; 镜像回源配置。
	Mirror []*ComponentsPqmsj3SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesMirrorItems `json:"Mirror"`

	// REQUIRED; 是否开启源地址访问,取值如下所示:
	// * true:是
	// * false:否
	ObjectAccess bool `json:"ObjectAccess"`

	// REQUIRED; 主鉴权 Key。
	PrimaryKey string `json:"PrimaryKey"`

	// REQUIRED; 仅tob账号有值
	ProjectName string `json:"ProjectName"`

	// REQUIRED; 仅tob账号有值
	ResourceTags []*Components18K1KvdSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesResourcetagsItems `json:"ResourceTags"`

	// REQUIRED; 备鉴权 Key。
	SecondaryKey string `json:"SecondaryKey"`

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 服务名称。
	ServiceName string `json:"ServiceName"`

	// REQUIRED; 服务地域,取值如下所示:
	// * cn:中国
	// * va:美东
	// * sg:新加坡
	ServiceRegion string `json:"ServiceRegion"`

	// REQUIRED; 服务状态。状态分为未审核、审核未通过、正常、禁用。 :::tip
	// * 只有服务状态为正常时,该服务才可用。
	// * 如果是其他异常状态,请参考服务管理 [https://www.volcengine.com/docs/508/8086]进行处理。 :::
	ServiceStatus string `json:"ServiceStatus"`

	// REQUIRED; 服务类型,取值如下所示:
	// * StaticRc:素材托管服务
	// * Image:图片处理服务
	ServiceType string `json:"ServiceType"`

	// REQUIRED; 资源配置。
	Storage []*ComponentsDrd6S5SchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesStorageItems `json:"Storage"`

	// REQUIRED; 该服务的图片模板固定前缀。
	TemplatePrefix string `json:"TemplatePrefix"`

	// REQUIRED; 是否开启覆盖上传,取值如下所示:
	// * true:是
	// * false:否
	UploadOverwrite bool `json:"UploadOverwrite"`

	// 事件通知规则
	EventRules []*Components16Kv6ElSchemasGetallimageservicesresPropertiesResultPropertiesServicesItemsPropertiesEventrulesItems `json:"EventRules,omitempty"`
}

type GetAllImageServicesResResultServicesItemImageYAttribute added in v1.0.140

type GetAllImageServicesResResultServicesItemImageYAttribute struct {

	// REQUIRED; 是否开启原图保护,取值如下所示:
	// * true:开启
	// * false:关闭
	ResourceProtect bool `json:"ResourceProtect"`

	// REQUIRED; 样式分割符
	StyleSeparators []string `json:"StyleSeparators"`
}

GetAllImageServicesResResultServicesItemImageYAttribute - 自定义处理样式具体配置

type GetAllImageServicesResResultServicesPropertiesItemsItem added in v1.0.140

type GetAllImageServicesResResultServicesPropertiesItemsItem struct {

	// REQUIRED; 域名解析到的 cname。
	CNAME string `json:"CNAME"`

	// REQUIRED; 绑定的域名。
	DomainName string `json:"DomainName"`

	// REQUIRED; 是否为默认域名,取值如下所示:
	// * true:是
	// * false:否
	IsDefault bool `json:"IsDefault"`

	// REQUIRED; 域名状态。
	Status string `json:"Status"`
}

type GetAllImageTemplates added in v1.0.140

type GetAllImageTemplates struct{}

type GetAllImageTemplatesBody added in v1.0.140

type GetAllImageTemplatesBody struct{}

type GetAllImageTemplatesQuery added in v1.0.140

type GetAllImageTemplatesQuery struct {

	// REQUIRED; 服务ID
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 是否按照模板创建时间升序查询,默认为false。
	// * 取值为true时,表示按升序查询。
	// * 取值为false时,表示降序查询。
	Asc string `json:"Asc,omitempty" query:"Asc"`

	// 分页获取条数,默认 10。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量,默认 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 支持的字符正则集合为[a-zA-Z0-9_-]。指定时返回模板名称包含该字符串的图片模板,不填或者为空则返回所有模板。
	TemplateNamePattern string `json:"TemplateNamePattern,omitempty" query:"TemplateNamePattern"`
}

type GetAllImageTemplatesReq added in v1.0.140

type GetAllImageTemplatesReq struct {
	*GetAllImageTemplatesQuery
	*GetAllImageTemplatesBody
}

type GetAllImageTemplatesRes added in v1.0.140

type GetAllImageTemplatesRes struct {

	// REQUIRED
	ResponseMetadata *GetAllImageTemplatesResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetAllImageTemplatesResResult `json:"Result"`
}

type GetAllImageTemplatesResResponseMetadata added in v1.0.140

type GetAllImageTemplatesResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetAllImageTemplatesResResult added in v1.0.140

type GetAllImageTemplatesResResult struct {

	// REQUIRED
	ServiceID string `json:"ServiceId"`

	// REQUIRED
	Templates []*GetAllImageTemplatesResResultTemplatesItem `json:"Templates"`

	// REQUIRED
	Total int `json:"Total"`
}

type GetAllImageTemplatesResResultTemplatesItem added in v1.0.140

type GetAllImageTemplatesResResultTemplatesItem struct {

	// REQUIRED
	Abstract []string `json:"Abstract"`

	// REQUIRED; Anything
	AdaptiveFmt interface{} `json:"AdaptiveFmt"`

	// REQUIRED; Anything
	AnimExtract interface{} `json:"AnimExtract"`

	// REQUIRED; Anything
	Animation interface{} `json:"Animation"`

	// REQUIRED
	AutoQuality bool `json:"AutoQuality"`

	// REQUIRED
	Content string `json:"Content"`

	// REQUIRED
	CreateAt string `json:"CreateAt"`

	// REQUIRED
	Creator string `json:"Creator"`

	// REQUIRED
	DemotionFormat string `json:"DemotionFormat"`

	// REQUIRED
	Encrypted bool `json:"encrypted"`

	// REQUIRED
	Evals []interface{} `json:"Evals"`

	// REQUIRED; Anything
	Exif interface{} `json:"Exif"`

	// REQUIRED
	Filters []*Components1T23IneSchemasGetallimagetemplatesresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems `json:"Filters"`

	// REQUIRED
	LoopCount int `json:"LoopCount"`

	// REQUIRED
	MaxAge int `json:"MaxAge"`

	// REQUIRED
	OuputQuality int `json:"OuputQuality"`

	// REQUIRED; Dictionary of
	OutputExtra map[string]string `json:"OutputExtra"`

	// REQUIRED
	OutputFormat string `json:"OutputFormat"`

	// REQUIRED; Anything
	OutputVideo interface{} `json:"OutputVideo"`

	// REQUIRED
	Parameters []string `json:"Parameters"`

	// REQUIRED
	Persistence string `json:"Persistence"`

	// REQUIRED
	QualityMode string `json:"QualityMode"`

	// REQUIRED
	QualityStr string `json:"QualityStr"`

	// REQUIRED
	ReqDeadline string `json:"ReqDeadline"`

	// REQUIRED
	ServiceID string `json:"ServiceID"`

	// REQUIRED; Anything
	Snapshot interface{} `json:"Snapshot"`

	// REQUIRED
	Sync bool `json:"Sync"`

	// REQUIRED
	TemplateName string `json:"TemplateName"`

	// REQUIRED
	TemplateType string `json:"TemplateType"`

	// REQUIRED
	Timeout int `json:"Timeout"`

	// REQUIRED
	Updater string `json:"Updater"`

	// REQUIRED
	Usage string `json:"Usage"`

	// REQUIRED
	WithSig bool `json:"WithSig"`
}

type GetAuditEntrysCount added in v1.0.140

type GetAuditEntrysCount struct{}

type GetAuditEntrysCountBody added in v1.0.140

type GetAuditEntrysCountBody struct{}

type GetAuditEntrysCountQuery added in v1.0.140

type GetAuditEntrysCountQuery struct {

	// 任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId,omitempty" query:"TaskId"`
}

type GetAuditEntrysCountReq added in v1.0.118

type GetAuditEntrysCountReq struct {
	*GetAuditEntrysCountQuery
	*GetAuditEntrysCountBody
}

type GetAuditEntrysCountRes added in v1.0.140

type GetAuditEntrysCountRes struct {

	// REQUIRED
	ResponseMetadata *GetAuditEntrysCountResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetAuditEntrysCountResResult `json:"Result"`
}

type GetAuditEntrysCountResResponseMetadata added in v1.0.140

type GetAuditEntrysCountResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetAuditEntrysCountResResult added in v1.0.140

type GetAuditEntrysCountResResult struct {

	// REQUIRED; 异常审核的总次数,即审核失败、建议不通过和建议复审的审核次数之和。
	AuditExceptionCount int `json:"AuditExceptionCount"`

	// REQUIRED; 审核失败的审核次数
	AuditFailCount int `json:"AuditFailCount"`

	// REQUIRED; 建议不通过的审核次数
	AuditNopassCount int `json:"AuditNopassCount"`

	// REQUIRED; 建议复审的审核次数
	AuditRecheckCount int `json:"AuditRecheckCount"`

	// REQUIRED; 审核成功的审核次数。
	AuditSuccessCount int `json:"AuditSuccessCount"`

	// REQUIRED; 该任务的审核总次数,为审核成功和审核失败的图片数量之和。
	AuditTotal int `json:"AuditTotal"`

	// REQUIRED; 审核异常的图片数量,即审核失败、建议不通过和建议复审的图片数量之和。
	ExceptionCount int `json:"ExceptionCount"`

	// REQUIRED; 审核失败的图片数量
	FailedCount int `json:"FailedCount"`

	// REQUIRED; 建议不通过的图片数量
	NopassCount int `json:"NopassCount"`

	// REQUIRED; 建议复审的图片数量
	RecheckCount int `json:"RecheckCount"`

	// REQUIRED; 审核成功的图片数量
	SuccessCount int `json:"SuccessCount"`

	// REQUIRED; 累计审核图片数量,为审核成功和审核失败的图片数量之和。
	Total int `json:"Total"`
}

type GetComprehensiveEnhanceImage added in v1.0.140

type GetComprehensiveEnhanceImage struct{}

type GetComprehensiveEnhanceImageBody added in v1.0.140

type GetComprehensiveEnhanceImageBody struct {

	// REQUIRED; 图片存储 URI 或访问 URL。
	// * 图片 URI 格式,例如:tos-example/7a7979974.jpeg
	// * 图片 URL 格式,可公网访问。例如:https://example.org/tos-example/7a7979974.jpeg~tplv.png
	ImageURI string `json:"ImageUri"`

	// REQUIRED; 优化策略,取值如下所示:
	// * 0:通用画质提升
	// * 1:显著画质提升 :::tip 推荐优先使用通用方案,显著画质提升方案画质分提高 10% 左右,但体积会有一定浮动提升。以上幅度变化基于测试集总结,具体以使用场景为准。 :::
	Mode int `json:"Mode"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// 去压缩失真强度,取值范围为[0,1]。取值为0时表示不处理,取值越大去压缩失真强度越大。
	ArStrength float64 `json:"ArStrength,omitempty"`

	// 亮度,取值范围为[90,100]。取值越小,亮度提升越明显。
	Brightness int `json:"Brightness,omitempty"`

	// 去模糊强度,取值范围为[0,1]。取值为0时表示不处理,取值越大去模糊强度越大。
	DeblurStrength float64 `json:"DeblurStrength,omitempty"`

	// 降噪强度,取值范围为[0,1]。取值为0时表示不降噪,取值越大降噪强度越大。
	DenoiseStrength float64 `json:"DenoiseStrength,omitempty"`

	// 下采样模式,取值如下所示:
	// * 0: 仅缩小,图片大于设置的“宽/高”时,将缩小图片
	// * 1: 仅放大,图片小于设置的“宽/高”时,将放大图片
	// * 2: 既缩小又放大,即按照自定义“宽/高”输出结果图,该操作可能导致图片变形
	DownsampleMode int `json:"DownsampleMode,omitempty"`

	// 下采样输出图片高度,图片将适配对应大小。单位为 px。
	DownsampleOutHeight int `json:"DownsampleOutHeight,omitempty"`

	// 下采样输出图片宽度,图片将适配对应大小。单位为 px。
	DownsampleOutWidth int `json:"DownsampleOutWidth,omitempty"`

	// 内是否启用高级配置,取值如下所示:
	// * true:开启。开启后,下述高级配置才会生效。
	// * false:(默认)关闭。 :::tip 适用于 8000 x 8000 以分辨率图像的画质增强。 :::
	EnableConfig bool `json:"EnableConfig,omitempty"`

	// 是否开启下采样,即图片在执行增强效果的同时可自定义输出图片分辨率大小。取值如下所示:
	// * true:开启。仅当开启后,下述下采样配置才会生效。
	// * false:(默认)关闭。 :::tip 适用于 8000 x 8000 以内分辨率图像的画质增强。 :::
	EnableDownsample bool `json:"EnableDownsample,omitempty"`

	// 是否开启超分配置,仅满足图像输入边界的图像执行超分处理。取值如下所示:
	// * true:开启。仅当开启后,下述超分配置才会生效。
	// * false:(默认)关闭。 :::tip 适用于 8000 x 8000 以内分辨率图像的画质增强。 :::
	EnableSuperResolution bool `json:"EnableSuperResolution,omitempty"`

	// 执行超分处理的长边范围最大值,仅当满足图像边界输入的图像执行超分处理。单位为 px。
	LongMax int `json:"LongMax,omitempty"`

	// 执行超分处理的长边范围最小值,仅当满足图像边界输入的图像执行超分处理。单位为 px。
	LongMin int `json:"LongMin,omitempty"`

	// 超分倍率,仅支持 2 倍和 4 倍。 :::tip 4 倍超分辨率只适用于 4000 x 4000 以内分辨率图像的画质增强。 :::
	Multiple int `json:"Multiple,omitempty"`

	// 饱和度,取值范围为[0,2]。取值大于 1 表示提升饱和度,取值小于 1 表示降低饱和度。
	Saturation float64 `json:"Saturation,omitempty"`

	// 执行超分处理的短边范围最大值,仅当满足图像边界输入的图像执行超分处理。单位为 px。
	ShortMax int `json:"ShortMax,omitempty"`

	// 执行超分处理的短边范围最小值,仅当满足图像边界输入的图像执行超分处理。单位为 px。
	ShortMin int `json:"ShortMin,omitempty"`
}

type GetComprehensiveEnhanceImageQuery added in v1.0.140

type GetComprehensiveEnhanceImageQuery struct{}

type GetComprehensiveEnhanceImageReq added in v1.0.140

type GetComprehensiveEnhanceImageReq struct {
	*GetComprehensiveEnhanceImageQuery
	*GetComprehensiveEnhanceImageBody
}

type GetComprehensiveEnhanceImageRes added in v1.0.140

type GetComprehensiveEnhanceImageRes struct {

	// REQUIRED
	ResponseMetadata *GetComprehensiveEnhanceImageResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetComprehensiveEnhanceImageResResult `json:"Result,omitempty"`
}

type GetComprehensiveEnhanceImageResResponseMetadata added in v1.0.140

type GetComprehensiveEnhanceImageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetComprehensiveEnhanceImageResResult added in v1.0.140

type GetComprehensiveEnhanceImageResResult struct {

	// REQUIRED; 结果图地址
	ResURI string `json:"ResUri"`
}

GetComprehensiveEnhanceImageResResult - 视请求的接口而定

type GetCompressTaskInfo added in v1.0.140

type GetCompressTaskInfo struct{}

type GetCompressTaskInfoBody added in v1.0.140

type GetCompressTaskInfoBody struct{}

type GetCompressTaskInfoQuery added in v1.0.140

type GetCompressTaskInfoQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 异步任务 ID
	TaskID string `json:"TaskId" query:"TaskId"`
}

type GetCompressTaskInfoReq added in v1.0.140

type GetCompressTaskInfoReq struct {
	*GetCompressTaskInfoQuery
	*GetCompressTaskInfoBody
}

type GetCompressTaskInfoRes added in v1.0.140

type GetCompressTaskInfoRes struct {

	// REQUIRED
	ResponseMetadata *GetCompressTaskInfoResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetCompressTaskInfoResResult `json:"Result,omitempty"`
}

type GetCompressTaskInfoResResponseMetadata added in v1.0.140

type GetCompressTaskInfoResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetCompressTaskInfoResResult added in v1.0.140

type GetCompressTaskInfoResResult struct {

	// REQUIRED; 压缩文件包 StoreUri
	OutputURI string `json:"OutputUri"`

	// REQUIRED; 异步任务状态,取值如下所示:
	// * Pending:排队中
	//
	//
	// * Running:进行中
	//
	//
	// * Failed:执行失败
	//
	//
	// * Success:执行成功
	Status string `json:"Status"`

	// REQUIRED; 异步任务 ID
	TaskID string `json:"TaskId"`

	// 错误码。仅当Status为Failed时,该值不为 0。
	ErrCode int `json:"ErrCode,omitempty"`

	// 错误信息。仅当Status为Failed时,该值不为空。
	ErrMsg string `json:"ErrMsg,omitempty"`

	// 任务处理进度,即已处理的文件数量。
	ProcessCount int `json:"ProcessCount,omitempty"`
}

GetCompressTaskInfoResResult - 视请求的接口而定

type GetDedupTaskStatus added in v1.0.140

type GetDedupTaskStatus struct{}

type GetDedupTaskStatusBody added in v1.0.140

type GetDedupTaskStatusBody struct{}

type GetDedupTaskStatusQuery added in v1.0.140

type GetDedupTaskStatusQuery struct {

	// REQUIRED; 任务 ID,您可以通过调用使用图片去重获取结果值 [https://www.volcengine.com/docs/508/138658]接口获取异步去重TaskId返回值。
	TaskID string `json:"TaskId" query:"TaskId"`
}

type GetDedupTaskStatusReq added in v1.0.140

type GetDedupTaskStatusReq struct {
	*GetDedupTaskStatusQuery
	*GetDedupTaskStatusBody
}

type GetDedupTaskStatusRes added in v1.0.140

type GetDedupTaskStatusRes struct {

	// REQUIRED
	ResponseMetadata *GetDedupTaskStatusResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetDedupTaskStatusResResult `json:"Result,omitempty"`
}

type GetDedupTaskStatusResResponseMetadata added in v1.0.140

type GetDedupTaskStatusResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetDedupTaskStatusResResult added in v1.0.140

type GetDedupTaskStatusResResult struct {

	// REQUIRED; 分组结果,若输入 2 个以上原图时,将按组返回内容相同的图片,每组的图片个数非固定值。
	Groups map[string][]string `json:"Groups"`

	// REQUIRED; 图片评分,仅在两张图片对比才返回 Score 字段。
	Score string `json:"Score"`

	// REQUIRED; 异步任务状态,取值如下所示:
	// * 0:任务进行中
	// * 1:任务执行成功
	// * 2:任务执行失败
	Status int `json:"Status"`

	// REQUIRED; 任务 ID。
	TaskID string `json:"TaskId"`
}

GetDedupTaskStatusResResult - 视请求的接口而定

type GetDomainConfig added in v1.0.140

type GetDomainConfig struct{}

type GetDomainConfigBody added in v1.0.140

type GetDomainConfigBody struct{}

type GetDomainConfigQuery added in v1.0.140

type GetDomainConfigQuery struct {

	// REQUIRED; 域名,您可以通过调用 GetServiceDomains [https://www.volcengine.com/docs/508/9379] 获取当前服务下所有域名。
	DomainName string `json:"DomainName" query:"DomainName"`

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetDomainConfigReq added in v1.0.140

type GetDomainConfigReq struct {
	*GetDomainConfigQuery
	*GetDomainConfigBody
}

type GetDomainConfigRes added in v1.0.140

type GetDomainConfigRes struct {

	// REQUIRED
	ResponseMetadata *GetDomainConfigResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetDomainConfigResResult `json:"Result,omitempty"`
}

type GetDomainConfigResResponseMetadata added in v1.0.140

type GetDomainConfigResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetDomainConfigResResult added in v1.0.140

type GetDomainConfigResResult struct {

	// REQUIRED; 访问控制配置
	AccessControl *GetDomainConfigResResultAccessControl `json:"access_control"`

	// REQUIRED; 是否开启自适应格式,取值如下所示:
	// * true:开启自适应
	// * false:关闭自适应
	Adaptfmt bool `json:"adaptfmt"`

	// REQUIRED; 是否开启集智瘦身,取值如下所示:
	// * true:开启集智瘦身
	// * false:关闭集智瘦身
	DoSlim bool `json:"do_slim"`

	// REQUIRED; 域名
	Domain string `json:"domain"`

	// REQUIRED; 是否开启全球加速,取值如下所示:
	// * true:开启全球加速
	// * false:关闭全球加速
	GlobalAcceleration bool `json:"global_acceleration"`

	// REQUIRED; HTTPS 配置
	HTTPSConfig *GetDomainConfigResResultHTTPSConfig `json:"https_config"`

	// REQUIRED; 域名锁定状态
	LockStatus *GetDomainConfigResResultLockStatus `json:"lock_status"`

	// REQUIRED; HTTP Header 配置
	RespHdrs []*GetDomainConfigResResultRespHdrsItem `json:"resp_hdrs"`

	// REQUIRED; 域名状态
	Status string `json:"status"`
}

GetDomainConfigResResult - 视请求的接口而定

type GetDomainConfigResResultAccessControl added in v1.0.140

type GetDomainConfigResResultAccessControl struct {

	// REQUIRED; IP 访问控制配置
	IPAuth *GetDomainConfigResResultAccessControlIPAuth `json:"ip_auth"`

	// REQUIRED; Referer 访问限制配置
	ReferLink *GetDomainConfigResResultAccessControlReferLink `json:"refer_link"`

	// REQUIRED; 远程鉴权设置
	RemoteAuth *GetDomainConfigResResultAccessControlRemoteAuth `json:"remote_auth"`

	// REQUIRED; URL 鉴权配置
	URLAuth *GetDomainConfigResResultAccessControlURLAuth `json:"url_auth"`

	// REQUIRED; UA 访问控制配置
	UaList *GetDomainConfigResResultAccessControlUaList `json:"ua_list"`
}

GetDomainConfigResResultAccessControl - 访问控制配置

type GetDomainConfigResResultAccessControlIPAuth added in v1.0.140

type GetDomainConfigResResultAccessControlIPAuth struct {

	// REQUIRED; 是否开启 IP 访问控制,取值如下所示:
	// * true:开启 IP 访问控制
	// * false:关闭 IP 访问控制
	Enabled bool `json:"enabled"`

	// REQUIRED; 是否是白名单模式,取值如下所示:
	// * true:白名单模式
	// * false:黑名单模式
	IsWhiteMode bool `json:"is_white_mode"`

	// REQUIRED; IP 列表
	Values []string `json:"values"`
}

GetDomainConfigResResultAccessControlIPAuth - IP 访问控制配置

type GetDomainConfigResResultAccessControlReferLink struct {

	// REQUIRED; 是否允许空 Referer,取值如下所示:
	// * true:允许空 Referer
	// * false:禁止空 Referer
	AllowEmptyRefer bool `json:"allow_empty_refer"`

	// REQUIRED; 是否开启 Referer 访问限制,取值如下所示:
	// * true:开启 Referer 访问限制
	// * false:关闭 Referer 访问限制
	Enabled bool `json:"enabled"`

	// REQUIRED; 是否是 Referer 白名单模式,取值如下所示:
	// * true:白名单模式
	// * false:黑名单模式 :::tip 当is_white_mode为false时,即选用黑名单时,需确保allow_empty_refer为true。 :::
	IsWhiteMode bool `json:"is_white_mode"`

	// REQUIRED; 正则规则列表
	RegexValues []string `json:"regex_values"`

	// REQUIRED; Referer 列表
	Values []string `json:"values"`
}

GetDomainConfigResResultAccessControlReferLink - Referer 访问限制配置

type GetDomainConfigResResultAccessControlRemoteAuth added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuth struct {

	// REQUIRED; 鉴权请求头设置
	AuthRequestHeader *GetDomainConfigResResultAccessControlRemoteAuthRequestHeader `json:"auth_request_header"`

	// REQUIRED; 鉴权请求参数设置
	AuthRequestQuery *GetDomainConfigResResultAccessControlRemoteAuthRequestQuery `json:"auth_request_query"`

	// REQUIRED; 鉴权响应设置
	AuthResponse *GetDomainConfigResResultAccessControlRemoteAuthResponse `json:"auth_response"`

	// REQUIRED; 鉴权服务器设置
	AuthServer *GetDomainConfigResResultAccessControlRemoteAuthServer `json:"auth_server"`

	// REQUIRED; 是否开启远程鉴权,取值如下所示:
	// * true:是
	// * false:否
	Enabled bool `json:"enabled"`

	// REQUIRED; 生效对象
	MatchRule []*GetDomainConfigResResultAccessControlRemoteAuthMatchRuleItem `json:"match_rule"`
}

GetDomainConfigResResultAccessControlRemoteAuth - 远程鉴权设置

type GetDomainConfigResResultAccessControlRemoteAuthAuthResponseResponse added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthAuthResponseResponse struct {

	// REQUIRED; 鉴权失败时,响应用户的状态码
	FailCode string `json:"fail_code"`
}

GetDomainConfigResResultAccessControlRemoteAuthAuthResponseResponse - 响应设置

type GetDomainConfigResResultAccessControlRemoteAuthMatchRuleItem added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthMatchRuleItem struct {

	// REQUIRED; 匹配方式,取值如下所示:
	// * match:object 匹配 Value。
	// * not_match:object 不匹配 Value。
	MatchOperator string `json:"match_operator"`

	// REQUIRED; 对哪些对象类型进行规则匹配,取值如下所示:
	// * filetype:表示特定后缀的文件。
	// * directory:表示特定文件目录下的所有文件。
	// * path:表示特定的文件。
	Object string `json:"object"`

	// REQUIRED; Object 对应的具体对象
	Value string `json:"value"`
}

type GetDomainConfigResResultAccessControlRemoteAuthRequestHeader added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthRequestHeader struct {

	// REQUIRED; 鉴权请求头是否包含用户请求头,取值如下所示:
	// * exclude:表示鉴权请求头中不包含任何用户请求头。
	// * include:表示鉴权请求头中包含所有用户请求头。
	// * includePart:表示鉴权请求头包含指定的用户请求头。
	Action string `json:"action"`

	// REQUIRED; 额外请求头
	Header []*GetDomainConfigResResultAccessControlRemoteAuthRequestHeaderItem `json:"header"`

	// REQUIRED; 鉴权请求中 HOST 头部的值,固定为 default,即 HOST 头部的值与您的加速域名相同。
	Host string `json:"host"`

	// REQUIRED; Action 参数所对应的参数值
	Value string `json:"value"`
}

GetDomainConfigResResultAccessControlRemoteAuthRequestHeader - 鉴权请求头设置

type GetDomainConfigResResultAccessControlRemoteAuthRequestHeaderItem added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthRequestHeaderItem struct {

	// REQUIRED; 您设置的请求头
	Key string `json:"key"`

	// REQUIRED; 请求头的值
	Value string `json:"value"`

	// REQUIRED; 请求头的类型
	ValueType string `json:"value_type"`
}

type GetDomainConfigResResultAccessControlRemoteAuthRequestQuery added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthRequestQuery struct {

	// REQUIRED; 鉴权请求是否包含用户请求 URL 中的查询参数。取值如下所示:
	// * exclude:表示鉴权请求不包含任何查询参数。
	// * include:表示鉴权请求包含所有查询参数。
	// * includePart:表示鉴权请求包含指定的查询参数。
	Action string `json:"action"`

	// REQUIRED; 额外参数
	Query []*GetDomainConfigResResultAccessControlRemoteAuthRequestQueryItem `json:"query"`

	// REQUIRED; Action 参数所对应的参数值
	Value string `json:"value"`
}

GetDomainConfigResResultAccessControlRemoteAuthRequestQuery - 鉴权请求参数设置

type GetDomainConfigResResultAccessControlRemoteAuthRequestQueryItem added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthRequestQueryItem struct {

	// REQUIRED; 您设置的鉴权请求参数
	Key string `json:"key"`

	// REQUIRED; 鉴权请求参数的值
	Value string `json:"value"`

	// REQUIRED; 您在 Key 中设置的鉴权请求参数的类型
	ValueType string `json:"value_type"`
}

type GetDomainConfigResResultAccessControlRemoteAuthResponse added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthResponse struct {

	// REQUIRED; 鉴权结果缓存设置
	AuthResultCache *GetDomainConfigResResultAccessControlRemoteAuthResponseAuthResultCache `json:"auth_result_cache"`

	// REQUIRED; 鉴权服务器状态码设置
	AuthServerStatusCode *GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerStatusCode `json:"auth_server_status_code"`

	// REQUIRED; 鉴权服务超时时间
	AuthServerTimeout *GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerTimeout `json:"auth_server_timeout"`

	// REQUIRED; 响应设置
	Response *GetDomainConfigResResultAccessControlRemoteAuthAuthResponseResponse `json:"response"`
}

GetDomainConfigResResultAccessControlRemoteAuthResponse - 鉴权响应设置

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthResultCache added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthResultCache struct {

	// REQUIRED; 是否缓存鉴权状态码,取值如下所示:
	// * nocache:veImageX 不缓存鉴权状态码。
	// * cache:veImageX 缓存鉴权状态码。
	Action string `json:"action"`

	// REQUIRED; 缓存 key 指定了用于区分不同请求 URI 的查询参数
	CacheKey []string `json:"cache_key"`

	// REQUIRED; 鉴权状态码的缓存时间,单位是秒
	TTL int `json:"ttl"`
}

GetDomainConfigResResultAccessControlRemoteAuthResponseAuthResultCache - 鉴权结果缓存设置

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerStatusCode added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerStatusCode struct {

	// REQUIRED; 如果鉴权状态码既不是 FailCode,又不是 SuccessCode 时,处理鉴权请求的方式
	DefaultAction string `json:"default_action"`

	// REQUIRED; 鉴权失败时的鉴权状态码
	FailCode string `json:"fail_code"`

	// REQUIRED; 鉴权成功时的鉴权状态码
	SuccessCode string `json:"success_code"`
}

GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerStatusCode - 鉴权服务器状态码设置

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerTimeout added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerTimeout struct {

	// REQUIRED; 鉴权超时后处理鉴权请求的策略,取值如下所示:
	// * reject:veImageX 认为鉴权失败。
	// * pass:veImageX 认为鉴权成功。
	Action string `json:"action"`

	// REQUIRED; 鉴权超时的时间,单位是毫秒。
	Time int `json:"time"`
}

GetDomainConfigResResultAccessControlRemoteAuthResponseAuthServerTimeout - 鉴权服务超时时间

type GetDomainConfigResResultAccessControlRemoteAuthServer added in v1.0.140

type GetDomainConfigResResultAccessControlRemoteAuthServer struct {

	// REQUIRED; 鉴权服务器的主地址
	Address string `json:"address"`

	// REQUIRED; 鉴权服务器的备地址
	BackupAddress string `json:"backup_address"`

	// REQUIRED; 鉴权请求的路径,取值如下所示:
	// * constant:表示鉴权请求中的路径与用户请求中的路径相同。
	// * variable:表示您需要在 pathValue 参数中指定一个鉴权请求中的路径。
	PathType string `json:"path_type"`

	// REQUIRED; 一个鉴权请求的路径
	PathValue string `json:"path_value"`

	// REQUIRED; 在发送鉴权请求时所使用的请求方法,取值如下所示:
	// * default:鉴权请求所使用的方法与用户的请求相同。
	// * get:鉴权请求使用 GET 方法。
	// * post:鉴权请求使用 POST 方法。
	// * head:鉴权请求使用 HEAD 方法。
	RequestMethod string `json:"request_method"`
}

GetDomainConfigResResultAccessControlRemoteAuthServer - 鉴权服务器设置

type GetDomainConfigResResultAccessControlURLAuth added in v1.0.140

type GetDomainConfigResResultAccessControlURLAuth struct {

	// REQUIRED; 是否开启 URL 鉴权 ,取值如下所示:
	// * true:开启 URL 鉴权
	// * false:关闭 URL 鉴权
	Enabled bool `json:"enabled"`

	// REQUIRED; A 鉴权配置
	TypeA *GetDomainConfigResResultAccessControlURLAuthTypeA `json:"type_a"`

	// REQUIRED; B 鉴权配置
	TypeB *GetDomainConfigResResultAccessControlURLAuthTypeB `json:"type_b"`

	// REQUIRED; C 鉴权配置
	TypeC *GetDomainConfigResResultAccessControlURLAuthTypeC `json:"type_c"`

	// REQUIRED; D 鉴权配置
	TypeD *GetDomainConfigResResultAccessControlURLAuthTypeD `json:"type_d"`
}

GetDomainConfigResResultAccessControlURLAuth - URL 鉴权配置

type GetDomainConfigResResultAccessControlURLAuthTypeA added in v1.0.140

type GetDomainConfigResResultAccessControlURLAuthTypeA struct {

	// REQUIRED; 备用鉴权密钥
	BackupSk string `json:"backup_sk"`

	// REQUIRED; 有效时间,单位为秒。取值范围为[1, 630720000]内的正整数,默认为 1800 秒。
	ExpireTime int `json:"expire_time"`

	// REQUIRED; 主鉴权密钥
	MainSk string `json:"main_sk"`

	// REQUIRED; 签名参数名
	SignParam string `json:"sign_param"`
}

GetDomainConfigResResultAccessControlURLAuthTypeA - A 鉴权配置

type GetDomainConfigResResultAccessControlURLAuthTypeB added in v1.0.140

type GetDomainConfigResResultAccessControlURLAuthTypeB struct {

	// REQUIRED; 备用鉴权密钥
	BackupSk string `json:"backup_sk"`

	// REQUIRED; 有效时间,单位为秒。取值范围为[1, 630720000]内的正整数,默认为 1800 秒。
	ExpireTime int `json:"expire_time"`

	// REQUIRED; 主鉴权密钥
	MainSk string `json:"main_sk"`
}

GetDomainConfigResResultAccessControlURLAuthTypeB - B 鉴权配置

type GetDomainConfigResResultAccessControlURLAuthTypeC added in v1.0.140

type GetDomainConfigResResultAccessControlURLAuthTypeC struct {

	// REQUIRED; 备用鉴权密钥
	BackupSk string `json:"backup_sk"`

	// REQUIRED; 有效时间,单位为秒。取值范围为[1, 630720000]内的正整数,默认为 1800 秒。
	ExpireTime int `json:"expire_time"`

	// REQUIRED; 主鉴权密钥
	MainSk string `json:"main_sk"`
}

GetDomainConfigResResultAccessControlURLAuthTypeC - C 鉴权配置

type GetDomainConfigResResultAccessControlURLAuthTypeD added in v1.0.140

type GetDomainConfigResResultAccessControlURLAuthTypeD struct {

	// REQUIRED; 备用鉴权密钥
	BackupSk string `json:"backup_sk"`

	// REQUIRED; 有效时间,单位为秒。取值范围为[1, 630720000]内的正整数,默认为 1800 秒。
	ExpireTime int `json:"expire_time"`

	// REQUIRED; 主鉴权密钥
	MainSk string `json:"main_sk"`

	// REQUIRED; md5hash 参数名
	SignParam string `json:"sign_param"`

	// REQUIRED; 时间戳格式,取值如下所示:
	// * decimal:十进制(Unix 时间戳)
	// * heximal:十六进制(Unix 时间戳)
	TimeFormat string `json:"time_format"`

	// REQUIRED; TimeStamp 参数名
	TimeParam string `json:"time_param"`
}

GetDomainConfigResResultAccessControlURLAuthTypeD - D 鉴权配置

type GetDomainConfigResResultAccessControlUaList added in v1.0.140

type GetDomainConfigResResultAccessControlUaList struct {

	// REQUIRED; 是否开启 UA 访问控制,取值如下所示:
	// * true:开启 UA 访问控制
	// * false:关闭 UA 访问控制
	Enabled bool `json:"enabled"`

	// REQUIRED; 是否是白名单模式,取值如下所示:
	// * true:白名单模式
	// * false:黑名单模式
	IsWhiteMode bool `json:"is_white_mode"`

	// REQUIRED; UA 列表
	Values []string `json:"values"`
}

GetDomainConfigResResultAccessControlUaList - UA 访问控制配置

type GetDomainConfigResResultHTTPSConfig added in v1.0.140

type GetDomainConfigResResultHTTPSConfig struct {

	// REQUIRED; 证书 ID,若enable_https为true,则为必选。
	CertID string `json:"cert_id"`

	// REQUIRED; 是否开启 HTTP2,取值如下所示:
	// * true:开启 HTTP2
	// * false:关闭 HTTP2
	EnableHTTP2 bool `json:"enable_http2"`

	// REQUIRED; 是否开启 HTTPS,取值如下所示:
	// * true:开启 HTTPS
	// * false:关闭 HTTPS
	EnableHTTPS bool `json:"enable_https"`

	// REQUIRED; 是否强制使用 HTTPS,取值如下所示:
	// * true:强制 HTTPS
	// * false:不强制 HTTPS
	ForceHTTPS bool `json:"force_https"`
}

GetDomainConfigResResultHTTPSConfig - HTTPS 配置

type GetDomainConfigResResultLockStatus added in v1.0.140

type GetDomainConfigResResultLockStatus struct {

	// REQUIRED; 智能压缩是否锁定,取值如下所示:
	// * true:是
	// * false:否
	CompressionLocked bool `json:"compression_locked"`

	// REQUIRED; 整个域名是否锁定,取值如下所示:
	// * true:是
	// * false:否
	DomainLocked bool `json:"domain_locked"`

	// REQUIRED; IP 访问限制是否锁定,取值如下所示:
	// * true:是
	// * false:否
	IPAccessRuleLocked bool `json:"ip_access_rule_locked"`

	// REQUIRED; 锁定原因
	Reason string `json:"reason"`

	// REQUIRED; Referer 防盗链配置是否锁定,取值如下所示:
	// * true:是
	// * false:否
	RefererAccessRuleLocked bool `json:"referer_access_rule_locked"`

	// REQUIRED; 远程鉴权是否锁定,取值如下所示:
	// * true:是
	// * false:否
	RemoteAuthLocked bool `json:"remote_auth_locked"`

	// REQUIRED; 响应头配置是否锁定,取值如下所示:
	// * true:是
	// * false:否
	ResponseHeaderLocked bool `json:"response_header_locked"`

	// REQUIRED; URL 鉴权签算配置是否锁定,取值如下所示:
	// * true:是
	// * false:否
	SignURLAuthLocked bool `json:"sign_url_auth_locked"`

	// REQUIRED; UA 访问限制配置是否锁定,取值如下所示:
	// * true:是
	// * false:否
	UaAccessRuleLocked bool `json:"ua_access_rule_locked"`
}

GetDomainConfigResResultLockStatus - 域名锁定状态

type GetDomainConfigResResultRespHdrsItem added in v1.0.140

type GetDomainConfigResResultRespHdrsItem struct {

	// REQUIRED; header key
	Key string `json:"key"`

	// REQUIRED; header value
	Value string `json:"value"`
}

type GetImageAnalyzeResult added in v1.0.140

type GetImageAnalyzeResult struct{}

type GetImageAnalyzeResultBody added in v1.0.140

type GetImageAnalyzeResultBody struct{}

type GetImageAnalyzeResultQuery added in v1.0.140

type GetImageAnalyzeResultQuery struct {

	// REQUIRED; 任务运行结束时间,Unix 时间戳。
	EndTime int `json:"EndTime" query:"EndTime"`

	// REQUIRED; 任务运行开始时间,Unix 时间戳。
	StartTime int `json:"StartTime" query:"StartTime"`

	// REQUIRED; 任务 ID,您可以通过调用GetImageAnalyzeTasks [https://www.volcengine.com/docs/508/1160417]获取指定地区全部离线评估任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`

	// 文件名
	File string `json:"File,omitempty" query:"File"`

	// 分页条数。默认值为 10。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 任务执行 ID
	RunID string `json:"RunId,omitempty" query:"RunId"`
}

type GetImageAnalyzeResultReq added in v1.0.140

type GetImageAnalyzeResultReq struct {
	*GetImageAnalyzeResultQuery
	*GetImageAnalyzeResultBody
}

type GetImageAnalyzeResultRes added in v1.0.140

type GetImageAnalyzeResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageAnalyzeResultResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageAnalyzeResultResResult `json:"Result"`
}

type GetImageAnalyzeResultResResponseMetadata added in v1.0.140

type GetImageAnalyzeResultResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageAnalyzeResultResResult added in v1.0.140

type GetImageAnalyzeResultResResult struct {

	// REQUIRED; 任务结果
	Results []*GetImageAnalyzeResultResResultResultsItem `json:"Results"`

	// REQUIRED; 查询到的总量
	Total int `json:"Total"`
}

type GetImageAnalyzeResultResResultResultsItem added in v1.0.140

type GetImageAnalyzeResultResResultResultsItem struct {

	// 评估结果存储 URI
	ResultURI string `json:"ResultUri,omitempty"`

	// 任务指定 ID
	RunID   string `json:"RunId,omitempty"`
	StartAt string `json:"StartAt,omitempty"`

	// 任务状态,取值如下所示:
	// * Running:进行中
	// * Suspend:暂停
	// * Done:结束
	Status string `json:"Status,omitempty"`
}

type GetImageAnalyzeTasks added in v1.0.140

type GetImageAnalyzeTasks struct{}

type GetImageAnalyzeTasksBody added in v1.0.140

type GetImageAnalyzeTasksBody struct{}

type GetImageAnalyzeTasksQuery added in v1.0.140

type GetImageAnalyzeTasksQuery struct {

	// 分页条数。取值范围为 (0,100],默认值为 100。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 任务地区。默认为 cn,表示国内。
	Region string `json:"Region,omitempty" query:"Region"`

	// 返回任务名称或描述中包含该值的任务。
	SearchPtn string `json:"SearchPtn,omitempty" query:"SearchPtn"`
}

type GetImageAnalyzeTasksReq added in v1.0.140

type GetImageAnalyzeTasksReq struct {
	*GetImageAnalyzeTasksQuery
	*GetImageAnalyzeTasksBody
}

type GetImageAnalyzeTasksRes added in v1.0.140

type GetImageAnalyzeTasksRes struct {

	// REQUIRED
	ResponseMetadata *GetImageAnalyzeTasksResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageAnalyzeTasksResResult `json:"Result"`
}

type GetImageAnalyzeTasksResResponseMetadata added in v1.0.140

type GetImageAnalyzeTasksResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageAnalyzeTasksResResult added in v1.0.140

type GetImageAnalyzeTasksResResult struct {

	// REQUIRED; 任务
	Tasks []*GetImageAnalyzeTasksResResultTasksItem `json:"Tasks"`

	// REQUIRED; 查询到任务数量
	Total int `json:"Total"`
}

type GetImageAnalyzeTasksResResultTasksItem added in v1.0.140

type GetImageAnalyzeTasksResResultTasksItem struct {

	// REQUIRED; 评估任务更新时间
	UpdateAt string `json:"UpdateAt"`

	// 评估任务创建时间
	CreateAt string `json:"CreateAt,omitempty"`

	// 任务描述
	Desc string `json:"Desc,omitempty"`

	// 是否模拟模板每阶段输出,取值如下所示:
	// * true:是
	// * false:否
	EvalPerStage bool `json:"EvalPerStage,omitempty"`

	// 离线评估任务名称
	Name string `json:"Name,omitempty"`

	// txt 评估文件的 Store URI。
	ResURI     []string `json:"ResUri,omitempty"`
	SampleRate float64  `json:"SampleRate,omitempty"`

	// 所在服务的服务 ID
	ServiceID string `json:"ServiceId,omitempty"`

	// 任务状态,取值如下所示:
	// * Pending:排队中
	// * Done:已完成
	// * Running:进行中
	Status string `json:"Status,omitempty"`

	// 该条评估任务的任务 ID
	TaskID string `json:"TaskId,omitempty"`

	// Type 取值 UriFile 时,指定的模版名称。
	Tpl string `json:"Tpl,omitempty"`

	// 任务类型,取值如下所示:
	// * UrlFile:在线提交 URL 离线评估
	// * UriFile:在线提交 URI 离线评估
	Type string `json:"Type,omitempty"`
}

type GetImageAuditResult added in v1.0.122

type GetImageAuditResult struct{}

type GetImageAuditResultBody added in v1.0.140

type GetImageAuditResultBody struct{}

type GetImageAuditResultQuery added in v1.0.140

type GetImageAuditResultQuery struct {

	// REQUIRED; 任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`

	// 审核建议,缺省情况下返回全部任务。取值如下所示:
	// * nopass:建议不通过
	// * recheck:建议复审
	AuditSuggestion string `json:"AuditSuggestion,omitempty" query:"AuditSuggestion"`

	// 图片类型,缺省情况下返回全部类型任务。取值如下所示:
	// * problem:问题图片
	// * frozen:冻结图片
	// * fail:审核失败图片
	ImageType string `json:"ImageType,omitempty" query:"ImageType"`

	// 分页条数。取值范围为 (0,100],默认值为 10。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 上一次查询返回的位置标记,作为本次列举的起点信息。默认值为 0。
	Marker int `json:"Marker,omitempty" query:"Marker"`

	// 问题类型,取值根据审核类型的不同其取值不同。缺省情况下返回全部类型任务。
	// * 基础安全审核 * govern:涉政
	// * porn:涉黄
	// * illegal:违法违规
	// * terror:涉暴
	//
	//
	// * 智能安全审核 * 图像风险识别 * porn:涉黄,主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别
	// * sensitive1:涉敏1,具体指涉及暴恐风险
	// * sensitive2:涉敏2,具体值涉及政治内容风险
	// * forbidden:违禁,主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别
	// * uncomfortable:引人不适,主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别
	// * qrcode:二维码,主要适用于识别常见二维码(QQ、微信、其他二维码等)
	// * badpicture:不良画面,主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别
	// * sexy:性感低俗,主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别
	// * age:年龄,主要适用于图中人物对应的年龄段识别
	// * underage:未成年相关,主要适用于儿童色情、儿童邪典等风险识别
	// * quality:图片质量,主要适用于图片模糊、纯色边框、纯色屏等风险识别
	//
	//
	// * 图文风险识别 * ad:广告,综合图像及文字内容智能识别广告
	// * defraud:诈骗,综合图像及文字内容智能识别诈骗
	// * charillegal:文字违规,图片上存在涉黄、涉敏、违禁等违规文字
	Problem string `json:"Problem,omitempty" query:"Problem"`

	// 审核场景,缺省情况下查询全部场景的任务。取值如下所示:
	// * UrlFile:上传 txt 审核文件处理场景
	// * Url:上传审核图片 URL 处理场景
	// * Upload:图片上传场景
	Type string `json:"Type,omitempty" query:"Type"`
}

type GetImageAuditResultReq added in v1.0.118

type GetImageAuditResultReq struct {
	*GetImageAuditResultQuery
	*GetImageAuditResultBody
}

type GetImageAuditResultRes added in v1.0.140

type GetImageAuditResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageAuditResultResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageAuditResultResResult `json:"Result"`
}

type GetImageAuditResultResResponseMetadata added in v1.0.140

type GetImageAuditResultResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageAuditResultResResult added in v1.0.140

type GetImageAuditResultResResult struct {

	// REQUIRED; 是否还有更多任务,取值如下所示:
	// * true:是,还有其他任务未列举
	// * false:否,已列举所有任务
	HaveMore bool `json:"HaveMore"`

	// REQUIRED; 任务结果
	Results []*GetImageAuditResultResResultResultsItem `json:"Results"`
}

type GetImageAuditResultResResultResultsItem added in v1.0.140

type GetImageAuditResultResResultResultsItem struct {

	// 该任务的审核能力。取值如下所示:
	// * 0:基础审核能力
	// * 1:智能审核能力
	Ability int `json:"Ability,omitempty"`

	// 审核建议,取值如下所示:
	// * nopass:建议不通过
	// * recheck:建议复审
	AuditSuggestion string `json:"AuditSuggestion,omitempty"`

	// 审核结束时间
	EndAt string `json:"EndAt,omitempty"`

	// 条目 ID
	EntryID string `json:"EntryId,omitempty"`

	// 错误信息
	ErrMsg string `json:"ErrMsg,omitempty"`

	// 审核结果,取值如下所示:
	// * problem:问题图片
	// * frozen:冻结图片
	// * fail:审核失败图片
	ImageType string `json:"ImageType,omitempty"`

	// 表示 txt 审核文件的存储 URI。
	ImageURI string `json:"ImageUri,omitempty"`

	// HaveMore取值true时,即本次查询还有未列举到的任务时。Marker作为起始条目位置标记,您需要在下一次查询时传入该值。
	Marker string `json:"Marker,omitempty"`

	// 审核发现图片问题类型
	Problems []string `json:"Problems,omitempty"`

	// 任务 ID
	TaskID string `json:"TaskId,omitempty"`

	// 该任务被指定的审核场景,取值如下所示:
	// * UrlFile:上传 txt 审核文件处理场景
	// * Url:上传审核图片 URL 处理场景
	// * Upload:图片上传场景
	Type string `json:"Type,omitempty"`
}

type GetImageAuditTasks added in v1.0.140

type GetImageAuditTasks struct{}

type GetImageAuditTasksBody added in v1.0.140

type GetImageAuditTasksBody struct{}

type GetImageAuditTasksQuery added in v1.0.140

type GetImageAuditTasksQuery struct {

	// REQUIRED; 审核任务类型,当前仅支持取值为audit。
	TaskType string `json:"TaskType" query:"TaskType"`

	// 审核能力,缺省情况下查询全部审核类型的任务。取值如下所示:
	// * 0:基础审核能力
	// * 1:智能审核能力
	AuditAbility int `json:"AuditAbility,omitempty" query:"AuditAbility"`

	// 分页条数。取值范围为 (0,100],默认值为 100。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 任务地区。仅支持默认取值cn,表示国内。
	Region string `json:"Region,omitempty" query:"Region"`

	// 审核状态,缺省情况下查询全部状态的任务。取值如下所示:
	// * Running:审核中
	// * Suspend:已暂停
	// * Done:已完成
	// * Failed:审核失败
	// * Cancel:已取消
	Status string `json:"Status,omitempty" query:"Status"`

	// 审核场景,缺省情况下查询全部场景的任务。取值如下所示:
	// * UrlFile:上传 txt 审核文件处理场景
	// * Url:上传审核图片 URL 处理场景
	// * Upload:图片上传场景
	Type string `json:"Type,omitempty" query:"Type"`
}

type GetImageAuditTasksReq added in v1.0.118

type GetImageAuditTasksReq struct {
	*GetImageAuditTasksQuery
	*GetImageAuditTasksBody
}

type GetImageAuditTasksRes added in v1.0.140

type GetImageAuditTasksRes struct {

	// REQUIRED
	ResponseMetadata *GetImageAuditTasksResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageAuditTasksResResult `json:"Result"`
}

type GetImageAuditTasksResResponseMetadata added in v1.0.140

type GetImageAuditTasksResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageAuditTasksResResult added in v1.0.140

type GetImageAuditTasksResResult struct {

	// REQUIRED; 审核任务详情
	Tasks []*GetImageAuditTasksResResultTasksItem `json:"Tasks"`

	// REQUIRED; 符合请求的审核任务数量
	Total int `json:"Total"`
}

type GetImageAuditTasksResResultTasksItem added in v1.0.140

type GetImageAuditTasksResResultTasksItem struct {

	// REQUIRED; 该审核任务的更新时间
	UpdateAt string `json:"UpdateAt"`

	// 审核任务
	AuditTask *GetImageAuditTasksResResultTasksItemAuditTask `json:"AuditTask,omitempty"`

	// 该审核任务的创建时间
	CreateAt string `json:"CreateAt,omitempty"`

	// 审核任务 ID
	ID string `json:"Id,omitempty"`

	// 仅当Type值为UrlFile时,有返回值。表示 txt 审核文件的存储 URI。
	ResURI []string `json:"ResUri,omitempty"`

	// 该审核任务所在的服务 ID
	ServiceID string `json:"ServiceId,omitempty"`

	// 该条审核任务的状态,取值如下所示:
	// * Running:审核中
	// * Suspend:已暂停
	// * Done:已完成
	// * Failed:审核失败
	// * Cancel:已取消
	Status string `json:"Status,omitempty"`

	// 审核任务类型,当前仅支持取值为 audit。
	TaskType string `json:"TaskType,omitempty"`

	// 审核场景,取值如下所示:
	// * UrlFile:上传 txt 审核文件处理场景
	// * Url:上传审核图片 URL 处理场景
	// * Upload:图片上传场景
	Type string `json:"Type,omitempty"`
}

type GetImageAuditTasksResResultTasksItemAuditTask added in v1.0.140

type GetImageAuditTasksResResultTasksItemAuditTask struct {

	// REQUIRED; 审核能力,取值如下所示:
	// * 0:基础审核能力
	// * 1:智能审核能力
	AuditAbility int `json:"AuditAbility"`

	// REQUIRED; 指定的审核维度
	AuditDimensions []string `json:"AuditDimensions"`

	// REQUIRED; 仅当EnableAuditRange取值1时,有返回值。表示指定审核的目录前缀。
	AuditPrefix []string `json:"AuditPrefix"`

	// REQUIRED; 指定的智能安全审核类型下图片文本审核维度。
	AuditTextDimensions []string `json:"AuditTextDimensions"`

	// REQUIRED; 指定的回调类型
	CallbackDimensions []string `json:"CallbackDimensions"`

	// REQUIRED; 回调图片类型,取值如下所示:
	// * normal:正常图片
	// * problem:问题图片
	// * frozen:冻结图片
	// * fail:审核失败图片
	CallbackImageTypes []string `json:"CallbackImageTypes"`

	// REQUIRED; 指定的回调 URL
	CallbackURL string `json:"CallbackUrl"`

	// REQUIRED; 仅当Type取值Upload时,有返回值。 审核范围,取值如下所示:
	// * 0:不限范围
	// * 1:指定范围
	EnableAuditRange int `json:"EnableAuditRange"`

	// REQUIRED; 是否开启回调,取值如下所示:
	// * true:开启
	// * false:不开启
	EnableCallback bool `json:"EnableCallback"`

	// REQUIRED; 是否开启冻结,取值如下所示:
	// * true:开启
	// * false:不开启
	EnableFreeze bool `json:"EnableFreeze"`

	// REQUIRED; 是否开启大图审核,取值如下所示:
	// * true:开启
	// * false:不开启
	EnableLargeImageDetect bool `json:"EnableLargeImageDetect"`

	// REQUIRED; 审核失败的图片数量
	FailedCount int `json:"FailedCount"`

	// REQUIRED; 指定的冻结维度
	FreezeDimensions []string `json:"FreezeDimensions"`

	// REQUIRED; 冻结策略,当前仅支持取0,表示禁用图片。
	FreezeStrategy int `json:"FreezeStrategy"`

	// REQUIRED; 指定的冻结措施,取值如下所示:
	// * recheck:建议复审
	// * nopass:审核不通过
	FreezeType []string `json:"FreezeType"`

	// REQUIRED; 仅当 Type 取值 Url 时,有返回值。表示上传的待审核图片 Url 列表详情。
	ImageInfos []*ComponentsDgbrljSchemasGetimageaudittasksresPropertiesResultPropertiesTasksItemsPropertiesAudittaskPropertiesImageinfosItems `json:"ImageInfos"`

	// REQUIRED; 仅当EnableAuditRange取值1时,有返回值。表示指定不审核的目录前缀。
	NoAuditPrefix []string `json:"NoAuditPrefix"`

	// REQUIRED; 审核中的图片数量
	ProcessedNumber int `json:"ProcessedNumber"`

	// REQUIRED; 审核成功的图片数量
	SuccessCount int `json:"SuccessCount"`
}

GetImageAuditTasksResResultTasksItemAuditTask - 审核任务

type GetImageAuthKey added in v1.0.140

type GetImageAuthKey struct{}

type GetImageAuthKeyBody added in v1.0.140

type GetImageAuthKeyBody struct{}

type GetImageAuthKeyQuery added in v1.0.140

type GetImageAuthKeyQuery struct {

	// 服务 ID。 \
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId,omitempty" query:"ServiceId"`
}

type GetImageAuthKeyReq added in v1.0.140

type GetImageAuthKeyReq struct {
	*GetImageAuthKeyQuery
	*GetImageAuthKeyBody
}

type GetImageAuthKeyRes added in v1.0.140

type GetImageAuthKeyRes struct {

	// REQUIRED
	ResponseMetadata *GetImageAuthKeyResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageAuthKeyResResult `json:"Result,omitempty"`
}

type GetImageAuthKeyResResponseMetadata added in v1.0.140

type GetImageAuthKeyResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageAuthKeyResResult added in v1.0.140

type GetImageAuthKeyResResult struct {

	// REQUIRED; 该服务的主鉴权 Key。
	PrimaryKey string `json:"PrimaryKey"`

	// REQUIRED; 该服务的备鉴权 Key。
	SecondaryKey string `json:"SecondaryKey"`

	// REQUIRED; 指定的服务 ID。
	ServiceID string `json:"ServiceId"`
}

GetImageAuthKeyResResult - 视请求的接口而定

type GetImageBgFillResult

type GetImageBgFillResult struct{}

type GetImageBgFillResultBody added in v1.0.140

type GetImageBgFillResultBody struct {

	// REQUIRED; 填充模型,取值如下所示:
	// * 0:国漫风格模型;
	// * 1:通用模型。
	Model int `json:"Model"`

	// REQUIRED; 服务ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待填充原图的存储 URI 和 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 向下填充比例,取值范围为 [0, 0.4]。
	Bottom float64 `json:"Bottom,omitempty"`

	// 向左填充比例,取值范围为 [0, 0.4]。
	Left float64 `json:"Left,omitempty"`

	// 向右填充比例,取值范围为 [0, 0.4]。
	Right float64 `json:"Right,omitempty"`

	// 向上填充比例,取值范围为 [0, 0.4]。
	Top float64 `json:"Top,omitempty"`
}

type GetImageBgFillResultQuery added in v1.0.140

type GetImageBgFillResultQuery struct{}

type GetImageBgFillResultReq added in v1.0.140

type GetImageBgFillResultReq struct {
	*GetImageBgFillResultQuery
	*GetImageBgFillResultBody
}

type GetImageBgFillResultRes added in v1.0.140

type GetImageBgFillResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageBgFillResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageBgFillResultResResult `json:"Result,omitempty"`
}

type GetImageBgFillResultResResponseMetadata added in v1.0.140

type GetImageBgFillResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageBgFillResultResResult added in v1.0.140

type GetImageBgFillResultResResult struct {

	// REQUIRED; 填充结果图的 URI。
	ResURI string `json:"ResUri"`
}

GetImageBgFillResultResResult - 视请求的接口而定

type GetImageComicResult

type GetImageComicResult struct{}

type GetImageComicResultBody added in v1.0.140

type GetImageComicResultBody struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待处理原图的存储 URI 和 URL(可公网访问的 URL)。
	StoreURI string `json:"StoreUri"`
}

type GetImageComicResultQuery added in v1.0.140

type GetImageComicResultQuery struct{}

type GetImageComicResultReq added in v1.0.140

type GetImageComicResultReq struct {
	*GetImageComicResultQuery
	*GetImageComicResultBody
}

type GetImageComicResultRes added in v1.0.140

type GetImageComicResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageComicResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageComicResultResResult `json:"Result,omitempty"`
}

type GetImageComicResultResResponseMetadata added in v1.0.140

type GetImageComicResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageComicResultResResult added in v1.0.140

type GetImageComicResultResResult struct {

	// REQUIRED; 结果图存储 URI。
	ResURI string `json:"ResUri"`
}

GetImageComicResultResResult - 视请求的接口而定

type GetImageContentBlockList added in v1.0.140

type GetImageContentBlockList struct{}

type GetImageContentBlockListBody added in v1.0.140

type GetImageContentBlockListBody struct {

	// 结束查询时间,unix 时间戳,单位为秒。
	EndTime int `json:"EndTime,omitempty"`

	// 按时间排序,取值如下所示:
	// * asc:正序
	// * desc:逆序
	Order string `json:"Order,omitempty"`

	// 页码,系统将仅返回该页面上的任务。默认值为 1。
	PageNum int `json:"PageNum,omitempty"`

	// 每页最大记录数,取值范围是[10,1000]。默认值为 100。
	PageSize int `json:"PageSize,omitempty"`

	// 开始查询时间,unix 时间戳,单位为秒。
	StartTime int `json:"StartTime,omitempty"`

	// 资源更新状态,取值如下所示:
	// * submitting:提交中
	// * running:执行中
	// * succeed:成功
	// * failed:失败
	State string `json:"State,omitempty"`

	// 指定 URL,缺省情况下查询当前服务所有禁用任务列表。
	URL string `json:"Url,omitempty"`
}

type GetImageContentBlockListQuery added in v1.0.140

type GetImageContentBlockListQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageContentBlockListRes added in v1.0.140

type GetImageContentBlockListRes struct {

	// REQUIRED
	ResponseMetadata *GetImageContentBlockListResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; 视请求的接口而定
	Result *GetImageContentBlockListResResult `json:"Result"`
}

type GetImageContentBlockListResResponseMetadata added in v1.0.140

type GetImageContentBlockListResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageContentBlockListResResult added in v1.0.140

type GetImageContentBlockListResResult struct {

	// REQUIRED; 具体数据
	Data []*GetImageContentBlockListResResultDataItem `json:"Data"`

	// REQUIRED; 当前页码
	PageNum int `json:"PageNum"`

	// REQUIRED; 每页最大记录数
	PageSize int `json:"PageSize"`

	// REQUIRED; 符合查询条件的总记录数
	Total int `json:"Total"`
}

GetImageContentBlockListResResult - 视请求的接口而定

type GetImageContentBlockListResResultDataItem added in v1.0.140

type GetImageContentBlockListResResultDataItem struct {

	// REQUIRED; 任务的创建时间
	CreateTime int `json:"CreateTime"`

	// REQUIRED; 任务进度
	Process string `json:"Process"`

	// REQUIRED; URL 状态
	State string `json:"State"`

	// REQUIRED; 指定的 URL
	URL string `json:"Url"`
}

type GetImageContentTaskDetail added in v1.0.140

type GetImageContentTaskDetail struct{}

type GetImageContentTaskDetailBody added in v1.0.140

type GetImageContentTaskDetailBody struct {

	// REQUIRED; 待查询任务 ID
	TaskID string `json:"TaskId"`

	// REQUIRED; 内容管理任务类型,取值如下所示:
	// * refresh:刷新任务,包含刷新 URL 和刷新目录。
	// * refresh_url:刷新 URL
	// * block_url:禁用 URL
	// * unblock_url:解禁 URL
	// * preload_url:预热 URL
	// * refresh_dir:目录刷新(支持根目录刷新)
	TaskType string `json:"TaskType"`

	// 查询结束时间,unix 时间戳,单位为秒。
	EndTime int `json:"EndTime,omitempty"`

	// 按时间排序,取值如下所示:
	// * asc:正序
	// * desc:逆序
	Order string `json:"Order,omitempty"`

	// 页码,系统将仅返回该页面上的任务。默认值为 1。
	PageNum int `json:"PageNum,omitempty"`

	// 每页最大记录数,取值范围是[10,1000]。默认值为 100。
	PageSize int `json:"PageSize,omitempty"`

	// 查询开始时间,unix 时间戳,单位为秒。
	StartTime int `json:"StartTime,omitempty"`

	// 内容管理资源状态,取值如下所示:
	// * submitting:提交中
	// * running:执行中
	// * succeed:成功
	// * failed:失败
	State string `json:"State,omitempty"`

	// 资源 URL 或者目录,可精确匹配,取值为空时表示查询全部任务。
	URL string `json:"Url,omitempty"`
}

type GetImageContentTaskDetailQuery added in v1.0.140

type GetImageContentTaskDetailQuery struct{}

type GetImageContentTaskDetailRes added in v1.0.140

type GetImageContentTaskDetailRes struct {

	// REQUIRED
	ResponseMetadata *GetImageContentTaskDetailResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; 视请求的接口而定
	Result *GetImageContentTaskDetailResResult `json:"Result"`
}

type GetImageContentTaskDetailResResponseMetadata added in v1.0.140

type GetImageContentTaskDetailResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageContentTaskDetailResResult added in v1.0.140

type GetImageContentTaskDetailResResult struct {

	// REQUIRED; 具体数据
	Data []*GetImageContentTaskDetailResResultDataItem `json:"Data"`

	// REQUIRED; 当前页码
	PageNum int `json:"PageNum"`

	// REQUIRED; 每页最大记录数
	PageSize int `json:"PageSize"`

	// REQUIRED; 总记录数
	Total int `json:"Total"`
}

GetImageContentTaskDetailResResult - 视请求的接口而定

type GetImageContentTaskDetailResResultDataItem added in v1.0.140

type GetImageContentTaskDetailResResultDataItem struct {

	// REQUIRED; 任务的创建时间
	CreateTime int `json:"CreateTime"`

	// REQUIRED; 任务进度
	Process string `json:"Process"`

	// REQUIRED; 资源任务状态,取值如下所示:
	// * submitting:提交中
	// * running:执行中
	// * succeed:成功
	// * failed:失败
	State string `json:"State"`

	// REQUIRED; 任务 ID
	TaskID string `json:"TaskId"`

	// REQUIRED; 资源任务类型,取值如下所示:
	// * refresh:刷新任务
	// * refresh_url:刷新 URL
	// * block_url:禁用 URL
	// * unblock_url:解禁 URL
	// * preload_url:预热 URL
	// * refresh_dir:目录刷新
	TaskType string `json:"TaskType"`

	// REQUIRED; 任务指定的 URL 或目录
	URL string `json:"Url"`

	// REQUIRED; 任务的更新时间
	UpdateTime int `json:"UpdateTime"`
}

type GetImageDuplicateDetection added in v1.0.140

type GetImageDuplicateDetection struct{}

type GetImageDuplicateDetectionBody added in v1.0.140

type GetImageDuplicateDetectionBody struct {

	// REQUIRED; 需要去重的图片 URL,以英文逗号分割,输入图片格式 PNG,JPEG,支持格式混合输入。
	Urls []string `json:"Urls"`

	// 是否使用异步,支持取值如下所示:
	// * true:使用异步去重
	// * false:不使用异步去重
	Async bool `json:"Async,omitempty"`

	// 当Async取值为true即启用异步时需要添加回调地址,地址使用 POST 请求方式。
	Callback string `json:"Callback,omitempty"`

	// 当Async取值为true即启用异步时,该配置生效。 相似度阈值,系统将对原图中满足该阈值的图片进行分组。取值范围为 [0,1],默认值为 0.84。最多支持两位小数。
	Similarity float64 `json:"Similarity,omitempty"`
}

type GetImageDuplicateDetectionQuery added in v1.0.140

type GetImageDuplicateDetectionQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageDuplicateDetectionReq added in v1.0.140

type GetImageDuplicateDetectionReq struct {
	*GetImageDuplicateDetectionQuery
	*GetImageDuplicateDetectionBody
}

type GetImageDuplicateDetectionRes added in v1.0.140

type GetImageDuplicateDetectionRes struct {

	// REQUIRED
	ResponseMetadata *GetImageDuplicateDetectionResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageDuplicateDetectionResResult `json:"Result,omitempty"`
}

type GetImageDuplicateDetectionResResponseMetadata added in v1.0.140

type GetImageDuplicateDetectionResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageDuplicateDetectionResResult added in v1.0.140

type GetImageDuplicateDetectionResResult struct {

	// 回调地址。
	Callback string `json:"Callback,omitempty"`

	// 分组结果,若输入 2 个以上原图时,将按组返回内容相同的图片,每组的图片个数非固定值。
	Groups map[string][]string `json:"Groups,omitempty"`

	// 图片评分,仅在只上传两张图片并对比时才返回 Score 字段。
	Score string `json:"Score,omitempty"`

	// 异步任务 ID。
	TaskID string `json:"TaskId,omitempty"`
}

GetImageDuplicateDetectionResResult - 视请求的接口而定

type GetImageEnhanceResult

type GetImageEnhanceResult struct{}

type GetImageEnhanceResultBody added in v1.0.140

type GetImageEnhanceResultBody struct {

	// REQUIRED; 增强模型,取值如下所示:
	// * 0:通用模型
	// * 1:低质专清模型
	Model int `json:"Model"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待增强的原图地址的存储 URI 和 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 是否不去压缩失真。Model取值为0时选填,支持以下取值:
	// * true:不进行去压缩失真处理
	// * false:(默认)进行去压缩失真处理
	DisableAr bool `json:"DisableAr,omitempty"`

	// 是否不自适应锐化。Model取值为0时选填,支持以下取值:
	// * true:不进行锐化处理
	// * false:(默认)进行锐化处理
	DisableSharp bool `json:"DisableSharp,omitempty"`
}

type GetImageEnhanceResultQuery added in v1.0.140

type GetImageEnhanceResultQuery struct{}

type GetImageEnhanceResultReq added in v1.0.140

type GetImageEnhanceResultReq struct {
	*GetImageEnhanceResultQuery
	*GetImageEnhanceResultBody
}

type GetImageEnhanceResultRes added in v1.0.140

type GetImageEnhanceResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageEnhanceResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageEnhanceResultResResult `json:"Result,omitempty"`
}

type GetImageEnhanceResultResResponseMetadata added in v1.0.140

type GetImageEnhanceResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageEnhanceResultResResult added in v1.0.140

type GetImageEnhanceResultResResult struct {

	// REQUIRED; 实际执行的增强方法。
	Method string `json:"Method"`

	// REQUIRED; 增强图像的 URI。
	ResURI string `json:"ResUri"`
}

GetImageEnhanceResultResResult - 视请求的接口而定

type GetImageEraseModels added in v1.0.140

type GetImageEraseModels struct{}

type GetImageEraseModelsBody added in v1.0.140

type GetImageEraseModelsBody struct{}

type GetImageEraseModelsQuery added in v1.0.140

type GetImageEraseModelsQuery struct {

	// 模型。默认取值为0。
	// * 0:自动检测并擦除模型列表。
	// * 1:指定区域擦除模型列表。
	Type int `json:"Type,omitempty" query:"Type"`
}

type GetImageEraseModelsReq added in v1.0.140

type GetImageEraseModelsReq struct {
	*GetImageEraseModelsQuery
	*GetImageEraseModelsBody
}

type GetImageEraseModelsRes added in v1.0.140

type GetImageEraseModelsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageEraseModelsResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageEraseModelsResResult `json:"Result,omitempty"`
}

type GetImageEraseModelsResResponseMetadata added in v1.0.140

type GetImageEraseModelsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageEraseModelsResResult added in v1.0.140

type GetImageEraseModelsResResult struct {

	// REQUIRED; 模型列表。
	Models []string `json:"Models"`
}

GetImageEraseModelsResResult - 视请求的接口而定

type GetImageEraseResult

type GetImageEraseResult struct{}

type GetImageEraseResultBody added in v1.0.140

type GetImageEraseResultBody struct {

	// REQUIRED; 修复模型,支持取值如下所示:
	// * 自动检测并擦除类型模型:erasermodelimagex_0.1.0
	// * 指定区域擦除模型: * erasermodelimagex_0.1.0 (推荐)
	// * erasermodelaliab
	Model string `json:"Model"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待修复原图的存储 URI 或 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 指定区域擦除时图片待修复区域。
	// 不填表示自动检测内容并修复,若所选模型不支持自动检测,则直接返回原图。
	BBox []*GetImageEraseResultBodyBBoxItem `json:"BBox,omitempty"`
}

type GetImageEraseResultBodyBBoxItem added in v1.0.140

type GetImageEraseResultBodyBBoxItem struct {

	// REQUIRED; 待修复区域左上角的 X 坐标,取值范围为[0,1]。
	X1 float64 `json:"X1"`

	// REQUIRED; 待修复区域右下角的 X 坐标,取值范围为[0,1]。
	X2 float64 `json:"X2"`

	// REQUIRED; 待修复区域左上角的 Y 坐标,取值范围为[0,1]。
	Y1 float64 `json:"Y1"`

	// REQUIRED; 待修复区域右下角的 Y 坐标,取值范围为[0,1]。
	Y2 float64 `json:"Y2"`
}

type GetImageEraseResultQuery added in v1.0.140

type GetImageEraseResultQuery struct{}

type GetImageEraseResultReq added in v1.0.140

type GetImageEraseResultReq struct {
	*GetImageEraseResultQuery
	*GetImageEraseResultBody
}

type GetImageEraseResultRes added in v1.0.140

type GetImageEraseResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageEraseResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageEraseResultResResult `json:"Result,omitempty"`
}

type GetImageEraseResultResResponseMetadata added in v1.0.140

type GetImageEraseResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageEraseResultResResult added in v1.0.140

type GetImageEraseResultResResult struct {

	// REQUIRED; 修复后结果图的 URI。
	ResURI string `json:"ResUri"`
}

GetImageEraseResultResResult - 视请求的接口而定

type GetImageMigrateTasks added in v1.0.140

type GetImageMigrateTasks struct{}

type GetImageMigrateTasksBody added in v1.0.140

type GetImageMigrateTasksBody struct{}

type GetImageMigrateTasksQuery added in v1.0.140

type GetImageMigrateTasksQuery struct {

	// 分页条数。默认值为 10,最大值为 1000。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移量。默认值为 0,表示从最新一个开始获取。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 任务地区(即任务目标服务的地区),缺省时将返回国内列表。取值如下所示:
	// * cn:国内
	// * va:美东
	// * sg:新加坡
	Region string `json:"Region,omitempty" query:"Region"`

	// 迁移的目标服务 ID。
	ServiceID string `json:"ServiceId,omitempty" query:"ServiceId"`

	// 任务状态,填入多个时使用半角逗号分隔。取值如下所示:
	// * Initial:创建中
	// * Running:运行中
	// * Done:全部迁移完成
	// * Partial:部分迁移完成
	// * Failed:迁移失败
	// * Terminated:中止
	Status string `json:"Status,omitempty" query:"Status"`

	// 任务 ID。
	TaskID string `json:"TaskId,omitempty" query:"TaskId"`

	// 返回任务名称中包含该值的迁移任务信息。
	TaskNamePtn string `json:"TaskNamePtn,omitempty" query:"TaskNamePtn"`
}

type GetImageMigrateTasksReq added in v1.0.140

type GetImageMigrateTasksReq struct {
	*GetImageMigrateTasksQuery
	*GetImageMigrateTasksBody
}

type GetImageMigrateTasksRes added in v1.0.140

type GetImageMigrateTasksRes struct {

	// REQUIRED
	ResponseMetadata *GetImageMigrateTasksResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageMigrateTasksResResult `json:"Result,omitempty"`
}

type GetImageMigrateTasksResResponseMetadata added in v1.0.140

type GetImageMigrateTasksResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageMigrateTasksResResult added in v1.0.140

type GetImageMigrateTasksResResult struct {

	// REQUIRED; 迁移任务列表
	Tasks []*GetImageMigrateTasksResResultTasksItem `json:"Tasks"`

	// REQUIRED; 总任务数
	Total int `json:"Total"`
}

GetImageMigrateTasksResResult - 视请求的接口而定

type GetImageMigrateTasksResResultTasksItem added in v1.0.140

type GetImageMigrateTasksResResultTasksItem struct {

	// REQUIRED; 目标信息
	Dst *GetImageMigrateTasksResResultTasksItemDst `json:"Dst"`

	// REQUIRED; 任务 ID
	ID string `json:"ID"`

	// REQUIRED; 任务名称
	Name string `json:"Name"`

	// REQUIRED; 迁移进度信息
	Progress *GetImageMigrateTasksResResultTasksItemProgress `json:"Progress"`

	// REQUIRED; 运行时长信息
	Run []*GetImageMigrateTasksResResultTasksPropertiesItemsItem `json:"Run"`

	// REQUIRED; 迁移策略
	RunStrategy *GetImageMigrateTasksResResultTasksItemRunStrategy `json:"RunStrategy"`

	// REQUIRED; 源信息
	Source *GetImageMigrateTasksResResultTasksItemSource `json:"Source"`

	// REQUIRED; 任务状态。取值如下所示:
	// * Initial:创建中
	// * Running:运行中
	// * Done:全部迁移完成
	// * Partial:部分迁移完成
	// * Failed:迁移失败
	// * Terminated:中止
	Status string `json:"Status"`

	// REQUIRED; 转码配置
	Transcode *GetImageMigrateTasksResResultTasksItemTranscode `json:"Transcode"`
}

GetImageMigrateTasksResResultTasksItem - 迁移任务列表

type GetImageMigrateTasksResResultTasksItemDst added in v1.0.140

type GetImageMigrateTasksResResultTasksItemDst struct {

	// REQUIRED; 目标 key 前缀
	Prefix string `json:"Prefix"`

	// REQUIRED; 服务 ID
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 服务名称
	ServiceName string `json:"ServiceName"`

	// REQUIRED; 源 Bucket 名称保留规则
	SkipBucket bool `json:"SkipBucket"`

	// REQUIRED; 上传配置。取值如下所示:
	// * 0:直接覆盖同名文件
	// * 1:增加文件名后缀,后缀为 任务 ID
	// * 2:跳过同名文件,即不做迁移
	UploadConf int `json:"UploadConf"`
}

GetImageMigrateTasksResResultTasksItemDst - 目标信息

type GetImageMigrateTasksResResultTasksItemProgress added in v1.0.140

type GetImageMigrateTasksResResultTasksItemProgress struct {

	// REQUIRED; 失败错误码。仅当 Status=Failed 时有值
	ErrCode int `json:"ErrCode"`

	// REQUIRED; 失败原因。仅当 Status=Failed 时有值
	ErrMsg string `json:"ErrMsg"`

	// REQUIRED; 迁移失败文件数
	FailCnt int `json:"FailCnt"`

	// REQUIRED; 迁移成功文件量,单位为 byte
	SuccessAmount int `json:"SuccessAmount"`

	// REQUIRED; 迁移成功文件数
	SuccessCnt int `json:"SuccessCnt"`

	// REQUIRED; 迁移文件总量,单位为 byte
	TotalAmount int `json:"TotalAmount"`

	// REQUIRED; 总文件数
	TotalCnt int `json:"TotalCnt"`
}

GetImageMigrateTasksResResultTasksItemProgress - 迁移进度信息

type GetImageMigrateTasksResResultTasksItemRunStrategy added in v1.0.140

type GetImageMigrateTasksResResultTasksItemRunStrategy struct {

	// REQUIRED; 源下载 QPS 限制。如值不为空,则长度必须为 24,表示一天 24 小时内各小时的 QPS 限制值。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadQPS []int `json:"ReadQps"`

	// REQUIRED; 源下载流量限制。单位为 Byte。如值不为空,则长度必须为24,表示一天 24 小时内各小时的流量限制值。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadRate []int `json:"ReadRate"`
}

GetImageMigrateTasksResResultTasksItemRunStrategy - 迁移策略

type GetImageMigrateTasksResResultTasksItemSource added in v1.0.140

type GetImageMigrateTasksResResultTasksItemSource struct {

	// REQUIRED; ak
	AK string `json:"AK"`

	// REQUIRED; 源 bucket
	Bucket string `json:"Bucket"`

	// REQUIRED; 迁移源云服务商 CDN 域名
	CdnHost string `json:"CdnHost"`

	// REQUIRED; 源 Endpoint
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 迁移前缀列表
	Prefix []string `json:"Prefix"`

	// REQUIRED; 迁移正则表达式列表
	Regex []string `json:"Regex"`

	// REQUIRED; 源 bucket 地区
	Region string `json:"Region"`

	// REQUIRED; sk
	SK string `json:"SK"`

	// REQUIRED; 是否丢弃源 Header,取值如下所示:
	// * true:丢弃源 Header
	// * false:不丢弃源 Header
	SkipHeader bool `json:"SkipHeader"`

	// REQUIRED; 指定迁移结束时间点,为迁移结束当地服务器时间。表示仅迁移该时间段内新增或变更的文件。
	TimeEnd string `json:"TimeEnd"`

	// REQUIRED; 指定迁移开始时间点,为迁移开始当地服务器时间。表示仅迁移该时间段内新增或变更的文件。
	TimeStart string `json:"TimeStart"`

	// REQUIRED; 源服务商
	Vendor string `json:"Vendor"`
}

GetImageMigrateTasksResResultTasksItemSource - 源信息

type GetImageMigrateTasksResResultTasksItemTranscode added in v1.0.140

type GetImageMigrateTasksResResultTasksItemTranscode struct {

	// REQUIRED; 包含透明通道的图片是否编码为降级格式。取值如下所示:
	// * true:降级
	// * false:不降级
	AlphaDemotion bool `json:"AlphaDemotion"`

	// REQUIRED; 降级编码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。
	DemotionFmt string `json:"DemotionFmt"`

	// REQUIRED; 目标转码格式。支持的格式有 png、jpeg、heic、avif、webp、vvic。
	Format string `json:"Format"`

	// REQUIRED; 转码质量参数。对于 PNG 为无损压缩,其他格式下其值越小,压缩率越高,画质越差。
	Quality int `json:"Quality"`
}

GetImageMigrateTasksResResultTasksItemTranscode - 转码配置

type GetImageMigrateTasksResResultTasksPropertiesItemsItem added in v1.0.140

type GetImageMigrateTasksResResultTasksPropertiesItemsItem struct {

	// REQUIRED; 迁移任务结束时间
	DoneAt string `json:"DoneAt"`

	// REQUIRED; 迁移任务开始时间
	StartAt string `json:"StartAt"`
}

type GetImageOCRV2 added in v1.0.140

type GetImageOCRV2 struct{}

type GetImageOCRV2Body added in v1.0.140

type GetImageOCRV2Body struct {

	// REQUIRED; 图片OCR识别场景,取值如下所示:
	// * general:通用场景,用于通用印刷体场景识别文本信息。
	// * license:营业执照场景,用于识别营业执照中社会信用代码等文本信息。
	// * instrument:设备识别场景,用于一些设备显示文字识别。
	// * defect:缺陷检测场景
	// :::warning 当前仅支持识别图片中简体中文和简体英文这两种文本信息。 :::
	Scene string `json:"Scene"`

	// REQUIRED; 待识别图片文件的存储 URI。
	StoreURI string `json:"StoreUri"`

	// 定制化保留字段,如果是正常调用忽略该字段,若为定制化需求则需要和算法开发者对齐调用方式
	Extra *GetImageOCRV2BodyExtra `json:"Extra,omitempty"`

	// 待识别的图片 URL,满足公网可访问。仅当 StoreUri 为空时取值有效,两者都为空时报错。
	ImageURL string `json:"ImageUrl,omitempty"`

	// 待识别的设备名称,仅当 Scene 为 Instrument 时,配置有效。取值如下所示:
	// * freezing-point-tester:冰点仪
	// * brake-fluid-tester:制动液测试仪
	// * thermometer: 温度计
	// * oil-tester:机油仪
	InstrumentName string `json:"InstrumentName,omitempty"`
}

type GetImageOCRV2BodyExtra added in v1.0.140

type GetImageOCRV2BodyExtra struct {

	// 默认为False,不开启Extra
	Enable bool `json:"Enable,omitempty"`

	// 算子的输入参数
	MMServiceInput string `json:"MMServiceInput,omitempty"`

	// 算子名称
	MMServiceName string `json:"MMServiceName,omitempty"`

	// 算子版本
	MMServiceVersion string `json:"MMServiceVersion,omitempty"`
}

GetImageOCRV2BodyExtra - 定制化保留字段,如果是正常调用忽略该字段,若为定制化需求则需要和算法开发者对齐调用方式

type GetImageOCRV2Query added in v1.0.140

type GetImageOCRV2Query struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageOCRV2Req added in v1.0.140

type GetImageOCRV2Req struct {
	*GetImageOCRV2Query
	*GetImageOCRV2Body
}

type GetImageOCRV2Res added in v1.0.140

type GetImageOCRV2Res struct {

	// REQUIRED
	ResponseMetadata *GetImageOCRV2ResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageOCRV2ResResult `json:"Result,omitempty"`
}

type GetImageOCRV2ResResponseMetadata added in v1.0.140

type GetImageOCRV2ResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageOCRV2ResResult added in v1.0.140

type GetImageOCRV2ResResult struct {

	// REQUIRED; 指定的识别场景。
	Scene string `json:"Scene"`

	// 缺陷检测场景识别结果。
	DefectResult []*GetImageOCRV2ResResultDefectResultItem `json:"DefectResult,omitempty"`

	// 定制化保留字段,默认为空 如果输入参数内Extra.Enable设置为True,该字段返回的结果依赖于算子结果
	Extra *GetImageOCRV2ResResultExtra `json:"Extra,omitempty"`

	// 定制化保留字段,默认为空 如果输入参数内Extra.Enable设置为True,该字段返回的结果依赖于算子结果
	ExtraOutput *GetImageOCRV2ResResultExtraOutput `json:"ExtraOutput,omitempty"`

	// 通用场景识别结果。
	GeneralResult []*GetImageOCRV2ResResultGeneralResultItem `json:"GeneralResult,omitempty"`

	// 设备识别场景识别的文本信息。根据您识别设备的不同取值含义分别为:
	// * 当设备为冰点仪时,表示液体冰点温度值,例如44.89。
	//
	//
	// * 当设备为制动液测试仪时,表示制动液含水量程度。例如Middle表示中等。
	//
	//
	// * 当设备为温度计时,表示测量的温度值。例如37.8。
	//
	//
	// * 当设备为机油仪时,表示机油的剩余使用寿命的估计值,例如93.8。
	InstructmentResult string `json:"InstructmentResult,omitempty"`

	// 营业执照场景识别结果。
	LicenseResult map[string]*ComponentsK7Ou2VSchemasGetimageocrv2ResPropertiesResultPropertiesLicenseresultAdditionalproperties `json:"LicenseResult,omitempty"`
}

GetImageOCRV2ResResult - 视请求的接口而定

type GetImageOCRV2ResResultDefectResultItem added in v1.0.140

type GetImageOCRV2ResResultDefectResultItem struct {

	// 识别出的缺陷类别编号,当前仅在取值为 0 时,表示漏油。 :::tip 其他缺陷类别编号识别还在训练增加中。 :::
	ClassLabel int `json:"ClassLabel,omitempty"`

	// 识别出的文本块的坐标位置。
	Location []int `json:"Location,omitempty"`
}

type GetImageOCRV2ResResultExtra added in v1.0.140

type GetImageOCRV2ResResultExtra struct {

	// 算子服务返回的json序列化结果
	Info string `json:"Info,omitempty"`

	// 状态对应信息, 0: 成功 -1: 图片载入失败 -2: 图片检测失败
	Message string `json:"Message,omitempty"`

	// 算子服务处理状态,0: 成功 -1: 图片载入失败 -2: 图片检测失败
	Status int `json:"Status,omitempty"`
}

GetImageOCRV2ResResultExtra - 定制化保留字段,默认为空 如果输入参数内Extra.Enable设置为True,该字段返回的结果依赖于算子结果

type GetImageOCRV2ResResultExtraOutput added in v1.0.140

type GetImageOCRV2ResResultExtraOutput struct {

	// 算子服务返回的结果
	Info interface{} `json:"Info,omitempty"`

	// 状态对应信息, 0: 成功 -1: 图片载入失败 -2: 图片检测失败
	Message string `json:"Message,omitempty"`

	// 算子服务处理状态,0: 成功 -1: 图片载入失败 -2: 图片检测失败
	Status int `json:"Status,omitempty"`
}

GetImageOCRV2ResResultExtraOutput - 定制化保留字段,默认为空 如果输入参数内Extra.Enable设置为True,该字段返回的结果依赖于算子结果

type GetImageOCRV2ResResultGeneralResultItem added in v1.0.140

type GetImageOCRV2ResResultGeneralResultItem struct {

	// REQUIRED; 文本置信度。识别出的内容可信程度,值越大内容越准确。
	Confidence string `json:"Confidence"`

	// REQUIRED; 识别的通用文本信息。
	Content string `json:"Content"`

	// REQUIRED; 文本块的坐标位置。
	Location [][]int `json:"Location"`
}

type GetImagePSDetection added in v1.0.140

type GetImagePSDetection struct{}

type GetImagePSDetectionBody added in v1.0.140

type GetImagePSDetectionBody struct {

	// REQUIRED; 原图的存储 URI。
	ImageURI string `json:"ImageUri"`

	// 调用方法,默认为调用全部方法,若参数不为all,则其他方法仅可选一种。取值如下所示:
	// * all:调用所有方法
	// * ela:误差水平分析方法
	// * na:噪声分析方法
	// * he:基于颜色分布直方图均化的图像增强分析方法
	Method string `json:"Method,omitempty"`
}

type GetImagePSDetectionQuery added in v1.0.140

type GetImagePSDetectionQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImagePSDetectionReq added in v1.0.140

type GetImagePSDetectionReq struct {
	*GetImagePSDetectionQuery
	*GetImagePSDetectionBody
}

type GetImagePSDetectionRes added in v1.0.140

type GetImagePSDetectionRes struct {

	// REQUIRED
	ResponseMetadata *GetImagePSDetectionResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImagePSDetectionResResult `json:"Result,omitempty"`
}

type GetImagePSDetectionResResponseMetadata added in v1.0.140

type GetImagePSDetectionResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImagePSDetectionResResult added in v1.0.140

type GetImagePSDetectionResResult struct {

	// REQUIRED; 误差水平分析方法对应的图片。
	ElaImage string `json:"ElaImage"`

	// REQUIRED; 基于颜色分布直方图均化的图像增强方法对应的图片。
	HeImage string `json:"HeImage"`

	// REQUIRED; 置信度标签,取值如下所示:
	// * 1:正常
	// * 0:高风险
	Label int `json:"Label"`

	// REQUIRED; 噪声分析方法对应的图片。
	NaImage string `json:"NaImage"`

	// REQUIRED; 置信度,取值范围为[0,1]。
	// * 小于 0.3 为 PS 处理图;
	// * 大于 0.7 为真图;
	// * 取值范围为[0.3,0.7]之间的图片则为模型无法判断。
	Score float64 `json:"Score"`
}

GetImagePSDetectionResResult - 视请求的接口而定

type GetImageQuality added in v1.0.140

type GetImageQuality struct{}

type GetImageQualityBody added in v1.0.140

type GetImageQualityBody struct {

	// REQUIRED; 图片存储 Uri 或访问 URL。
	// * 图片 Uri 格式,例如:tos-example/7a7979974.jpeg
	// * 图片 URL 格式,例如:https://example.org/tos-example/7a7979974.jpeg~tplv.png :::tip 若传 URL,必须保证 URL 公网可访问。 :::
	ImageURL string `json:"ImageUrl"`

	// 评估工具,默认选择全部。多个支持的评估工具用逗号隔开,当前支持以下工具:
	// * nr_index
	// * vqscore
	// * advcolor
	// * blockiness
	// * noise
	// * aesmod
	// * blur
	// * cg
	// * contrast
	// * texture
	// * colorfulness
	// * brightness
	// * overexposure
	// * hue
	// * saturation :::tip nr_index 工具支持评估 contrast、brightness 等多个维度。您也可以单独指定各维度,获取指定维度估值。 :::
	VqType string `json:"VqType,omitempty"`
}

type GetImageQualityQuery added in v1.0.140

type GetImageQualityQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageQualityReq added in v1.0.140

type GetImageQualityReq struct {
	*GetImageQualityQuery
	*GetImageQualityBody
}

type GetImageQualityRes added in v1.0.140

type GetImageQualityRes struct {

	// REQUIRED
	ResponseMetadata *GetImageQualityResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageQualityResResult `json:"Result"`
}

type GetImageQualityResResponseMetadata added in v1.0.140

type GetImageQualityResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageQualityResResult added in v1.0.140

type GetImageQualityResResult struct {

	// REQUIRED
	NrScores *GetImageQualityResResultNrScores `json:"NrScores"`

	// REQUIRED
	VqType string `json:"VqType"`
}

type GetImageQualityResResultNrScores added in v1.0.140

type GetImageQualityResResultNrScores struct {

	// REQUIRED
	Advcolor float64 `json:"advcolor"`

	// REQUIRED
	Aesthetic float64 `json:"aesthetic"`

	// REQUIRED
	Blockiness float64 `json:"blockiness"`

	// REQUIRED
	Brightness float64 `json:"brightness"`

	// REQUIRED
	Colorfulness float64 `json:"colorfulness"`

	// REQUIRED
	Contrast float64 `json:"contrast"`

	// REQUIRED
	Hue float64 `json:"hue"`

	// REQUIRED
	Noise float64 `json:"noise"`

	// REQUIRED
	Overexposure float64 `json:"overexposure"`

	// REQUIRED
	Saturation float64 `json:"saturation"`

	// REQUIRED
	Texture float64 `json:"texture"`

	// REQUIRED
	Vqscore float64 `json:"vqscore"`
}

type GetImageService added in v1.0.140

type GetImageService struct{}

type GetImageServiceBody added in v1.0.140

type GetImageServiceBody struct{}

type GetImageServiceQuery added in v1.0.140

type GetImageServiceQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageServiceReq added in v1.0.140

type GetImageServiceReq struct {
	*GetImageServiceQuery
	*GetImageServiceBody
}

type GetImageServiceRes added in v1.0.140

type GetImageServiceRes struct {

	// REQUIRED
	ResponseMetadata *GetImageServiceResResponseMetadata `json:"ResponseMetadata"`
	Result           *GetImageServiceResResult           `json:"Result,omitempty"`
}

type GetImageServiceResResponseMetadata added in v1.0.140

type GetImageServiceResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageServiceResResult added in v1.0.140

type GetImageServiceResResult struct {

	// REQUIRED; 服务的授权 Bucket 列表。
	AllowBkts []string `json:"AllowBkts"`

	// REQUIRED; 是否允许配置其他镜像站类型
	AllowMirrorTypes bool `json:"AllowMirrorTypes"`

	// REQUIRED; 是否开启精简 URL,取值如下所示:
	// * true:开启
	// * false:关闭
	CompactURL bool `json:"CompactURL"`

	// REQUIRED; 服务创建时间,即创建时当地服务器时间。
	CreateAt string `json:"CreateAt"`

	// REQUIRED; 绑定域名的相关信息。
	DomainInfos []*GetImageServiceResResultDomainInfosItem `json:"DomainInfos"`

	// REQUIRED; 服务是否已经配置鉴权 key,取值如下所示:
	// * true:已配置
	// * false:未配置
	HasSigkey bool `json:"HasSigkey"`

	// REQUIRED; 是否开启ImageY
	ImageY bool `json:"ImageY"`

	// REQUIRED; ImageY相关配置(tob 展示)
	ImageYAttribute *GetImageServiceResResultImageYAttribute `json:"ImageYAttribute"`

	// REQUIRED; 镜像回源配置,默认关闭。
	Mirror *GetImageServiceResResultMirror `json:"Mirror"`

	// REQUIRED; 是否开启源地址访问,取值如下所示:
	// * true:开启
	// * false:关闭
	ObjectAccess bool `json:"ObjectAccess"`

	// REQUIRED; 主鉴权 Key。
	PrimaryKey string `json:"PrimaryKey"`

	// REQUIRED; 备鉴权 Key。
	SecondaryKey string `json:"SecondaryKey"`

	// REQUIRED; 指定的服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 服务名称。
	ServiceName string `json:"ServiceName"`

	// REQUIRED; 服务地域,取值如下所示:
	// * cn:中国
	// * va:美东
	// * sg:新加坡
	ServiceRegion string `json:"ServiceRegion"`

	// REQUIRED; 服务状态。状态分为未审核、审核未通过、正常、禁用。 :::tip
	// * 只有服务状态为正常时,该服务才可用。
	// * 如果是其他异常状态,请参考服务管理 [https://www.volcengine.com/docs/508/8086]进行处理。 :::
	ServiceStatus string `json:"ServiceStatus"`

	// REQUIRED; 服务类型,取值如下所示:
	// * StaticRc:素材托管服务
	// * Image:图片处理服务
	ServiceType string `json:"ServiceType"`

	// REQUIRED; 资源配置。
	Storage *GetImageServiceResResultStorage `json:"Storage"`

	// REQUIRED; 该服务的图片模板固定前缀。
	TemplatePrefix string `json:"TemplatePrefix"`
	AllowVolcTos   bool   `json:"AllowVolcTos,omitempty"`

	// 内部服务创建人
	Creator string `json:"Creator,omitempty"`

	// 事件通知规则
	EventRules []*GetImageServiceResResultEventRulesItem `json:"EventRules,omitempty"`

	// 内部服务安全保密等级 'L1' | 'L2' | 'L3' | 'L4' | 'L5'
	PrivacyLevel string `json:"PrivacyLevel,omitempty"`

	// 服务绑定的项目。仅对ToB账号请求生效,默认default
	ProjectName string `json:"ProjectName,omitempty"`

	// 服务绑定的标签。仅ToB账号有值
	ResourceTags []*GetImageServiceResResultResourceTagsItem `json:"ResourceTags,omitempty"`

	// 用于保护「数据加密密钥」的密钥,只有加密上传的图片需要做处理时需要申请
	RsaPublicKey string `json:"RsaPublicKey,omitempty"`

	// 内部服务内容安全负责人
	SecurityContact string `json:"SecurityContact,omitempty"`

	// 内部服务服务树节点
	ServiceTreeNodeID string `json:"ServiceTreeNodeId,omitempty"`

	// 是否开启覆盖上传,取值如下所示:
	// * true:开启
	// * false:关闭
	UploadOverwrite bool `json:"UploadOverwrite,omitempty"`

	// 绑定的点播空间信息
	VodSpace     *GetImageServiceResResultVodSpace     `json:"VodSpace,omitempty"`
	VolTosBucket *GetImageServiceResResultVolTosBucket `json:"VolTosBucket,omitempty"`

	// 内部使用 元数据写入ODM可便于数据鉴权、溯源
	WriteOdm bool `json:"WriteOdm,omitempty"`
}

type GetImageServiceResResultDomainInfosItem added in v1.0.140

type GetImageServiceResResultDomainInfosItem struct {

	// REQUIRED; 域名解析到的 cname。
	CNAME string `json:"CNAME"`

	// REQUIRED; 绑定的域名。
	DomainName string `json:"DomainName"`

	// REQUIRED; 是否是默认域名,取值如下所示:
	// * true:默认域名
	// * false:非默认域名
	IsDefault bool `json:"IsDefault"`

	// REQUIRED; 域名状态。
	Status string `json:"Status"`
}

type GetImageServiceResResultEventRulesItem added in v1.0.140

type GetImageServiceResResultEventRulesItem struct {

	// REQUIRED; 事件触发时接收回调的回调 URL。
	CallbackURL string `json:"CallbackUrl"`

	// REQUIRED; 规则是否被启用,取值如下所示:
	// * true:是
	// * false:否
	Enable bool `json:"Enable"`

	// REQUIRED; 事件类型。取值如下所示:
	// * Upload:上传文件
	// * Delete:删除文件
	// * Mirror:镜像回源
	// * Migrate:数据迁移
	// * OffTrans:离线转码(仅图像处理服务可配置)
	// * TplStore:模板持久化存储(仅图像处理服务可配置)
	EventType []string `json:"EventType"`

	// REQUIRED; 规则 ID
	ID string `json:"Id"`

	// REQUIRED; 匹配规则的正则表达式。
	MatchRule string `json:"MatchRule"`
}

type GetImageServiceResResultImageYAttribute added in v1.0.140

type GetImageServiceResResultImageYAttribute struct {

	// REQUIRED; 是否开启原图保护
	ResourceProtect bool `json:"ResourceProtect"`

	// REQUIRED; 样式分割符
	StyleSeparators []string `json:"StyleSeparators"`
}

GetImageServiceResResultImageYAttribute - ImageY相关配置(tob 展示)

type GetImageServiceResResultMirror added in v1.0.140

type GetImageServiceResResultMirror struct {

	// REQUIRED; 镜像回源下载原图时,携带的 HTTP 头部,键值都为 String 类型。
	Headers map[string]string `json:"Headers"`

	// REQUIRED; 镜像回源域名。
	Host string `json:"Host"`

	// REQUIRED; 带权重回源域名,key 为 String 类型时,代表镜像回源域名;value 为 Integer 类型时,代表域名权重。
	Hosts map[string]int `json:"Hosts"`

	// REQUIRED; 镜像源站
	Origin *GetImageServiceResResultMirrorOrigin `json:"Origin"`

	// REQUIRED; 下载图片的协议,支持取值:http、https。
	Schema string `json:"Schema"`

	// REQUIRED; 镜像源 URI,其中图片名用 %s 占位符替代,比如/obj/%s。
	Source string `json:"Source"`
}

GetImageServiceResResultMirror - 镜像回源配置,默认关闭。

type GetImageServiceResResultMirrorOrigin added in v1.0.140

type GetImageServiceResResultMirrorOrigin struct {

	// REQUIRED; 镜像源站参数
	Param interface{} `json:"Param"`

	// REQUIRED; 镜像源站类型
	Type string `json:"Type"`
}

GetImageServiceResResultMirrorOrigin - 镜像源站

type GetImageServiceResResultResourceTagsItem added in v1.0.140

type GetImageServiceResResultResourceTagsItem struct {

	// REQUIRED; 标签键
	Key string `json:"Key"`

	// REQUIRED; 标签值
	Value string `json:"Value"`
}

type GetImageServiceResResultStorage added in v1.0.140

type GetImageServiceResResultStorage struct {

	// REQUIRED; 是否支持任意文件格式上传,取值如下所示:
	// * true:支持
	// * false:不支持
	AllTypes bool `json:"AllTypes"`

	// REQUIRED; 存储 Bucket 名称。
	BktName string `json:"BktName"`

	// REQUIRED; 保存时间,单位为秒。
	TTL int `json:"TTL"`
}

GetImageServiceResResultStorage - 资源配置。

type GetImageServiceResResultVodSpace added in v1.0.140

type GetImageServiceResResultVodSpace struct {

	// REQUIRED; 底层存储名
	Bucket string `json:"Bucket"`

	// REQUIRED; 空间所在地区
	Region string `json:"Region"`

	// REQUIRED; 空间名
	SpaceName string `json:"SpaceName"`
}

GetImageServiceResResultVodSpace - 绑定的点播空间信息

type GetImageServiceResResultVolTosBucket added in v1.0.140

type GetImageServiceResResultVolTosBucket struct {

	// REQUIRED; 绑定存储桶名称
	Name string `json:"Name"`

	// REQUIRED
	Region string `json:"Region"`
}

type GetImageServiceSubscription added in v1.0.140

type GetImageServiceSubscription struct{}

type GetImageServiceSubscriptionBody added in v1.0.140

type GetImageServiceSubscriptionBody struct{}

type GetImageServiceSubscriptionQuery added in v1.0.140

type GetImageServiceSubscriptionQuery struct{}

type GetImageServiceSubscriptionReq added in v1.0.140

type GetImageServiceSubscriptionReq struct {
	*GetImageServiceSubscriptionQuery
	*GetImageServiceSubscriptionBody
}

type GetImageServiceSubscriptionRes added in v1.0.140

type GetImageServiceSubscriptionRes struct {

	// REQUIRED
	ResponseMetadata *GetImageServiceSubscriptionResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageServiceSubscriptionResResult `json:"Result"`
}

type GetImageServiceSubscriptionResResponseMetadata added in v1.0.140

type GetImageServiceSubscriptionResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string                                               `json:"Version"`
	Error   *GetImageServiceSubscriptionResResponseMetadataError `json:"Error,omitempty"`
}

type GetImageServiceSubscriptionResResponseMetadataError added in v1.0.140

type GetImageServiceSubscriptionResResponseMetadataError struct {

	// REQUIRED; 错误码
	Code string `json:"Code"`

	// REQUIRED; 错误信息
	Message string `json:"Message"`
}

type GetImageServiceSubscriptionResResult added in v1.0.140

type GetImageServiceSubscriptionResResult struct {

	// REQUIRED; 账号ID
	AccountID string `json:"AccountId"`

	// REQUIRED; 生效开始时间
	BeginTime string `json:"BeginTime"`

	// REQUIRED; 0 未运行 1 运行中 2 创建中 3 更配中 4 续费中 5 退订中
	BusinessStatus int `json:"BusinessStatus"`

	// REQUIRED; 购买的商品配置
	Configuration string `json:"Configuration"`

	// REQUIRED; 生效结束时间
	ExpiredTime string `json:"ExpiredTime"`

	// REQUIRED; 开通后的实例ID
	InstanceID string `json:"InstanceId"`

	// REQUIRED; 实例类型:1:正式,2:试用
	InstanceType int `json:"InstanceType"`

	// REQUIRED; 购买的商品
	Product string `json:"Product"`

	// REQUIRED; 实例状态:0 创建中;1 运行中;2 创建失败;3 已退订;4 到期关停;5 到期回收
	Status int `json:"Status"`
}

type GetImageSmartCropResult

type GetImageSmartCropResult struct{}

type GetImageSmartCropResultBody added in v1.0.140

type GetImageSmartCropResultBody struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待处理原图的存储 URI 和 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 图片裁剪后的高度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。
	Height int `json:"Height,omitempty"`

	// 降级策略,即当智能裁剪失败时的操作,默认居中裁剪。
	// 支持取值如下:
	// * center:居中裁剪,默认裁剪中间图片;
	// * top:居上裁剪,默认裁剪上方图片;
	// * fglass:高斯模糊,将按设置宽高自动适配图片,结果图多出原图部分以原图背景高斯模糊效果填充。
	Policy string `json:"Policy,omitempty"`

	// 裁剪场景 (normal,cartoon),默认普通人脸裁剪。支持取值如下:
	// * normal:普通人脸裁剪;
	// * cartoon:动漫人脸裁剪。 :::tip 当前仅支持了智能人脸裁剪能力,其他裁剪能力在持续开放中,敬请期待。 :::
	Scene string `json:"Scene,omitempty"`

	// 当Policy取值为fglass时的高斯模糊参数,取值为大于 0 的整数,值越大越模糊。
	Sigma float64 `json:"Sigma,omitempty"`

	// 图片裁剪后的宽度设置,单位为 px。当图片小于设置的宽高时,将不被裁剪。
	Width int `json:"Width,omitempty"`
}

type GetImageSmartCropResultQuery added in v1.0.140

type GetImageSmartCropResultQuery struct{}

type GetImageSmartCropResultReq added in v1.0.140

type GetImageSmartCropResultReq struct {
	*GetImageSmartCropResultQuery
	*GetImageSmartCropResultBody
}

type GetImageSmartCropResultRes added in v1.0.140

type GetImageSmartCropResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageSmartCropResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageSmartCropResultResResult `json:"Result,omitempty"`
}

type GetImageSmartCropResultResResponseMetadata added in v1.0.140

type GetImageSmartCropResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageSmartCropResultResResult added in v1.0.140

type GetImageSmartCropResultResResult struct {

	// REQUIRED; 是否降级。支持取值如下:
	// * true:降级;
	// * flase:未降级。
	Demotioned bool `json:"Demotioned"`

	// REQUIRED; 结果图存储 URI。
	ResURI string `json:"ResUri"`
}

GetImageSmartCropResultResResult - 视请求的接口而定

type GetImageStorageFiles added in v1.0.140

type GetImageStorageFiles struct{}

type GetImageStorageFilesBody added in v1.0.140

type GetImageStorageFilesBody struct{}

type GetImageStorageFilesQuery added in v1.0.140

type GetImageStorageFilesQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 指定目录分隔符,默认值为 /。所有文件名字包含指定的前缀,第一次出现 Delimiter 字符之间的文件作为一组元素(即 CommonPrefixe)。
	Delimiter string `json:"Delimiter,omitempty" query:"Delimiter"`

	// 一次查询列出的文件信息条目数,取值范围为[1,1000]。默认值为 10。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 上一次列举返回的位置标记,作为本次列举的起点信息。默认值为空。
	Marker string `json:"Marker,omitempty" query:"Marker"`

	// 指定需要查询文件的前缀,只有资源名匹配该前缀的文件会被列出。缺省时将返回所有文件信息。
	// 例如,一个存储服务中有三个文件,分别为 Example/imagex.png、Example/mov/a.avis 和 Example/mov/b.avis。若指定 Prefix 取值 Example/且指定 Delimiter 取值 /:则返回
	// Example/imagex.png,并在 CommonPrefix 里返回 Example/mov/。
	Prefix string `json:"Prefix,omitempty" query:"Prefix"`
}

type GetImageStorageFilesReq added in v1.0.140

type GetImageStorageFilesReq struct {
	*GetImageStorageFilesQuery
	*GetImageStorageFilesBody
}

type GetImageStorageFilesRes added in v1.0.140

type GetImageStorageFilesRes struct {

	// REQUIRED
	ResponseMetadata *GetImageStorageFilesResResponseMetadata `json:"ResponseMetadata"`
	Result           *GetImageStorageFilesResResult           `json:"Result,omitempty"`
}

type GetImageStorageFilesResResponseMetadata added in v1.0.140

type GetImageStorageFilesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageStorageFilesResResult added in v1.0.140

type GetImageStorageFilesResResult struct {

	// REQUIRED; 是否还有更多文件
	HasMore bool `json:"HasMore"`

	// REQUIRED; 文件列表
	Items []*GetImageStorageFilesResResultItemsItem `json:"Items"`

	// 当前遍历目录包含的目录名称,对于子目录,需要递归列举
	CommonPrefix []string `json:"CommonPrefix,omitempty"`

	// HasMore = true时,下次列举从该Marker开始
	Marker string `json:"Marker,omitempty"`
}

type GetImageStorageFilesResResultItemsItem added in v1.0.140

type GetImageStorageFilesResResultItemsItem struct {

	// REQUIRED; 文件大小,单位字节
	FileSize int `json:"FileSize"`

	// REQUIRED; 文件存储key
	Key string `json:"Key"`

	// REQUIRED; 文件最后修改时间
	LastModified string `json:"LastModified"`

	// REQUIRED; 文件URI
	StoreURI string `json:"StoreUri"`
}

type GetImageStyleResult added in v1.0.140

type GetImageStyleResult struct{}

type GetImageStyleResultBody added in v1.0.140

type GetImageStyleResultBody struct {

	// REQUIRED; 要素属性,结构请参考样式定义 [https://www.volcengine.com/docs/508/127402#%E6%A0%B7%E5%BC%8F%E5%AE%9A%E4%B9%89]。
	// 此参数不为空则使用自定义参数内容替换样式定义中对应 elements [https://www.volcengine.com/docs/508/127402#____elements] 的相关属性值。 :::tip
	// * 要素类型不允许更改;
	// * 若elements和params两个参数同时指定了某个要素的内容,则以elements中指定的为准。 :::
	Elements []interface{} `json:"elements"`

	// REQUIRED; 图片渲染所用样式的样式 ID。获取方法请参见如何获取样式 ID [https://www.volcengine.com/docs/508/105396#如何获取创意魔方的样式-id?]。
	StyleID string `json:"StyleId"`

	// 样式背景,结构请参考样式定义 [https://www.volcengine.com/docs/508/127402#%E6%A0%B7%E5%BC%8F%E5%AE%9A%E4%B9%89]。
	// 此参数不为空则使用自定义参数内容替换样式定义中的 background [https://www.volcengine.com/docs/508/127402#background] 属性值。
	Background interface{} `json:"background,omitempty"`

	// 渲染结果图的编码格式,默认值为 webp。取值如下所示:
	// * jpeg
	// * webp
	// * png
	// * heic
	OutputFormat string `json:"OutputFormat,omitempty"`

	// 渲染结果图的编码质量。默认为 75,取值范围为 [1,100],值越大,结果图的质量越高。
	OutputQuality int `json:"OutputQuality,omitempty"`

	// 样式中的动态要素和要素取值。格式为 "Key":"Value",例如,"el17fbb3a2134*":"Hello,World",
	// * Key:表示要素 ID,String 类型。获取方式请参见如何获取要素 ID [https://www.volcengine.com/docs/508/105396#如何获取创意魔方样式中的动态要素-id?];
	// * Value:表示要素的取值,String 类型。需要您根据实际需求自定义,例如,自定义图片地址、文本及二维码等内容。
	Params map[string]string `json:"Params,omitempty"`
}

type GetImageStyleResultQuery added in v1.0.140

type GetImageStyleResultQuery struct {

	// REQUIRED; 图片渲染所用样式关联的服务的 ID,用于计量计费和渲染结果的存储。获取方式请参见如何获取调用参数 [https://www.volcengine.com/docs/508/105396]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetImageStyleResultReq

type GetImageStyleResultReq struct {
	*GetImageStyleResultQuery
	*GetImageStyleResultBody
}

type GetImageStyleResultRes added in v1.0.140

type GetImageStyleResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageStyleResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageStyleResultResResult `json:"Result,omitempty"`
}

type GetImageStyleResultResResponseMetadata added in v1.0.140

type GetImageStyleResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageStyleResultResResult added in v1.0.140

type GetImageStyleResultResResult struct {

	// REQUIRED; 渲染详情
	RenderDetail []*GetImageStyleResultResResultRenderDetailItem `json:"RenderDetail"`

	// REQUIRED; 渲染结果图的 URI
	ResURI string `json:"ResUri"`
}

GetImageStyleResultResResult - 视请求的接口而定

type GetImageStyleResultResResultRenderDetailItem added in v1.0.140

type GetImageStyleResultResResultRenderDetailItem struct {

	// REQUIRED; 渲染失败的要素 ID
	Element string `json:"Element"`

	// REQUIRED; 渲染失败的原因
	ErrMsg string `json:"ErrMsg"`
}

type GetImageSuperResolutionResult added in v1.0.140

type GetImageSuperResolutionResult struct{}

type GetImageSuperResolutionResultBody added in v1.0.140

type GetImageSuperResolutionResultBody struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待处理原图的存储 URI 和 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 超分倍率,默认为2,取值范围为 [2-8]。
	Multiple float64 `json:"Multiple,omitempty"`
}

type GetImageSuperResolutionResultQuery added in v1.0.140

type GetImageSuperResolutionResultQuery struct{}

type GetImageSuperResolutionResultReq added in v1.0.140

type GetImageSuperResolutionResultReq struct {
	*GetImageSuperResolutionResultQuery
	*GetImageSuperResolutionResultBody
}

type GetImageSuperResolutionResultRes added in v1.0.140

type GetImageSuperResolutionResultRes struct {

	// REQUIRED
	ResponseMetadata *GetImageSuperResolutionResultResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageSuperResolutionResultResResult `json:"Result,omitempty"`
}

type GetImageSuperResolutionResultResResponseMetadata added in v1.0.140

type GetImageSuperResolutionResultResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageSuperResolutionResultResResult added in v1.0.140

type GetImageSuperResolutionResultResResult struct {

	// REQUIRED; 超分图像存储位置。
	ResURI string `json:"ResUri"`
}

GetImageSuperResolutionResultResResult - 视请求的接口而定

type GetImageTemplate added in v1.0.140

type GetImageTemplate struct{}

type GetImageTemplateBody added in v1.0.140

type GetImageTemplateBody struct{}

type GetImageTemplateQuery added in v1.0.140

type GetImageTemplateQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 模板名称。
	// * 您可以通过调用获取服务下所有模板 [https://www.volcengine.com/docs/508/9386]获取所需的模板名称。
	TemplateName string `json:"TemplateName" query:"TemplateName"`
}

type GetImageTemplateReq added in v1.0.140

type GetImageTemplateReq struct {
	*GetImageTemplateQuery
	*GetImageTemplateBody
}

type GetImageTemplateRes added in v1.0.140

type GetImageTemplateRes struct {

	// REQUIRED
	ResponseMetadata *GetImageTemplateResResponseMetadata `json:"ResponseMetadata"`
	Result           *GetImageTemplateResResult           `json:"Result,omitempty"`
}

type GetImageTemplateResResponseMetadata added in v1.0.140

type GetImageTemplateResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageTemplateResResult added in v1.0.140

type GetImageTemplateResResult struct {

	// REQUIRED; 模板计划使用的降级格式,仅对heic静图有效
	DemotionFormat string `json:"DemotionFormat"`

	// REQUIRED; 该模板计划使用的输出格式
	OutputFormat string `json:"OutputFormat"`

	// REQUIRED; 绝对质量/相对质量
	QualityMode string `json:"QualityMode"`

	// REQUIRED; 服务id
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 是否同步处理,仅对heic图有效
	Sync string `json:"Sync"`

	// REQUIRED; 模板名称,必须使用该服务的图片模板固定前缀,具体参考GetImageService接口的返回参数TemplatePrefix。模板名称能包含的字符正则集合为[a-zA-Z0-9_-]
	TemplateName string `json:"TemplateName"`

	// 图像格式自适应配置
	AdaptiveFmt *GetImageTemplateResResultAdaptiveFmt `json:"AdaptiveFmt,omitempty"`

	// 视频转动图配置
	Animation *GetImageTemplateResResultAnimation `json:"Animation,omitempty"`

	// 是否直接更新模板。如果为true,已有的线上模板会同步更新,直接生效;如果为false,会新增一个模板,已有模板不受影响。
	DoUpdate bool `json:"DoUpdate,omitempty"`

	// 对图片的编辑操作
	Filters []*GetImageTemplateResResultFiltersItem `json:"Filters,omitempty"`

	// 对图片编码使用的质量参数,默认为0
	OuputQuality float64 `json:"OuputQuality,omitempty"`

	// 用于图片服务输出时的图片编码
	OutputExtra *GetImageTemplateResResultOutputExtra `json:"OutputExtra,omitempty"`

	// 图片模板使用的参数列表,URL中下发参数的顺序需要跟列表中的保持一致
	Parameters []string `json:"Parameters,omitempty"`

	// URL的失效期,为Unix时间戳,一般配置为通过模板参数下发
	ReqDeadline string `json:"ReqDeadline,omitempty"`

	// 视频截帧配置
	Snapshot *GetImageTemplateResResultSnapshot `json:"Snapshot,omitempty"`

	// 是否开启鉴权,一般当通过模板参数下发敏感信息时,比如文字水印内容、URL失效期,需要对图片URL鉴权保护,防止内容被篡改
	WithSig bool `json:"WithSig,omitempty"`
}

type GetImageTemplateResResultAdaptiveFmt added in v1.0.140

type GetImageTemplateResResultAdaptiveFmt struct {

	// REQUIRED; 动图自适应,可选"webp"/"heic"/"avif"/"dynamic"
	Animated string `json:"Animated"`

	// REQUIRED; 静图自适应,可选"webp"/"heic"/"avif"/"dynamic"
	Static string `json:"Static"`
}

GetImageTemplateResResultAdaptiveFmt - 图像格式自适应配置

type GetImageTemplateResResultAnimation added in v1.0.140

type GetImageTemplateResResultAnimation struct {

	// REQUIRED; 降级类型: image:抽取一帧降级返回 video:直接返回原视频降级
	DemotionType string `json:"DemotionType"`

	// REQUIRED; 动图时长(ms)
	Duration int `json:"Duration"`

	// REQUIRED; 帧率,1秒X帧
	FramePerSecond int `json:"FramePerSecond"`

	// REQUIRED; X秒1帧
	SecondPerFrame int `json:"SecondPerFrame"`

	// REQUIRED; 抽帧策略: fps:frame per second,1秒X帧 spf:second per frame,X秒1帧 key:抽取关键帧
	SelectFrameMode string `json:"SelectFrameMode"`

	// REQUIRED; 动图起始时间戳(ms)
	StartTime int `json:"StartTime"`

	// REQUIRED; 同步等待时长(s),超时未完成则根据DemotionType降级
	WaitTime int `json:"WaitTime"`
}

GetImageTemplateResResultAnimation - 视频转动图配置

type GetImageTemplateResResultFiltersItem added in v1.0.140

type GetImageTemplateResResultFiltersItem struct {

	// REQUIRED; 编辑操作的名称
	Name string `json:"Name"`

	// REQUIRED; 编辑操作的参数
	Param interface{} `json:"Param"`
}

type GetImageTemplateResResultOutputExtra added in v1.0.140

type GetImageTemplateResResultOutputExtra struct {

	// REQUIRED; 是否带透明通道编码,"false"/"true"
	HeicAlphaReserve string `json:"heic.alpha.reserve"`

	// REQUIRED; heic位深,"8"/"10"
	HeicEncodeDepth string `json:"heic.encode.depth"`

	// REQUIRED; heic格式是否开启ROI编码"true"/"false"
	HeicRoi string `json:"heic.roi"`

	// REQUIRED; heic缩略图比例
	HeicThumbRatio string `json:"heic.thumb.ratio"`

	// REQUIRED; 是否采用jpeg渐进编码格式,取值为"true" / "false"
	JPEGProgressive string `json:"jpeg.progressive"`

	// REQUIRED; 是否压缩颜色空间,取值为"true" / "false"
	PNGUseQuant string `json:"png.use_quant"`
}

GetImageTemplateResResultOutputExtra - 用于图片服务输出时的图片编码

type GetImageTemplateResResultSnapshot added in v1.0.140

type GetImageTemplateResResultSnapshot struct {

	// REQUIRED; 截图的时间戳(ms)
	TimeOffsetMs string `json:"TimeOffsetMs"`

	// REQUIRED; 截图类型,可选"default"/"offset",智能截图和指定时间戳截图
	Type string `json:"Type"`
}

GetImageTemplateResResultSnapshot - 视频截帧配置

type GetImageTranscodeDetails added in v1.0.140

type GetImageTranscodeDetails struct{}

type GetImageTranscodeDetailsBody added in v1.0.140

type GetImageTranscodeDetailsBody struct{}

type GetImageTranscodeDetailsQuery added in v1.0.140

type GetImageTranscodeDetailsQuery struct {

	// REQUIRED; 任务提交的截止 Unix 时间戳StartTime与EndTime时间间隔最大不超过 7 天。
	EndTime int `json:"EndTime" query:"EndTime"`

	// REQUIRED; 分页条数,取值范围为(0, 100]。
	Limit int `json:"Limit" query:"Limit"`

	// REQUIRED; 队列 ID,您可通过调用GetImageTranscodeQueues [https://www.volcengine.com/docs/508/1107341]获取该账号下全部任务队列 ID。
	QueueID string `json:"QueueId" query:"QueueId"`

	// REQUIRED; 任务提交的起始 Unix 时间戳StartTime与EndTime时间间隔最大不超过 7 天。
	StartTime int `json:"StartTime" query:"StartTime"`

	// 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 队列所在地区。默认当前地区。ToB取值枚举:cn、va、sg。
	Region string `json:"Region,omitempty" query:"Region"`

	// 返回图片 url 或 uri 中包含该值的任务。默认为空,不传则返回所有任务。
	SearchPtn string `json:"SearchPtn,omitempty" query:"SearchPtn"`

	// 执行状态,填入多个时使用英文逗号分隔。取值如下所示:
	// * Pending:排队中
	// * Running:执行中
	// * Success:执行成功
	// * Fail:执行失败
	Status string `json:"Status,omitempty" query:"Status"`
}

type GetImageTranscodeDetailsReq added in v1.0.140

type GetImageTranscodeDetailsReq struct {
	*GetImageTranscodeDetailsQuery
	*GetImageTranscodeDetailsBody
}

type GetImageTranscodeDetailsRes added in v1.0.140

type GetImageTranscodeDetailsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageTranscodeDetailsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageTranscodeDetailsResResult `json:"Result"`
}

type GetImageTranscodeDetailsResResponseMetadata added in v1.0.140

type GetImageTranscodeDetailsResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageTranscodeDetailsResResult added in v1.0.140

type GetImageTranscodeDetailsResResult struct {

	// REQUIRED; 执行任务详情
	ExecInfo []*GetImageTranscodeDetailsResResultExecInfoItem `json:"ExecInfo"`

	// REQUIRED; 总数
	Total int `json:"Total"`
}

type GetImageTranscodeDetailsResResultExecInfoItem added in v1.0.140

type GetImageTranscodeDetailsResResultExecInfoItem struct {

	// 结束时间
	EndAt string `json:"EndAt,omitempty"`

	// 执行条目 ID
	EntryID string `json:"EntryId,omitempty"`

	// 执行输入
	ExecInput *GetImageTranscodeDetailsResResultExecInfoItemExecInput `json:"ExecInput,omitempty"`

	// 执行输出
	ExecOutput *GetImageTranscodeDetailsResResultExecInfoItemExecOutput `json:"ExecOutput,omitempty"`

	// 开始时间
	StartAt string `json:"StartAt,omitempty"`

	// 执行状态。取值如下所示:
	// * Pending:排队中
	// * Running:执行中
	// * Success:执行成功
	// * Fail:执行失败
	Status string `json:"Status,omitempty"`

	// 提交时间
	SubmitAt string `json:"SubmitAt,omitempty"`
}

type GetImageTranscodeDetailsResResultExecInfoItemExecInput added in v1.0.140

type GetImageTranscodeDetailsResResultExecInfoItemExecInput struct {

	// REQUIRED; 图片 url 或 uri
	Image string `json:"Image"`

	// REQUIRED; 转码模板
	Template string `json:"Template"`
}

GetImageTranscodeDetailsResResultExecInfoItemExecInput - 执行输入

type GetImageTranscodeDetailsResResultExecInfoItemExecOutput added in v1.0.140

type GetImageTranscodeDetailsResResultExecInfoItemExecOutput struct {

	// REQUIRED; 转码失败错误码 [https://www.volcengine.com/docs/508/1104726#%E9%94%99%E8%AF%AF%E7%A0%81]。仅当Status值为Fail时,ErrCode有值。
	ErrCode string `json:"ErrCode"`

	// REQUIRED; 转码失败错误信息。仅当Status值为Fail时,ErrMsg有值。
	ErrMsg string `json:"ErrMsg"`

	// REQUIRED; 转码结果图格式
	Format string `json:"Format"`

	// REQUIRED; 转码结果图的存储 URI。仅当Status值为Success时,Output有值。
	Output string `json:"Output"`

	// REQUIRED; 转码结果图大小,单位为 byte
	Size int `json:"Size"`
}

GetImageTranscodeDetailsResResultExecInfoItemExecOutput - 执行输出

type GetImageTranscodeQueues added in v1.0.140

type GetImageTranscodeQueues struct{}

type GetImageTranscodeQueuesBody added in v1.0.140

type GetImageTranscodeQueuesBody struct{}

type GetImageTranscodeQueuesQuery added in v1.0.140

type GetImageTranscodeQueuesQuery struct {

	// REQUIRED; 分页条数,取值范围为(0,100]。
	Limit int `json:"Limit" query:"Limit"`

	// 分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 队列所在地区。默认当前地区。ToB取值枚举:cn、va、sg。
	Region string `json:"Region,omitempty" query:"Region"`

	// 返回队列名称或队列描述中包含该值的队列。默认为空,不传则返回所有队列。
	SearchPtn string `json:"SearchPtn,omitempty" query:"SearchPtn"`
}

type GetImageTranscodeQueuesReq added in v1.0.140

type GetImageTranscodeQueuesReq struct {
	*GetImageTranscodeQueuesQuery
	*GetImageTranscodeQueuesBody
}

type GetImageTranscodeQueuesRes added in v1.0.140

type GetImageTranscodeQueuesRes struct {

	// REQUIRED
	ResponseMetadata *GetImageTranscodeQueuesResResponseMetadata `json:"ResponseMetadata"`

	// title
	Result *GetImageTranscodeQueuesResResult `json:"Result,omitempty"`
}

type GetImageTranscodeQueuesResResponseMetadata added in v1.0.140

type GetImageTranscodeQueuesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageTranscodeQueuesResResult added in v1.0.140

type GetImageTranscodeQueuesResResult struct {

	// REQUIRED; 当前分页队列详细信息
	Queues []*GetImageTranscodeQueuesResResultQueuesItem `json:"Queues"`

	// REQUIRED; 符合条件的队列总数
	Total int `json:"Total"`
}

GetImageTranscodeQueuesResResult - title

type GetImageTranscodeQueuesResResultQueuesItem added in v1.0.140

type GetImageTranscodeQueuesResResultQueuesItem struct {

	// REQUIRED; 队列回调设置
	CallbackConf *GetImageTranscodeQueuesResResultQueuesItemCallbackConf `json:"CallbackConf"`

	// REQUIRED; 队列创建时间
	CreateAt string `json:"CreateAt"`

	// REQUIRED; 队列描述
	Desc string `json:"Desc"`

	// REQUIRED; 是否启用回调,取值如下所示:
	// * true:启用
	// * false:不启用
	EnableCallback bool `json:"EnableCallback"`

	// REQUIRED; 队列 ID
	ID string `json:"Id"`

	// REQUIRED; 队列名称
	Name string `json:"Name"`

	// REQUIRED; 队列状态。取值如下所示:
	// * Pending:排队中
	// * Running:执行中
	Status GetImageTranscodeQueuesResResultQueuesItemStatus `json:"Status"`

	// REQUIRED; 队列类型。取值如下所示:
	// * default:表示账号默认队列,每个账号一个
	// * user:表示用户创建队列,个数将有配额限制
	Type GetImageTranscodeQueuesResResultQueuesItemType `json:"Type"`
}

type GetImageTranscodeQueuesResResultQueuesItemCallbackConf added in v1.0.140

type GetImageTranscodeQueuesResResultQueuesItemCallbackConf struct {

	// REQUIRED; 回调数据格式。取值如下所示:
	// * XML
	// * JSON
	DataFormat string `json:"DataFormat"`

	// REQUIRED; Method=MQ时取值rmq:{topic}/{cluster}
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 枚举值还有 MQ
	Method string `json:"Method"`

	// 业务自定义回调参数,将在回调消息的callback_args中透传出去。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/1104726#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	Args string `json:"Args,omitempty"`
}

GetImageTranscodeQueuesResResultQueuesItemCallbackConf - 队列回调设置

type GetImageTranscodeQueuesResResultQueuesItemStatus added in v1.0.140

type GetImageTranscodeQueuesResResultQueuesItemStatus string

type GetImageTranscodeQueuesResResultQueuesItemType added in v1.0.140

type GetImageTranscodeQueuesResResultQueuesItemType string

type GetImageUpdateFiles added in v1.0.140

type GetImageUpdateFiles struct{}

type GetImageUpdateFilesBody added in v1.0.140

type GetImageUpdateFilesBody struct{}

type GetImageUpdateFilesQuery added in v1.0.140

type GetImageUpdateFilesQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 获取 URL 个数,最大值为 100。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移,默认 0。 当取值为 1 时,表示跳过一条 URL,从第二条 URL 开始取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 获取类型,取值如下所示:
	// * 0:获取刷新 URL 列表;
	// * 1:获取禁用 URL 列表。
	Type int `json:"Type,omitempty" query:"Type"`

	// URL 格式,若指定 URL 格式则仅返回 URL 中包含该字符串的 URL 列表。 默认为空,缺省情况下返回所有 URL 列表。
	URLPattern string `json:"UrlPattern,omitempty" query:"UrlPattern"`
}

type GetImageUpdateFilesReq added in v1.0.140

type GetImageUpdateFilesReq struct {
	*GetImageUpdateFilesQuery
	*GetImageUpdateFilesBody
}

type GetImageUpdateFilesRes added in v1.0.140

type GetImageUpdateFilesRes struct {

	// REQUIRED
	ResponseMetadata *GetImageUpdateFilesResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageUpdateFilesResResult `json:"Result,omitempty"`
}

type GetImageUpdateFilesResResponseMetadata added in v1.0.140

type GetImageUpdateFilesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageUpdateFilesResResult added in v1.0.140

type GetImageUpdateFilesResResult struct {

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 当前存储状态,取值为:正常、未审核、禁用。
	Status string `json:"Status"`

	// REQUIRED; 符合条件的 URL 总数
	Total int `json:"Total"`

	// REQUIRED; 符合条件的 URL 列表。
	UpdateUrls []*GetImageUpdateFilesResResultUpdateUrlsItem `json:"UpdateUrls"`
}

GetImageUpdateFilesResResult - 视请求的接口而定

type GetImageUpdateFilesResResultUpdateUrlsItem added in v1.0.140

type GetImageUpdateFilesResResultUpdateUrlsItem struct {

	// REQUIRED; 图片 URL。
	ImageURL string `json:"ImageUrl"`

	// REQUIRED; URL 更新时间,即图像更新时的服务器当地时间。
	UpdateAt string `json:"UpdateAt"`
}

type GetImageUploadFile added in v1.0.140

type GetImageUploadFile struct{}

type GetImageUploadFileBody added in v1.0.140

type GetImageUploadFileBody struct{}

type GetImageUploadFileQuery added in v1.0.140

type GetImageUploadFileQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 文件 Uri。
	// * 您可以在 veImageX 控制台资源管理 [https://console.volcengine.com/imagex/resource_manage/]页面,在已上传文件的名称列获取资源 Uri。
	// * 您也可以通过 OpenAPI 的方式获取Uri,具体请参考文件上传完成上报 [https://www.volcengine.com/docs/508/9398]。
	StoreURI string `json:"StoreUri" query:"StoreUri"`
}

type GetImageUploadFileReq added in v1.0.140

type GetImageUploadFileReq struct {
	*GetImageUploadFileQuery
	*GetImageUploadFileBody
}

type GetImageUploadFileRes added in v1.0.140

type GetImageUploadFileRes struct {

	// REQUIRED
	ResponseMetadata *GetImageUploadFileResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetImageUploadFileResResult `json:"Result,omitempty"`
}

type GetImageUploadFileResResponseMetadata added in v1.0.140

type GetImageUploadFileResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageUploadFileResResult added in v1.0.140

type GetImageUploadFileResResult struct {

	// 文件字节数。
	FileSize int `json:"FileSize,omitempty"`

	// 文件修改时间,即文件修改时的服务器当地时间。
	LastModified string `json:"LastModified,omitempty"`

	// 服务 ID。
	ServiceID string `json:"ServiceId,omitempty"`

	// 底层存储的content-type值
	StorageContentType string `json:"StorageContentType,omitempty"`

	// 文件 Uri。
	StoreURI string `json:"StoreUri,omitempty"`
}

GetImageUploadFileResResult - 视请求的接口而定

type GetImageUploadFiles added in v1.0.140

type GetImageUploadFiles struct{}

type GetImageUploadFilesBody added in v1.0.140

type GetImageUploadFilesBody struct{}

type GetImageUploadFilesQuery added in v1.0.140

type GetImageUploadFilesQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 获取文件个数,最大值为 100。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页标志。
	Marker int `json:"Marker,omitempty" query:"Marker"`
}

type GetImageUploadFilesReq added in v1.0.140

type GetImageUploadFilesReq struct {
	*GetImageUploadFilesQuery
	*GetImageUploadFilesBody
}

type GetImageUploadFilesRes added in v1.0.140

type GetImageUploadFilesRes struct {

	// REQUIRED
	ResponseMetadata *GetImageUploadFilesResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageUploadFilesResResult `json:"Result"`
}

type GetImageUploadFilesResResponseMetadata added in v1.0.140

type GetImageUploadFilesResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type GetImageUploadFilesResResult added in v1.0.140

type GetImageUploadFilesResResult struct {

	// REQUIRED; 上传文件信息。
	FileObjects []*GetImageUploadFilesResResultFileObjectsItem `json:"FileObjects"`

	// REQUIRED; 是否还有下页数据。
	HasMore bool `json:"hasMore"`

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 当前存储状态,取值为:正常、未审核、禁用。
	Status string `json:"Status"`
}

type GetImageUploadFilesResResultFileObjectsItem added in v1.0.140

type GetImageUploadFilesResResultFileObjectsItem struct {

	// 文件字节数。
	FileSize int `json:"FileSize,omitempty"`

	// 文件修改时间,文件修改时的服务器当地时间。
	LastModified string `json:"LastModified,omitempty"`

	// 分页标志。
	Marker int `json:"Marker,omitempty"`

	// 文件 Uri。
	StoreURI string `json:"StoreUri,omitempty"`
}

type GetImageXQueryApps added in v1.0.140

type GetImageXQueryApps struct{}

type GetImageXQueryAppsBody added in v1.0.140

type GetImageXQueryAppsBody struct{}

type GetImageXQueryAppsQuery added in v1.0.140

type GetImageXQueryAppsQuery struct {

	// 数据来源,账号下近 60 天内有数据上报的应用 ID,缺省情况下返回账号对应的全部应用 ID。
	// * upload:上传 1.0 数据。
	// * cdn:下行网络数据。
	// * client:客户端数据。
	// * sensible:感知数据。
	// * uploadv2:上传 2.0 数据。
	// * exceed:大图监控数据。
	Source string `json:"Source,omitempty" query:"Source"`
}

type GetImageXQueryAppsReq

type GetImageXQueryAppsReq struct {
	*GetImageXQueryAppsQuery
	*GetImageXQueryAppsBody
}

type GetImageXQueryAppsRes added in v1.0.140

type GetImageXQueryAppsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageXQueryAppsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageXQueryAppsResResult `json:"Result"`
}

type GetImageXQueryAppsResResponseMetadata added in v1.0.140

type GetImageXQueryAppsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageXQueryAppsResResult added in v1.0.140

type GetImageXQueryAppsResResult struct {

	// REQUIRED; 火山引擎账号内的所有 App 信息。
	Apps []*GetImageXQueryAppsResResultAppsItem `json:"Apps"`
}

type GetImageXQueryAppsResResultAppsItem added in v1.0.140

type GetImageXQueryAppsResResultAppsItem struct {

	// REQUIRED; 应用 ID。
	AppID string `json:"AppId"`

	// REQUIRED; 应用名称。
	AppName string `json:"AppName"`

	// REQUIRED; App 所属地区。 cn:国内。 va:美东。 sg:新加坡。
	AppRegion string `json:"AppRegion"`

	// REQUIRED; App 绑定的 iOS 包名。
	BundleID string `json:"BundleId"`

	// REQUIRED; App 绑定的安卓包名。
	PackageName string `json:"PackageName"`
}

type GetImageXQueryDims added in v1.0.140

type GetImageXQueryDims struct{}

type GetImageXQueryDimsBody added in v1.0.140

type GetImageXQueryDimsBody struct{}

type GetImageXQueryDimsQuery added in v1.0.140

type GetImageXQueryDimsQuery struct {

	// REQUIRED; 数据来源。
	// * upload:上传 1.0 数据。
	// * cdn:下行网络数据。
	// * client:客户端数据。
	// * sensible:感知数据。
	// * uploadv2:上传 2.0 数据。
	// * exceed:大图监控数据。
	Source string `json:"Source" query:"Source"`

	// 应用 ID。默认为空,匹配账号下所有的 App ID。 :::tip 您可以通过调用获取应用列表 [https://www.volcengine.com/docs/508/19511]的方式获取所需的 AppID。 :::
	Appid string `json:"Appid,omitempty" query:"Appid"`

	// 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:
	// * iOS
	// * Android
	// * WEB
	OS string `json:"OS,omitempty" query:"OS"`
}

type GetImageXQueryDimsReq

type GetImageXQueryDimsReq struct {
	*GetImageXQueryDimsQuery
	*GetImageXQueryDimsBody
}

type GetImageXQueryDimsRes added in v1.0.140

type GetImageXQueryDimsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageXQueryDimsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageXQueryDimsResResult `json:"Result"`
}

type GetImageXQueryDimsResResponseMetadata added in v1.0.140

type GetImageXQueryDimsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageXQueryDimsResResult added in v1.0.140

type GetImageXQueryDimsResResult struct {

	// REQUIRED; 上报数据中出现的维度信息。
	Dim []string `json:"Dim"`
}

type GetImageXQueryRegions added in v1.0.140

type GetImageXQueryRegions struct{}

type GetImageXQueryRegionsBody added in v1.0.140

type GetImageXQueryRegionsBody struct{}

type GetImageXQueryRegionsQuery added in v1.0.140

type GetImageXQueryRegionsQuery struct {

	// REQUIRED; 数据来源。
	// * upload:上传 1.0 数据。
	// * cdn:下行网络数据。
	// * client:客户端数据。
	// * sensible:感知数据。
	// * uploadv2:上传 2.0 数据。
	// * exceed:大图监控数据。
	Source string `json:"Source" query:"Source"`

	// 应用 ID。默认为空,匹配账号下所有的 App ID。 :::tip 您可以通过调用获取应用列表 [https://www.volcengine.com/docs/508/19511]的方式获取所需的 Appid。 :::
	Appid string `json:"Appid,omitempty" query:"Appid"`

	// 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:
	// * iOS
	// * Android
	// * WEB
	OS string `json:"OS,omitempty" query:"OS"`
}

type GetImageXQueryRegionsReq

type GetImageXQueryRegionsReq struct {
	*GetImageXQueryRegionsQuery
	*GetImageXQueryRegionsBody
}

type GetImageXQueryRegionsRes added in v1.0.140

type GetImageXQueryRegionsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageXQueryRegionsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageXQueryRegionsResResult `json:"Result"`
}

type GetImageXQueryRegionsResResponseMetadata added in v1.0.140

type GetImageXQueryRegionsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageXQueryRegionsResResult added in v1.0.140

type GetImageXQueryRegionsResResult struct {

	// REQUIRED; 60 天内上报数据中出现的海外国家,按出现次数降序排列。
	Country []string `json:"Country"`

	// REQUIRED; 60 天内上报数据中出现的国内省份,按出现次数降序排列。
	Province []string `json:"Province"`
}

type GetImageXQueryVals added in v1.0.140

type GetImageXQueryVals struct{}

type GetImageXQueryValsBody added in v1.0.140

type GetImageXQueryValsBody struct{}

type GetImageXQueryValsQuery added in v1.0.140

type GetImageXQueryValsQuery struct {

	// REQUIRED; 自定义维度名称。 :::tip 您可以通过调用获取自定义维度列表 [https://www.volcengine.com/docs/508/34554]获取所需的维度名称。 :::
	Dim string `json:"Dim" query:"Dim"`

	// REQUIRED; 数据来源。
	// * upload:上传 1.0 数据。
	// * cdn:下行网络数据。
	// * client:客户端数据。
	// * sensible:感知数据。
	// * uploadv2:上传 2.0 数据。
	// * exceed:大图监控数据。
	Source string `json:"Source" query:"Source"`

	// 应用 ID。默认为空,匹配中账号下所有的 App ID。 :::tip 您可以通过调用获取应用列表 [https://www.volcengine.com/docs/508/19511]的方式获取所需的 AppID。 :::
	Appid string `json:"Appid,omitempty" query:"Appid"`

	// 需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:
	// * iOS
	// * Android
	// * WEB
	OS string `json:"OS,omitempty" query:"OS"`
}

type GetImageXQueryValsReq

type GetImageXQueryValsReq struct {
	*GetImageXQueryValsQuery
	*GetImageXQueryValsBody
}

type GetImageXQueryValsRes added in v1.0.140

type GetImageXQueryValsRes struct {

	// REQUIRED
	ResponseMetadata *GetImageXQueryValsResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED
	Result *GetImageXQueryValsResResult `json:"Result"`
}

type GetImageXQueryValsResResponseMetadata added in v1.0.140

type GetImageXQueryValsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetImageXQueryValsResResult added in v1.0.140

type GetImageXQueryValsResResult struct {

	// REQUIRED; 60 天内上报数据中出现的维度值信息,按出现次数降序排列。
	DimVal []string `json:"DimVal"`
}

type GetPrivateImageType added in v1.0.140

type GetPrivateImageType struct{}

type GetPrivateImageTypeBody added in v1.0.140

type GetPrivateImageTypeBody struct {

	// REQUIRED; 原图的存储 URI。
	ImageURI string `json:"ImageUri"`

	// 检测内容,默认为all,取值如下所示:
	// * face:图片内人脸检测
	// * cloth:图片内衣物检测
	// * all:图片内人脸和衣物均检测
	Method string `json:"Method,omitempty"`

	// 衣物置信度,取值范围为[0, 1], 默认值为 0.8,表示高于 0.8 即为有效检测。
	ThresCloth float64 `json:"ThresCloth,omitempty"`

	// 人脸置信度,取值范围为[0, 1], 默认值为 0.52,表示高于 0.52 即为有效检测。
	ThresFace float64 `json:"ThresFace,omitempty"`
}

type GetPrivateImageTypeQuery added in v1.0.140

type GetPrivateImageTypeQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetPrivateImageTypeReq added in v1.0.140

type GetPrivateImageTypeReq struct {
	*GetPrivateImageTypeQuery
	*GetPrivateImageTypeBody
}

type GetPrivateImageTypeRes added in v1.0.140

type GetPrivateImageTypeRes struct {

	// REQUIRED
	ResponseMetadata *GetPrivateImageTypeResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetPrivateImageTypeResResult `json:"Result,omitempty"`
}

type GetPrivateImageTypeResResponseMetadata added in v1.0.140

type GetPrivateImageTypeResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetPrivateImageTypeResResult added in v1.0.140

type GetPrivateImageTypeResResult struct {

	// REQUIRED; 请求参数Method中包含cloth则返回该参数,取值如下所示:
	// * 1: 包含衣物
	// * 0: 不包含衣物
	Cloth int `json:"Cloth"`

	// REQUIRED; 请求参数Method中包含face则返回该参数,取值如下所示:
	// * 1: 包含人脸
	// * 0: 不包含人脸
	Face int `json:"Face"`
}

GetPrivateImageTypeResResult - 视请求的接口而定

type GetResourceURL added in v1.0.140

type GetResourceURL struct{}

type GetResourceURLBody added in v1.0.140

type GetResourceURLBody struct{}

type GetResourceURLQuery added in v1.0.140

type GetResourceURLQuery struct {

	// REQUIRED; 域名。 您可以通过调用 OpenAPI 获取服务下所有域名 [https://www.volcengine.com/docs/508/9379]查看 domain 返回值。
	Domain string `json:"Domain" query:"Domain"`

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 图片资源 Uri。 您可以通过调用 OpenAPI 获取文件上传成功信息 [https://www.volcengine.com/docs/508/9398]查看 ImageUri 返回值。
	URI string `json:"URI" query:"URI"`

	// 创建模板时设置的图片输出格式,默认为 iamge,支持取值有:
	// * image:表示输出原格式;
	// * 静图格式:png、jpeg、heic、avif、webp;
	// * 动图格式:awebp、heif、avis。
	Format string `json:"Format,omitempty" query:"Format"`

	// 协议,默认为 http,隐私图片使用 https,公开图片支持取值 http 以及 https。
	Proto string `json:"Proto,omitempty" query:"Proto"`

	// 过期时长,最大限制为 1 年,默认1800s。
	Timestamp int `json:"Timestamp,omitempty" query:"Timestamp"`

	// 模板名称。缺省情况下表示无模板处理图片。 您可以通过调用 OpenAPI 获取服务下所有图片模板 [https://www.volcengine.com/docs/508/9386]里查看 TemplateName 返回值。
	Tpl string `json:"Tpl,omitempty" query:"Tpl"`
}

type GetResourceURLReq added in v1.0.140

type GetResourceURLReq struct {
	*GetResourceURLQuery
	*GetResourceURLBody
}

type GetResourceURLRes added in v1.0.140

type GetResourceURLRes struct {

	// REQUIRED
	ResponseMetadata *GetResourceURLResResponseMetadata `json:"ResponseMetadata"`
	Result           *GetResourceURLResResult           `json:"Result,omitempty"`
}

type GetResourceURLResResponseMetadata added in v1.0.140

type GetResourceURLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetResourceURLResResult added in v1.0.140

type GetResourceURLResResult struct {

	// REQUIRED; 结果图访问精简地址,与默认地址相比缺少 Bucket 部分。
	CompactURL string `json:"CompactURL"`

	// REQUIRED; 精简源图片地址,与默认地址相比缺少 Bucket 部分。
	ObjCompactURL string `json:"ObjCompactURL"`

	// REQUIRED; 默认源图片地址。
	ObjURL string `json:"ObjURL"`

	// REQUIRED; 结果图访问默认地址。
	URL string `json:"URL"`
}

type GetResponseHeaderValidateKeys added in v1.0.140

type GetResponseHeaderValidateKeys struct{}

type GetResponseHeaderValidateKeysBody added in v1.0.140

type GetResponseHeaderValidateKeysBody struct{}

type GetResponseHeaderValidateKeysQuery added in v1.0.140

type GetResponseHeaderValidateKeysQuery struct{}

type GetResponseHeaderValidateKeysReq added in v1.0.140

type GetResponseHeaderValidateKeysReq struct {
	*GetResponseHeaderValidateKeysQuery
	*GetResponseHeaderValidateKeysBody
}

type GetResponseHeaderValidateKeysRes added in v1.0.140

type GetResponseHeaderValidateKeysRes struct {

	// REQUIRED
	ResponseMetadata *GetResponseHeaderValidateKeysResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetResponseHeaderValidateKeysResResult `json:"Result,omitempty"`
}

type GetResponseHeaderValidateKeysResResponseMetadata added in v1.0.140

type GetResponseHeaderValidateKeysResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetResponseHeaderValidateKeysResResult added in v1.0.140

type GetResponseHeaderValidateKeysResResult struct {

	// REQUIRED; 合法的响应头 key 列表
	ValidateRespHdrKeys []string `json:"ValidateRespHdrKeys"`
}

GetResponseHeaderValidateKeysResResult - 视请求的接口而定

type GetSegmentImage added in v1.0.140

type GetSegmentImage struct{}

type GetSegmentImageBody added in v1.0.140

type GetSegmentImageBody struct {

	// REQUIRED; 图片类型,支持可选择的模型如下。
	// * general:通用模型v1
	// * human:人脸模型v1
	// * product:商品模型v1
	// * humanv2:人脸模型v2
	// * productv2:商品模型v2
	Class string `json:"Class"`

	// REQUIRED; 输出图片格式,取值如下所示:
	// * png
	// * jpeg
	// * webp
	OutFormat string `json:"OutFormat"`

	// REQUIRED; 处理效果,当Class取值为humanv2或productv2时,默认为true。
	// * false:保留的图像主体边缘以粗线条处理,图像处理的效率更高。
	// * true:保留的图像主体边缘以发丝级细线条处理,图像处理后的效果更好。
	Refine bool `json:"Refine"`

	// REQUIRED; 待擦除原图的存储 URI 和 URL(公网可访问的 URL)。
	StoreURI string `json:"StoreUri"`

	// 描边设置,仅当Class取值humanv2或productv2时有效。 默认关闭,如果开启,抠出的结果图中保留的图像主体会外包一圈描边效果。
	Contour *GetSegmentImageBodyContour `json:"Contour,omitempty"`

	// 是否开启透明背景裁剪设置。默认false,关闭状态。如果开启,抠出的结果图会被裁剪到刚好包住保留的图像主体。
	TransBg bool `json:"TransBg,omitempty"`
}

type GetSegmentImageBodyContour added in v1.0.140

type GetSegmentImageBodyContour struct {

	// REQUIRED; 描边颜色,支持以 HEX、HSL、RGP 表示。例如HEX中白色为#FFFFFF。
	Color string `json:"Color"`

	// REQUIRED; 描边宽度,单位为 px。取值范围为 0 到正整数,默认 10px。
	Size int `json:"Size"`
}

GetSegmentImageBodyContour - 描边设置,仅当Class取值humanv2或productv2时有效。 默认关闭,如果开启,抠出的结果图中保留的图像主体会外包一圈描边效果。

type GetSegmentImageQuery added in v1.0.140

type GetSegmentImageQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetSegmentImageReq added in v1.0.140

type GetSegmentImageReq struct {
	*GetSegmentImageQuery
	*GetSegmentImageBody
}

type GetSegmentImageRes added in v1.0.140

type GetSegmentImageRes struct {

	// REQUIRED
	ResponseMetadata *GetSegmentImageResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetSegmentImageResResult `json:"Result,omitempty"`
}

type GetSegmentImageResResponseMetadata added in v1.0.140

type GetSegmentImageResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetSegmentImageResResult added in v1.0.140

type GetSegmentImageResResult struct {

	// REQUIRED; 背景去除后的图片 URI。
	ResURI string `json:"ResUri"`
}

GetSegmentImageResResult - 视请求的接口而定

type GetServiceDomains added in v1.0.140

type GetServiceDomains struct{}

type GetServiceDomainsBody added in v1.0.140

type GetServiceDomainsBody struct{}

type GetServiceDomainsQuery added in v1.0.140

type GetServiceDomainsQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetServiceDomainsReq added in v1.0.140

type GetServiceDomainsReq struct {
	*GetServiceDomainsQuery
	*GetServiceDomainsBody
}

type GetServiceDomainsRes added in v1.0.140

type GetServiceDomainsRes struct {
	ResponseMetadata *GetServiceDomainsResResponseMetadata `json:"ResponseMetadata,omitempty"`
	Result           []*GetServiceDomainsResResultItem     `json:"Result,omitempty"`
}

type GetServiceDomainsResResponseMetadata added in v1.0.140

type GetServiceDomainsResResponseMetadata struct {
	Action    string `json:"Action,omitempty"`
	Region    string `json:"Region,omitempty"`
	RequestID string `json:"RequestId,omitempty"`
	Service   string `json:"Service,omitempty"`
	Version   string `json:"Version,omitempty"`
}

type GetServiceDomainsResResultItem added in v1.0.140

type GetServiceDomainsResResultItem struct {

	// REQUIRED; 域名锁定状态
	LockStatus *GetServiceDomainsResResultItemLockStatus `json:"lock_status"`

	// 指向的 cname 值
	Cname string `json:"cname,omitempty"`

	// 创建时间
	CreateTime float64 `json:"create_time,omitempty"`

	// 域名
	Domain string `json:"domain,omitempty"`

	// HTTPS 配置
	HTTPSConfig *GetServiceDomainsResResultItemHTTPSConfig `json:"https_config,omitempty"`

	// 是否是默认域名,取值如下所示:
	// * true:默认域名
	// * false:非默认域名
	IsDefault bool `json:"is_default,omitempty"`

	// 域名锁定原因
	Reason string `json:"reason,omitempty"`

	// 地域
	Region string `json:"region,omitempty"`

	// 域名状态
	Status string `json:"status,omitempty"`

	// 域名申请人
	User string `json:"user,omitempty"`
}

type GetServiceDomainsResResultItemHTTPSConfig added in v1.0.140

type GetServiceDomainsResResultItemHTTPSConfig struct {

	// REQUIRED; 证书 ID
	CertID string `json:"cert_id"`

	// 是否开启 HTTP2
	EnableHTTP2 bool `json:"enable_http2,omitempty"`
}

GetServiceDomainsResResultItemHTTPSConfig - HTTPS 配置

type GetServiceDomainsResResultItemLockStatus added in v1.0.140

type GetServiceDomainsResResultItemLockStatus struct {

	// REQUIRED; 智能压缩是否锁定,取值如下所示:
	// * true:是
	// * false:否
	CompressionLocked bool `json:"compression_locked"`

	// REQUIRED; 整个域名是否锁定,取值如下所示:
	// * true:是,您无法手动修改其配置。如需修改,请提交工单 [https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000080]联系技术支持。
	// * false:否
	DomainLocked bool `json:"domain_locked"`

	// REQUIRED; IP 访问限制是否锁定,取值如下所示:
	// * true:是
	// * false:否
	IPAccessRuleLocked bool `json:"ip_access_rule_locked"`

	// REQUIRED; Referer 防盗链是否锁定,取值如下所示:
	// * true:是
	// * false:否
	RefererAccessRuleLocked bool `json:"referer_access_rule_locked"`

	// REQUIRED; 远程鉴权是否锁定,取值如下所示:
	// * true:是
	// * false:否
	RemoteAuthLocked bool `json:"remote_auth_locked"`

	// REQUIRED; 响应头是否锁定,取值如下所示:
	// * true:是
	// * false:否
	ResponseHeaderLocked bool `json:"response_header_locked"`

	// REQUIRED; URL 鉴权是否锁定,取值如下所示:
	// * true:是
	// * false:否
	SignURLAuthLocked bool `json:"sign_url_auth_locked"`

	// REQUIRED; UA 访问限制是否锁定,取值如下所示:
	// * true:是
	// * false:否
	UaAccessRuleLocked bool `json:"ua_access_rule_locked"`

	// 域名被锁定原因
	Reason string `json:"reason,omitempty"`
}

GetServiceDomainsResResultItemLockStatus - 域名锁定状态

type GetTemplatesFromBin added in v1.0.140

type GetTemplatesFromBin struct{}

type GetTemplatesFromBinBody added in v1.0.140

type GetTemplatesFromBinBody struct{}

type GetTemplatesFromBinQuery added in v1.0.140

type GetTemplatesFromBinQuery struct {

	// REQUIRED; 服务 ID
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// 是否按照模板创建时间升序查询,支持取值:true、false,默认为false。
	Asc string `json:"Asc,omitempty" query:"Asc"`

	// 分页获取条数,默认 10。
	Limit int `json:"Limit,omitempty" query:"Limit"`

	// 分页偏移。默认 0。取值为1,表示跳过第一条数据,从第二条数据开始取值。
	Offset int `json:"Offset,omitempty" query:"Offset"`

	// 仅返回模板名称包含该字符串的图片模板,不填或者为空则返回所有模板。
	TemplateNamePattern string `json:"TemplateNamePattern,omitempty" query:"TemplateNamePattern"`
}

type GetTemplatesFromBinReq added in v1.0.140

type GetTemplatesFromBinReq struct {
	*GetTemplatesFromBinQuery
	*GetTemplatesFromBinBody
}

type GetTemplatesFromBinRes added in v1.0.140

type GetTemplatesFromBinRes struct {

	// REQUIRED
	ResponseMetadata *GetTemplatesFromBinResResponseMetadata `json:"ResponseMetadata"`
	Result           *GetTemplatesFromBinResResult           `json:"Result,omitempty"`
}

type GetTemplatesFromBinResResponseMetadata added in v1.0.140

type GetTemplatesFromBinResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetTemplatesFromBinResResult added in v1.0.140

type GetTemplatesFromBinResResult struct {

	// REQUIRED; 所有模板信息
	Templates []*GetTemplatesFromBinResResultTemplatesItem `json:"Templates"`

	// REQUIRED; 模板总数。
	Total int `json:"Total"`
}

type GetTemplatesFromBinResResultTemplatesItem added in v1.0.140

type GetTemplatesFromBinResResultTemplatesItem struct {

	// REQUIRED; 模板的摘要信息。
	Abstract []string `json:"Abstract"`

	// REQUIRED; 指定图像自适应配置。
	AdaptiveFmt interface{} `json:"AdaptiveFmt"`

	// REQUIRED; 视频转动图配置。
	Animation interface{} `json:"Animation"`

	// REQUIRED; 模版 JSON 内容。
	Content string `json:"Content"`

	// REQUIRED; 模板创建时间。
	CreateAt string `json:"CreateAt"`

	// REQUIRED; 模版降级格式,仅针对 heic 格式有效。
	DemotionFormat string `json:"DemotionFormat"`

	// REQUIRED; 对图片的编辑操作。
	Filters []*Components8GbgysSchemasGettemplatesfrombinresPropertiesResultPropertiesTemplatesItemsPropertiesFiltersItems `json:"Filters"`

	// REQUIRED; 对图片编码使用的质量参数。
	OuputQuality int `json:"OuputQuality"`

	// REQUIRED; 用于图片服务输出时的图片编码。
	// * 取值png.use_quant表示是否开启 png quant 压缩,取值为true表示开启,取值为false表示关闭;
	// * 取值heic.sync表示使用 heic 同步编码,取值为true表示同步;
	// * 取值heic.timeout表示 heic 同步编码的超时时间,比如 20。
	OutputExtra interface{} `json:"OutputExtra"`

	// REQUIRED; 该模板计划使用的输出图片格式。
	// * 取值为image,表示输出原格式。
	// * 支持输出的静图格式:png、jpeg、heic、avif、webp。
	// * 支持输出的动图格式:awebp、heif、avis。
	OutputFormat string `json:"OutputFormat"`

	// REQUIRED; 图片模板的参数列表,URL 中下发参数的顺序需要跟列表中的保持一致。
	Parameters []string `json:"Parameters"`

	// REQUIRED; URL 的失效期,为 Unix 时间戳。
	ReqDeadline string `json:"ReqDeadline"`

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceID"`

	// REQUIRED; 视频截帧配置。
	Snapshot interface{} `json:"Snapshot"`

	// REQUIRED; 是否同步处理,仅针对 heic 格式有效。
	Sync bool `json:"Sync"`

	// REQUIRED; 模板名称。
	TemplateName string `json:"TemplateName"`

	// REQUIRED; 该模板的使用用例。
	Usage string `json:"Usage"`

	// REQUIRED; 模板是否开启鉴权。
	// * 取值为true,表示开启鉴权。
	// * 取值为false,表示关闭鉴权。
	WithSig bool `json:"WithSig"`
}

type GetURLFetchTask added in v1.0.140

type GetURLFetchTask struct{}

type GetURLFetchTaskBody added in v1.0.140

type GetURLFetchTaskBody struct{}

type GetURLFetchTaskQuery added in v1.0.140

type GetURLFetchTaskQuery struct {

	// REQUIRED; 异步任务 ID,您可通过调用FetchImageUrl [https://www.volcengine.com/docs/508/68807]接口获取该 ID。
	ID string `json:"Id" query:"Id"`

	// REQUIRED
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type GetURLFetchTaskReq added in v1.0.140

type GetURLFetchTaskReq struct {
	*GetURLFetchTaskQuery
	*GetURLFetchTaskBody
}

type GetURLFetchTaskRes added in v1.0.140

type GetURLFetchTaskRes struct {

	// REQUIRED
	ResponseMetadata *GetURLFetchTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetURLFetchTaskResResult `json:"Result,omitempty"`
}

type GetURLFetchTaskResResponseMetadata added in v1.0.140

type GetURLFetchTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetURLFetchTaskResResult added in v1.0.140

type GetURLFetchTaskResResult struct {

	// REQUIRED; 异步任务 ID
	ID string `json:"Id"`

	// REQUIRED; 任务状态,取值如下所示:
	// * Running:进行中
	// * Pending:排队中
	// * Failed:失败
	// * Success:成功
	Status string `json:"Status"`

	// REQUIRED; 资源下载链接
	URL string `json:"Url"`

	// 传入的回调地址,仅当Status取值Failed时有返回值。
	Callback string `json:"Callback,omitempty"`

	// 传入的回调内容,仅当Status取值Failed时有返回值。
	CallbackBody string `json:"CallbackBody,omitempty"`

	// 传入的回调内容类型,仅当Status取值Failed时有返回值。
	CallbackBodyType string `json:"CallbackBodyType,omitempty"`

	// 错误码,仅当Status取值Failed时有返回值。
	Code int `json:"Code,omitempty"`

	// 动图持续时间,单位为 ms。
	Duration int `json:"Duration,omitempty"`

	// 任务完成时间戳,UTC 时间,单位为 s。
	EndTime int `json:"EndTime,omitempty"`

	// 错误信息,仅当Status取值Failed时有返回值。
	Err string `json:"Err,omitempty"`

	// 资源大小,单位为 byte。
	FSize int `json:"FSize,omitempty"`

	// 动图帧数
	FrameCnt int `json:"FrameCnt,omitempty"`

	// 图片类型
	ImageFormat string `json:"ImageFormat,omitempty"`

	// 图片高
	ImageHeight int `json:"ImageHeight,omitempty"`

	// 图片宽
	ImageWidth int `json:"ImageWidth,omitempty"`

	// 任务开始时间戳,UTC 时间,单位为 s。
	StartTime int `json:"StartTime,omitempty"`

	// 资源上传后的资源 URI
	StoreURI string `json:"StoreUri,omitempty"`

	// 完成任务总耗时,单位为 ms。
	TimeCost int `json:"TimeCost,omitempty"`
}

GetURLFetchTaskResResult - 视请求的接口而定

type GetVendorBuckets added in v1.0.140

type GetVendorBuckets struct{}

type GetVendorBucketsBody added in v1.0.140

type GetVendorBucketsBody struct {

	// REQUIRED; Access Key。是与 Secret Key 同时填写的,为了保证有访问源数据桶的权限。
	AK string `json:"AK"`

	// REQUIRED; S3 协议 Endpoint,需以http://或https://开头。仅当Vendor为S3时必填。
	Endpoint string `json:"Endpoint"`

	// REQUIRED; Secret Key。是与 Access Key 同时填写的,为了保证有访问源数据桶的权限。
	SK string `json:"SK"`

	// REQUIRED; 服务商。取值如下所示:
	// * OSS:阿里云
	// * COS:腾讯云
	// * KODO:七牛云
	// * BOS:百度云
	// * OBS:华为云
	// * Ucloud:Ucloud file
	// * AWS:AWS 国际站
	// * S3:其他 S3 协议存储
	// * URL:以上传 URL 列表的方式迁移
	Vendor string `json:"Vendor"`

	// Bucket 所在地区。仅当Vendor非URL/OSS/KODO/AWS时为必填。
	Region string `json:"Region,omitempty"`
}

type GetVendorBucketsQuery added in v1.0.140

type GetVendorBucketsQuery struct{}

type GetVendorBucketsReq added in v1.0.140

type GetVendorBucketsReq struct {
	*GetVendorBucketsQuery
	*GetVendorBucketsBody
}

type GetVendorBucketsRes added in v1.0.140

type GetVendorBucketsRes struct {

	// REQUIRED
	ResponseMetadata *GetVendorBucketsResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *GetVendorBucketsResResult `json:"Result,omitempty"`
}

type GetVendorBucketsResResponseMetadata added in v1.0.140

type GetVendorBucketsResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type GetVendorBucketsResResult added in v1.0.140

type GetVendorBucketsResResult struct {

	// REQUIRED; bucket 列表
	Buckets []string `json:"Buckets"`
}

GetVendorBucketsResResult - 视请求的接口而定

type ImageInfo

type ImageInfo struct {
	FileName    string `json:"FileName"`
	ImageUri    string `json:"ImageUri"`
	ImageWidth  int    `json:"ImageWidth"`
	ImageHeight int    `json:"ImageHeight"`
	ImageMd5    string `json:"ImageMd5"`
	ImageFormat string `json:"ImageFormat"`
	ImageSize   int    `json:"ImageSize"`
	FrameCnt    int    `json:"FrameCnt"`
	Duration    int    `json:"Duration"`
}

type ImageX

type ImageX struct {
	*common.Client
}

func NewInstance

func NewInstance() *ImageX

func NewInstanceWithRegion

func NewInstanceWithRegion(region string) *ImageX

func (*ImageX) ApplyImageUpload added in v1.0.140

func (c *ImageX) ApplyImageUpload(ctx context.Context, arg *ApplyImageUploadQuery) (*ApplyImageUploadRes, error)

func (*ImageX) ApplyUploadImage

func (c *ImageX) ApplyUploadImage(params *ApplyUploadImageParam) (*ApplyUploadImageResult, error)

ApplyImageUpload 获取图片上传地址

func (*ImageX) CommitImageUpload added in v1.0.140

func (c *ImageX) CommitImageUpload(ctx context.Context, arg *CommitImageUploadReq) (*CommitImageUploadRes, error)

func (*ImageX) CommitUploadImage

func (c *ImageX) CommitUploadImage(params *CommitUploadImageParam) (*CommitUploadImageResult, error)

CommitImageUpload 图片上传完成上报

func (*ImageX) CreateHiddenWatermarkImage added in v1.0.131

func (c *ImageX) CreateHiddenWatermarkImage(ctx context.Context, arg *CreateHiddenWatermarkImageReq) (*CreateHiddenWatermarkImageRes, error)

func (*ImageX) CreateImageAnalyzeTask added in v1.0.140

func (c *ImageX) CreateImageAnalyzeTask(ctx context.Context, arg *CreateImageAnalyzeTaskBody) (*CreateImageAnalyzeTaskRes, error)

func (*ImageX) CreateImageAuditTask added in v1.0.118

func (c *ImageX) CreateImageAuditTask(ctx context.Context, arg *CreateImageAuditTaskBody) (*CreateImageAuditTaskRes, error)

func (*ImageX) CreateImageCompressTask added in v1.0.110

func (c *ImageX) CreateImageCompressTask(ctx context.Context, arg *CreateImageCompressTaskReq) (*CreateImageCompressTaskRes, error)

func (*ImageX) CreateImageContentTask

func (c *ImageX) CreateImageContentTask(ctx context.Context, arg *CreateImageContentTaskReq) (*CreateImageContentTaskRes, error)

func (*ImageX) CreateImageHmEmbed

func (c *ImageX) CreateImageHmEmbed(ctx context.Context, arg *CreateImageHmEmbedBody) (*CreateImageHmEmbedRes, error)

func (*ImageX) CreateImageHmExtract

func (c *ImageX) CreateImageHmExtract(ctx context.Context, arg *CreateImageHmExtractQuery) (*CreateImageHmExtractRes, error)

func (*ImageX) CreateImageMigrateTask added in v1.0.140

func (c *ImageX) CreateImageMigrateTask(ctx context.Context, arg *CreateImageMigrateTaskBody) (*CreateImageMigrateTaskRes, error)

func (*ImageX) CreateImageRetryAuditTask added in v1.0.118

func (c *ImageX) CreateImageRetryAuditTask(ctx context.Context, arg *CreateImageRetryAuditTaskBody) (*CreateImageRetryAuditTaskRes, error)

func (*ImageX) CreateImageService added in v1.0.140

func (c *ImageX) CreateImageService(ctx context.Context, arg *CreateImageServiceBody) (*CreateImageServiceRes, error)

func (*ImageX) CreateImageTemplate added in v1.0.140

func (c *ImageX) CreateImageTemplate(ctx context.Context, arg *CreateImageTemplateReq) (*CreateImageTemplateRes, error)

func (*ImageX) CreateImageTranscodeCallback added in v1.0.140

func (c *ImageX) CreateImageTranscodeCallback(ctx context.Context, arg *CreateImageTranscodeCallbackBody) (*CreateImageTranscodeCallbackRes, error)

func (*ImageX) CreateImageTranscodeQueue added in v1.0.140

func (c *ImageX) CreateImageTranscodeQueue(ctx context.Context, arg *CreateImageTranscodeQueueBody) (*CreateImageTranscodeQueueRes, error)

func (*ImageX) CreateImageTranscodeTask added in v1.0.140

func (c *ImageX) CreateImageTranscodeTask(ctx context.Context, arg *CreateImageTranscodeTaskBody) (*CreateImageTranscodeTaskRes, error)

func (*ImageX) CreateTemplatesFromBin added in v1.0.140

func (c *ImageX) CreateTemplatesFromBin(ctx context.Context, arg *CreateTemplatesFromBinReq) (*CreateTemplatesFromBinRes, error)

func (*ImageX) DelDomain added in v1.0.140

func (c *ImageX) DelDomain(ctx context.Context, arg *DelDomainReq) (*DelDomainRes, error)

func (*ImageX) DeleteImageAnalyzeTask added in v1.0.140

func (c *ImageX) DeleteImageAnalyzeTask(ctx context.Context, arg *DeleteImageAnalyzeTaskBody) (*DeleteImageAnalyzeTaskRes, error)

func (*ImageX) DeleteImageAnalyzeTaskRun added in v1.0.140

func (c *ImageX) DeleteImageAnalyzeTaskRun(ctx context.Context, arg *DeleteImageAnalyzeTaskRunBody) (*DeleteImageAnalyzeTaskRunRes, error)

func (*ImageX) DeleteImageAuditResult added in v1.0.118

func (c *ImageX) DeleteImageAuditResult(ctx context.Context, arg *DeleteImageAuditResultBody) (*DeleteImageAuditResultRes, error)

func (*ImageX) DeleteImageMigrateTask added in v1.0.140

func (c *ImageX) DeleteImageMigrateTask(ctx context.Context, arg *DeleteImageMigrateTaskQuery) (*DeleteImageMigrateTaskRes, error)

func (*ImageX) DeleteImageService added in v1.0.140

func (c *ImageX) DeleteImageService(ctx context.Context, arg *DeleteImageServiceQuery) (*DeleteImageServiceRes, error)

func (*ImageX) DeleteImageTemplate added in v1.0.140

func (c *ImageX) DeleteImageTemplate(ctx context.Context, arg *DeleteImageTemplateReq) (*DeleteImageTemplateRes, error)

func (*ImageX) DeleteImageTranscodeDetail added in v1.0.140

func (c *ImageX) DeleteImageTranscodeDetail(ctx context.Context, arg *DeleteImageTranscodeDetailBody) (*DeleteImageTranscodeDetailRes, error)

func (*ImageX) DeleteImageTranscodeQueue added in v1.0.140

func (c *ImageX) DeleteImageTranscodeQueue(ctx context.Context, arg *DeleteImageTranscodeQueueBody) (*DeleteImageTranscodeQueueRes, error)

func (*ImageX) DeleteImageUploadFiles added in v1.0.140

func (c *ImageX) DeleteImageUploadFiles(ctx context.Context, arg *DeleteImageUploadFilesReq) (*DeleteImageUploadFilesRes, error)

func (*ImageX) DeleteTemplatesFromBin added in v1.0.140

func (c *ImageX) DeleteTemplatesFromBin(ctx context.Context, arg *DeleteTemplatesFromBinReq) (*DeleteTemplatesFromBinRes, error)

func (*ImageX) DescribeImageXBaseOpUsage

func (c *ImageX) DescribeImageXBaseOpUsage(ctx context.Context, arg *DescribeImageXBaseOpUsageQuery) (*DescribeImageXBaseOpUsageRes, error)

func (*ImageX) DescribeImageXBillingRequestCntUsage added in v1.0.140

func (*ImageX) DescribeImageXBucketUsage

func (c *ImageX) DescribeImageXBucketUsage(ctx context.Context, arg *DescribeImageXBucketUsageQuery) (*DescribeImageXBucketUsageRes, error)

func (*ImageX) DescribeImageXDomainBandwidthNinetyFiveData added in v1.0.140

func (*ImageX) DescribeImageXEdgeRequest

func (c *ImageX) DescribeImageXEdgeRequest(ctx context.Context, arg *DescribeImageXEdgeRequestQuery) (*DescribeImageXEdgeRequestRes, error)

func (*ImageX) DescribeImageXMirrorRequestHTTPCodeByTime added in v1.0.140

func (*ImageX) DescribeImageXMirrorRequestHTTPCodeOverview added in v1.0.140

func (*ImageX) DescribeImageXMultiCompressUsage added in v1.0.140

func (c *ImageX) DescribeImageXMultiCompressUsage(ctx context.Context, arg *DescribeImageXMultiCompressUsageQuery) (*DescribeImageXMultiCompressUsageRes, error)

func (*ImageX) DescribeImageXScreenshotUsage added in v1.0.140

func (c *ImageX) DescribeImageXScreenshotUsage(ctx context.Context, arg *DescribeImageXScreenshotUsageQuery) (*DescribeImageXScreenshotUsageRes, error)

func (*ImageX) DescribeImageXSensibleTopRAMURL added in v1.0.140

func (c *ImageX) DescribeImageXSensibleTopRAMURL(ctx context.Context, arg *DescribeImageXSensibleTopRAMURLBody) (*DescribeImageXSensibleTopRAMURLRes, error)

func (*ImageX) DescribeImageXServerQPSUsage added in v1.0.140

func (c *ImageX) DescribeImageXServerQPSUsage(ctx context.Context, arg *DescribeImageXServerQPSUsageQuery) (*DescribeImageXServerQPSUsageRes, error)

func (*ImageX) DescribeImageXSummary

func (c *ImageX) DescribeImageXSummary(ctx context.Context, arg *DescribeImageXSummaryQuery) (*DescribeImageXSummaryRes, error)

func (*ImageX) DescribeImageXUploadSpeed

func (c *ImageX) DescribeImageXUploadSpeed(ctx context.Context, arg *DescribeImageXUploadSpeedBody) (*DescribeImageXUploadSpeedRes, error)

func (*ImageX) DescribeImageXVideoClipDurationUsage added in v1.0.140

func (*ImageX) ExportFailedMigrateTask added in v1.0.140

func (c *ImageX) ExportFailedMigrateTask(ctx context.Context, arg *ExportFailedMigrateTaskQuery) (*ExportFailedMigrateTaskRes, error)

func (*ImageX) FetchImageURL added in v1.0.140

func (c *ImageX) FetchImageURL(ctx context.Context, arg *FetchImageURLBody) (*FetchImageURLRes, error)

func (*ImageX) GetAllImageServices added in v1.0.140

func (c *ImageX) GetAllImageServices(ctx context.Context, arg *GetAllImageServicesQuery) (*GetAllImageServicesRes, error)

func (*ImageX) GetAllImageTemplates added in v1.0.140

func (c *ImageX) GetAllImageTemplates(ctx context.Context, arg *GetAllImageTemplatesQuery) (*GetAllImageTemplatesRes, error)

func (*ImageX) GetAuditEntrysCount added in v1.0.118

func (c *ImageX) GetAuditEntrysCount(ctx context.Context, arg *GetAuditEntrysCountQuery) (*GetAuditEntrysCountRes, error)

func (*ImageX) GetComprehensiveEnhanceImage added in v1.0.140

func (c *ImageX) GetComprehensiveEnhanceImage(ctx context.Context, arg *GetComprehensiveEnhanceImageBody) (*GetComprehensiveEnhanceImageRes, error)

func (*ImageX) GetCompressTaskInfo added in v1.0.140

func (c *ImageX) GetCompressTaskInfo(ctx context.Context, arg *GetCompressTaskInfoQuery) (*GetCompressTaskInfoRes, error)

func (*ImageX) GetDedupTaskStatus

func (c *ImageX) GetDedupTaskStatus(ctx context.Context, arg *GetDedupTaskStatusQuery) (*GetDedupTaskStatusRes, error)

func (*ImageX) GetDomainConfig added in v1.0.140

func (c *ImageX) GetDomainConfig(ctx context.Context, arg *GetDomainConfigQuery) (*GetDomainConfigRes, error)

func (*ImageX) GetImageAnalyzeResult added in v1.0.140

func (c *ImageX) GetImageAnalyzeResult(ctx context.Context, arg *GetImageAnalyzeResultQuery) (*GetImageAnalyzeResultRes, error)

func (*ImageX) GetImageAnalyzeTasks added in v1.0.140

func (c *ImageX) GetImageAnalyzeTasks(ctx context.Context, arg *GetImageAnalyzeTasksQuery) (*GetImageAnalyzeTasksRes, error)

func (*ImageX) GetImageAuditResult added in v1.0.118

func (c *ImageX) GetImageAuditResult(ctx context.Context, arg *GetImageAuditResultQuery) (*GetImageAuditResultRes, error)

func (*ImageX) GetImageAuditTasks added in v1.0.118

func (c *ImageX) GetImageAuditTasks(ctx context.Context, arg *GetImageAuditTasksQuery) (*GetImageAuditTasksRes, error)

func (*ImageX) GetImageAuthKey added in v1.0.140

func (c *ImageX) GetImageAuthKey(ctx context.Context, arg *GetImageAuthKeyQuery) (*GetImageAuthKeyRes, error)

func (*ImageX) GetImageBgFillResult added in v1.0.140

func (c *ImageX) GetImageBgFillResult(ctx context.Context, arg *GetImageBgFillResultBody) (*GetImageBgFillResultRes, error)

func (*ImageX) GetImageComicResult added in v1.0.140

func (c *ImageX) GetImageComicResult(ctx context.Context, arg *GetImageComicResultBody) (*GetImageComicResultRes, error)

func (*ImageX) GetImageContentBlockList

func (c *ImageX) GetImageContentBlockList(ctx context.Context, arg *GetImageContentBlockListReq) (*GetImageContentBlockListRes, error)

func (*ImageX) GetImageContentTaskDetail

func (c *ImageX) GetImageContentTaskDetail(ctx context.Context, arg *GetImageContentTaskDetailBody) (*GetImageContentTaskDetailRes, error)

func (*ImageX) GetImageDuplicateDetection

func (c *ImageX) GetImageDuplicateDetection(ctx context.Context, arg *GetImageDuplicateDetectionReq) (*GetImageDuplicateDetectionRes, error)

func (*ImageX) GetImageEnhanceResult added in v1.0.140

func (c *ImageX) GetImageEnhanceResult(ctx context.Context, arg *GetImageEnhanceResultBody) (*GetImageEnhanceResultRes, error)

func (*ImageX) GetImageEraseModels added in v1.0.140

func (c *ImageX) GetImageEraseModels(ctx context.Context, arg *GetImageEraseModelsQuery) (*GetImageEraseModelsRes, error)

func (*ImageX) GetImageEraseResult added in v1.0.140

func (c *ImageX) GetImageEraseResult(ctx context.Context, arg *GetImageEraseResultBody) (*GetImageEraseResultRes, error)

func (*ImageX) GetImageMigrateTasks added in v1.0.140

func (c *ImageX) GetImageMigrateTasks(ctx context.Context, arg *GetImageMigrateTasksQuery) (*GetImageMigrateTasksRes, error)

func (*ImageX) GetImageOCRV2

func (c *ImageX) GetImageOCRV2(ctx context.Context, arg *GetImageOCRV2Req) (*GetImageOCRV2Res, error)

func (*ImageX) GetImagePSDetection

func (c *ImageX) GetImagePSDetection(ctx context.Context, arg *GetImagePSDetectionReq) (*GetImagePSDetectionRes, error)

func (*ImageX) GetImageQuality

func (c *ImageX) GetImageQuality(ctx context.Context, arg *GetImageQualityReq) (*GetImageQualityRes, error)

func (*ImageX) GetImageService added in v1.0.140

func (c *ImageX) GetImageService(ctx context.Context, arg *GetImageServiceQuery) (*GetImageServiceRes, error)

func (*ImageX) GetImageServiceSubscription added in v1.0.140

func (c *ImageX) GetImageServiceSubscription(ctx context.Context) (*GetImageServiceSubscriptionRes, error)

func (*ImageX) GetImageSmartCropResult added in v1.0.140

func (c *ImageX) GetImageSmartCropResult(ctx context.Context, arg *GetImageSmartCropResultBody) (*GetImageSmartCropResultRes, error)

func (*ImageX) GetImageStorageFiles added in v1.0.140

func (c *ImageX) GetImageStorageFiles(ctx context.Context, arg *GetImageStorageFilesQuery) (*GetImageStorageFilesRes, error)

func (*ImageX) GetImageStyleResult

func (c *ImageX) GetImageStyleResult(ctx context.Context, arg *GetImageStyleResultReq) (*GetImageStyleResultRes, error)

func (*ImageX) GetImageSuperResolutionResult added in v1.0.140

func (c *ImageX) GetImageSuperResolutionResult(ctx context.Context, arg *GetImageSuperResolutionResultBody) (*GetImageSuperResolutionResultRes, error)

func (*ImageX) GetImageTemplate added in v1.0.140

func (c *ImageX) GetImageTemplate(ctx context.Context, arg *GetImageTemplateQuery) (*GetImageTemplateRes, error)

func (*ImageX) GetImageTranscodeDetails added in v1.0.140

func (c *ImageX) GetImageTranscodeDetails(ctx context.Context, arg *GetImageTranscodeDetailsQuery) (*GetImageTranscodeDetailsRes, error)

func (*ImageX) GetImageTranscodeQueues added in v1.0.140

func (c *ImageX) GetImageTranscodeQueues(ctx context.Context, arg *GetImageTranscodeQueuesQuery) (*GetImageTranscodeQueuesRes, error)

func (*ImageX) GetImageUpdateFiles added in v1.0.140

func (c *ImageX) GetImageUpdateFiles(ctx context.Context, arg *GetImageUpdateFilesQuery) (*GetImageUpdateFilesRes, error)

func (*ImageX) GetImageUploadFile

func (c *ImageX) GetImageUploadFile(ctx context.Context, arg *GetImageUploadFileQuery) (*GetImageUploadFileRes, error)

func (*ImageX) GetImageUploadFiles

func (c *ImageX) GetImageUploadFiles(ctx context.Context, arg *GetImageUploadFilesQuery) (*GetImageUploadFilesRes, error)

func (*ImageX) GetImageXQueryApps

func (c *ImageX) GetImageXQueryApps(ctx context.Context, arg *GetImageXQueryAppsQuery) (*GetImageXQueryAppsRes, error)

func (*ImageX) GetImageXQueryDims

func (c *ImageX) GetImageXQueryDims(ctx context.Context, arg *GetImageXQueryDimsQuery) (*GetImageXQueryDimsRes, error)

func (*ImageX) GetImageXQueryRegions

func (c *ImageX) GetImageXQueryRegions(ctx context.Context, arg *GetImageXQueryRegionsQuery) (*GetImageXQueryRegionsRes, error)

func (*ImageX) GetImageXQueryVals

func (c *ImageX) GetImageXQueryVals(ctx context.Context, arg *GetImageXQueryValsQuery) (*GetImageXQueryValsRes, error)

func (*ImageX) GetPrivateImageType

func (c *ImageX) GetPrivateImageType(ctx context.Context, arg *GetPrivateImageTypeReq) (*GetPrivateImageTypeRes, error)

func (*ImageX) GetResourceURL added in v1.0.140

func (c *ImageX) GetResourceURL(ctx context.Context, arg *GetResourceURLQuery) (*GetResourceURLRes, error)

func (*ImageX) GetResponseHeaderValidateKeys added in v1.0.140

func (c *ImageX) GetResponseHeaderValidateKeys(ctx context.Context) (*GetResponseHeaderValidateKeysRes, error)

func (*ImageX) GetSegmentImage added in v1.0.140

func (c *ImageX) GetSegmentImage(ctx context.Context, arg *GetSegmentImageReq) (*GetSegmentImageRes, error)

func (*ImageX) GetServiceDomains added in v1.0.140

func (c *ImageX) GetServiceDomains(ctx context.Context, arg *GetServiceDomainsQuery) (*GetServiceDomainsRes, error)

func (*ImageX) GetTemplatesFromBin added in v1.0.140

func (c *ImageX) GetTemplatesFromBin(ctx context.Context, arg *GetTemplatesFromBinQuery) (*GetTemplatesFromBinRes, error)

func (*ImageX) GetURLFetchTask added in v1.0.140

func (c *ImageX) GetURLFetchTask(ctx context.Context, arg *GetURLFetchTaskQuery) (*GetURLFetchTaskRes, error)

func (*ImageX) GetUploadAuth

func (c *ImageX) GetUploadAuth(serviceIds []string, opt ...UploadAuthOpt) (*base.SecurityToken2, error)

获取上传临时密钥

func (*ImageX) GetUploadAuthToken

func (c *ImageX) GetUploadAuthToken(query url.Values) (string, error)

获取临时上传凭证

func (*ImageX) GetUploadAuthWithExpire

func (c *ImageX) GetUploadAuthWithExpire(serviceIds []string, expire time.Duration, opt ...UploadAuthOpt) (*base.SecurityToken2, error)

获取上传临时密钥

func (*ImageX) GetVendorBuckets added in v1.0.140

func (c *ImageX) GetVendorBuckets(ctx context.Context, arg *GetVendorBucketsBody) (*GetVendorBucketsRes, error)

func (*ImageX) ImageXGet

func (c *ImageX) ImageXGet(action string, query url.Values, result interface{}) error

func (*ImageX) ImageXPost

func (c *ImageX) ImageXPost(action string, query url.Values, req, result interface{}) error

func (*ImageX) PreviewImageUploadFile added in v1.0.140

func (c *ImageX) PreviewImageUploadFile(ctx context.Context, arg *PreviewImageUploadFileQuery) (*PreviewImageUploadFileRes, error)

func (*ImageX) RerunImageMigrateTask added in v1.0.140

func (c *ImageX) RerunImageMigrateTask(ctx context.Context, arg *RerunImageMigrateTaskQuery) (*RerunImageMigrateTaskRes, error)

func (*ImageX) SegmentedUploadImages

func (c *ImageX) SegmentedUploadImages(ctx context.Context, params *ApplyUploadImageParam, content []io.Reader, size []int64) (*CommitUploadImageResult, error)

上传图片 请确保 content 长度和 size 长度一致

func (*ImageX) SetDefaultDomain added in v1.0.140

func (c *ImageX) SetDefaultDomain(ctx context.Context, arg *SetDefaultDomainBody) (*SetDefaultDomainRes, error)

func (*ImageX) TerminateImageMigrateTask added in v1.0.140

func (c *ImageX) TerminateImageMigrateTask(ctx context.Context, arg *TerminateImageMigrateTaskQuery) (*TerminateImageMigrateTaskRes, error)

func (*ImageX) UpdateAuditImageStatus added in v1.0.118

func (c *ImageX) UpdateAuditImageStatus(ctx context.Context, arg *UpdateAuditImageStatusBody) (*UpdateAuditImageStatusRes, error)

func (*ImageX) UpdateHTTPS added in v1.0.140

func (c *ImageX) UpdateHTTPS(ctx context.Context, arg *UpdateHTTPSReq) (*UpdateHTTPSRes, error)

func (*ImageX) UpdateImageAnalyzeTask added in v1.0.140

func (c *ImageX) UpdateImageAnalyzeTask(ctx context.Context, arg *UpdateImageAnalyzeTaskBody) (*UpdateImageAnalyzeTaskRes, error)

func (*ImageX) UpdateImageAnalyzeTaskStatus added in v1.0.140

func (c *ImageX) UpdateImageAnalyzeTaskStatus(ctx context.Context, arg *UpdateImageAnalyzeTaskStatusBody) (*UpdateImageAnalyzeTaskStatusRes, error)

func (*ImageX) UpdateImageAuditTask added in v1.0.118

func (c *ImageX) UpdateImageAuditTask(ctx context.Context, arg *UpdateImageAuditTaskBody) (*UpdateImageAuditTaskRes, error)

func (*ImageX) UpdateImageAuditTaskStatus added in v1.0.118

func (c *ImageX) UpdateImageAuditTaskStatus(ctx context.Context, arg *UpdateImageAuditTaskStatusBody) (*UpdateImageAuditTaskStatusRes, error)

func (*ImageX) UpdateImageAuthKey added in v1.0.140

func (c *ImageX) UpdateImageAuthKey(ctx context.Context, arg *UpdateImageAuthKeyReq) (*UpdateImageAuthKeyRes, error)

func (*ImageX) UpdateImageFileKey added in v1.0.140

func (c *ImageX) UpdateImageFileKey(ctx context.Context, arg *UpdateImageFileKeyReq) (*UpdateImageFileKeyRes, error)

func (*ImageX) UpdateImageMirrorConf added in v1.0.140

func (c *ImageX) UpdateImageMirrorConf(ctx context.Context, arg *UpdateImageMirrorConfReq) (*UpdateImageMirrorConfRes, error)

func (*ImageX) UpdateImageObjectAccess added in v1.0.140

func (c *ImageX) UpdateImageObjectAccess(ctx context.Context, arg *UpdateImageObjectAccessReq) (*UpdateImageObjectAccessRes, error)

func (*ImageX) UpdateImageStorageTTL

func (c *ImageX) UpdateImageStorageTTL(ctx context.Context, arg *UpdateImageStorageTTLBody) (*UpdateImageStorageTTLRes, error)

func (*ImageX) UpdateImageTaskStrategy added in v1.0.140

func (c *ImageX) UpdateImageTaskStrategy(ctx context.Context, arg *UpdateImageTaskStrategyBody) (*UpdateImageTaskStrategyRes, error)

func (*ImageX) UpdateImageTranscodeQueue added in v1.0.140

func (c *ImageX) UpdateImageTranscodeQueue(ctx context.Context, arg *UpdateImageTranscodeQueueBody) (*UpdateImageTranscodeQueueRes, error)

func (*ImageX) UpdateImageTranscodeQueueStatus added in v1.0.140

func (c *ImageX) UpdateImageTranscodeQueueStatus(ctx context.Context, arg *UpdateImageTranscodeQueueStatusBody) (*UpdateImageTranscodeQueueStatusRes, error)

func (*ImageX) UpdateImageUploadFiles added in v1.0.140

func (c *ImageX) UpdateImageUploadFiles(ctx context.Context, arg *UpdateImageUploadFilesReq) (*UpdateImageUploadFilesRes, error)

func (*ImageX) UpdateRefer added in v1.0.140

func (c *ImageX) UpdateRefer(ctx context.Context, arg *UpdateReferReq) (*UpdateReferRes, error)

func (*ImageX) UpdateResponseHeader added in v1.0.140

func (c *ImageX) UpdateResponseHeader(ctx context.Context, arg *UpdateResponseHeaderReq) (*UpdateResponseHeaderRes, error)

func (*ImageX) UpdateServiceName added in v1.0.140

func (c *ImageX) UpdateServiceName(ctx context.Context, arg *UpdateServiceNameReq) (*UpdateServiceNameRes, error)

func (*ImageX) UploadImages

func (c *ImageX) UploadImages(params *ApplyUploadImageParam, images [][]byte) (*CommitUploadImageResult, error)

上传图片

type PreviewImageUploadFile added in v1.0.140

type PreviewImageUploadFile struct{}

type PreviewImageUploadFileBody added in v1.0.140

type PreviewImageUploadFileBody struct{}

type PreviewImageUploadFileQuery added in v1.0.140

type PreviewImageUploadFileQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`

	// REQUIRED; 文件 Uri。
	// * 您可以在 veImageX 控制台资源管理 [https://console.volcengine.com/imagex/resource_manage/]页面,在已上传文件的名称列获取资源 Uri。
	// * 您也可以通过 OpenAPI 的方式获取Uri,具体请参考文件上传完成上报 [https://www.volcengine.com/docs/508/9398]。
	StoreURI string `json:"StoreUri" query:"StoreUri"`
}

type PreviewImageUploadFileReq added in v1.0.140

type PreviewImageUploadFileReq struct {
	*PreviewImageUploadFileQuery
	*PreviewImageUploadFileBody
}

type PreviewImageUploadFileRes added in v1.0.140

type PreviewImageUploadFileRes struct {

	// REQUIRED
	ResponseMetadata *PreviewImageUploadFileResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *PreviewImageUploadFileResResult `json:"Result,omitempty"`
}

type PreviewImageUploadFileResResponseMetadata added in v1.0.140

type PreviewImageUploadFileResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type PreviewImageUploadFileResResult added in v1.0.140

type PreviewImageUploadFileResResult struct {

	// REQUIRED; 图片格式。
	ImageFormat string `json:"ImageFormat"`

	// REQUIRED; 图片帧数。
	ImageFrames int `json:"ImageFrames"`

	// REQUIRED; 图片高度。
	ImageHeight int `json:"ImageHeight"`

	// REQUIRED; 图片字节数。
	ImageSize int `json:"ImageSize"`

	// REQUIRED; 图片宽度。
	ImageWidth int `json:"ImageWidth"`

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 底层存储的content-type值
	StorageContentType string `json:"StorageContentType"`

	// REQUIRED; 文件 Uri。
	StoreURI string `json:"StoreUri"`

	// 图片播放时间,单位为毫秒,仅当图片为动态图时返回。
	ImageDuration int `json:"ImageDuration,omitempty"`
}

PreviewImageUploadFileResResult - 视请求的接口而定

type PutError added in v1.0.116

type PutError struct {
	ErrorCode int
	Error     string
	Message   string
}

type RerunImageMigrateTask added in v1.0.140

type RerunImageMigrateTask struct{}

type RerunImageMigrateTaskBody added in v1.0.140

type RerunImageMigrateTaskBody struct{}

type RerunImageMigrateTaskQuery added in v1.0.140

type RerunImageMigrateTaskQuery struct {

	// REQUIRED; 仅当任务状态为Partial时生效。 任务 ID,请参考GetImageMigrateTasks [https://www.volcengine.com/docs/508/1108670]获取返回的任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`

	// 任务地区(即任务目标服务的地区),默认空,返回国内任务。
	// * cn:国内
	// * va:美东
	// * sg:新加坡
	Region string `json:"Region,omitempty" query:"Region"`
}

type RerunImageMigrateTaskReq added in v1.0.140

type RerunImageMigrateTaskReq struct {
	*RerunImageMigrateTaskQuery
	*RerunImageMigrateTaskBody
}

type RerunImageMigrateTaskRes added in v1.0.140

type RerunImageMigrateTaskRes struct {

	// REQUIRED
	ResponseMetadata *RerunImageMigrateTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type RerunImageMigrateTaskResResponseMetadata added in v1.0.140

type RerunImageMigrateTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type Result

type Result struct {
	Uri        string     `json:"Uri"`
	UriStatus  int        `json:"UriStatus"` // 图片上传结果(2000:成功,2001:失败)需要传 SuccessOids 才会返回
	Encryption Encryption `json:"Encryption"`
	PutError   *PutError  `json:"-"` // 上传阶段错误
}

type SetDefaultDomain added in v1.0.140

type SetDefaultDomain struct{}

type SetDefaultDomainBody added in v1.0.140

type SetDefaultDomainBody struct {

	// REQUIRED; 域名,您可以通过获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取服务下域名信息。
	Domain string `json:"Domain"`
}

type SetDefaultDomainQuery added in v1.0.140

type SetDefaultDomainQuery struct{}

type SetDefaultDomainReq added in v1.0.140

type SetDefaultDomainReq struct {
	*SetDefaultDomainQuery
	*SetDefaultDomainBody
}

type SetDefaultDomainRes added in v1.0.140

type SetDefaultDomainRes struct {

	// REQUIRED
	ResponseMetadata *SetDefaultDomainResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type SetDefaultDomainResResponseMetadata added in v1.0.140

type SetDefaultDomainResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type StoreInfo

type StoreInfo struct {
	StoreUri string `json:"StoreUri"`
	Auth     string `json:"Auth"`
}

type TerminateImageMigrateTask added in v1.0.140

type TerminateImageMigrateTask struct{}

type TerminateImageMigrateTaskBody added in v1.0.140

type TerminateImageMigrateTaskBody struct{}

type TerminateImageMigrateTaskQuery added in v1.0.140

type TerminateImageMigrateTaskQuery struct {

	// REQUIRED; 任务 ID,请参考GetImageMigrateTasks [https://www.volcengine.com/docs/508/1108670]获取返回的任务 ID。
	TaskID string `json:"TaskId" query:"TaskId"`

	// 任务地区(即任务目标服务的地区),默认空,返回国内任务。
	// * cn:国内
	// * va:美东
	// * sg:新加坡
	Region string `json:"Region,omitempty" query:"Region"`
}

type TerminateImageMigrateTaskReq added in v1.0.140

type TerminateImageMigrateTaskReq struct {
	*TerminateImageMigrateTaskQuery
	*TerminateImageMigrateTaskBody
}

type TerminateImageMigrateTaskRes added in v1.0.140

type TerminateImageMigrateTaskRes struct {

	// REQUIRED
	ResponseMetadata *TerminateImageMigrateTaskResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type TerminateImageMigrateTaskResResponseMetadata added in v1.0.140

type TerminateImageMigrateTaskResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateAuditImageStatus added in v1.0.140

type UpdateAuditImageStatus struct{}

type UpdateAuditImageStatusBody added in v1.0.140

type UpdateAuditImageStatusBody struct {

	// REQUIRED; 审核图片 ID。您可通过调用获取审核任务结果 [https://www.volcengine.com/docs/508/1160410]查看待更新状态的图片条目 ID。
	EntryID string `json:"EntryId"`

	// REQUIRED; original->frozen执行冻结操作。frozen->original执行恢复操作
	Status string `json:"Status"`

	// REQUIRED; 任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId"`
}

type UpdateAuditImageStatusQuery added in v1.0.140

type UpdateAuditImageStatusQuery struct{}

type UpdateAuditImageStatusReq added in v1.0.118

type UpdateAuditImageStatusReq struct {
	*UpdateAuditImageStatusQuery
	*UpdateAuditImageStatusBody
}

type UpdateAuditImageStatusRes added in v1.0.140

type UpdateAuditImageStatusRes struct {

	// REQUIRED
	ResponseMetadata *UpdateAuditImageStatusResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateAuditImageStatusResResponseMetadata added in v1.0.140

type UpdateAuditImageStatusResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateHTTPS added in v1.0.140

type UpdateHTTPS struct{}

type UpdateHTTPSBody added in v1.0.140

type UpdateHTTPSBody struct {

	// REQUIRED; 域名,您可以通过获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取服务下域名信息。
	Domain string `json:"domain"`

	// REQUIRED; https 配置
	HTTPS *UpdateHTTPSBodyHTTPS `json:"https"`
}

type UpdateHTTPSBodyHTTPS added in v1.0.140

type UpdateHTTPSBodyHTTPS struct {

	// REQUIRED; ["tlsv1.0","tlsv1.1","tlsv1.2","tlsv1.3"]
	TLSVersions []string `json:"tls_versions"`

	// 需要关联的证书 ID,若enable_https为true,则为必填。
	CertID string `json:"cert_id,omitempty"`

	// 是否开启强制跳转,支持取值如下所示:
	// * true:开启
	// * false:关闭
	EnableForceRedirect bool `json:"enable_force_redirect,omitempty"`

	// 是否开启 http2,取值如下所示:
	// * true:开启
	// * false:关闭
	EnableHTTP2 bool `json:"enable_http2,omitempty"`

	// 是否开启 https,取值如下所示:
	// * true:开启
	// * false:关闭
	EnableHTTPS bool `json:"enable_https,omitempty"`

	// 是否开启 ocsp 装订,取值如下所示:
	// * true:开启
	// * false:关闭
	EnableOcsp bool `json:"enable_ocsp,omitempty"`

	// 是否开启 quic 协议支持,取值如下所示:
	// * true:开启
	// * false:关闭
	EnableQuic bool `json:"enable_quic,omitempty"`

	// 301、302HTTP 强制跳转 HTTPS只支持301
	ForceRedirectCode string `json:"force_redirect_code,omitempty"`

	// http2https、https2http
	ForceRedirectType string `json:"force_redirect_type,omitempty"`

	// 配置hsts
	Hsts *UpdateHTTPSBodyHTTPSHsts `json:"hsts,omitempty"`
}

UpdateHTTPSBodyHTTPS - https 配置

type UpdateHTTPSBodyHTTPSHsts added in v1.0.140

type UpdateHTTPSBodyHTTPSHsts struct {

	// 是否开启hsts
	Enable bool `json:"enable,omitempty"`

	// include、exclude
	Subdomain string `json:"subdomain,omitempty"`

	// 表示 Strict-Transport-Security 响应头在浏览器中的缓存过期时间,单位是秒。该参数的取值范围是 0 - 31,536,000。31,536,000 秒表示 365 天。如果该参数值为 0,其效果等同于禁用 HSTS
	// 设置。该参数的默认值是 0。
	TTL int `json:"ttl,omitempty"`
}

UpdateHTTPSBodyHTTPSHsts - 配置hsts

type UpdateHTTPSQuery added in v1.0.140

type UpdateHTTPSQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateHTTPSReq added in v1.0.140

type UpdateHTTPSReq struct {
	*UpdateHTTPSQuery
	*UpdateHTTPSBody
}

type UpdateHTTPSRes added in v1.0.140

type UpdateHTTPSRes struct {
	ResponseMetadata *UpdateHTTPSResResponseMetadata `json:"ResponseMetadata,omitempty"`
	Result           string                          `json:"Result,omitempty"`
}

type UpdateHTTPSResResponseMetadata added in v1.0.140

type UpdateHTTPSResResponseMetadata struct {
	Action    string `json:"Action,omitempty"`
	Region    string `json:"Region,omitempty"`
	RequestID string `json:"RequestId,omitempty"`
	Service   string `json:"Service,omitempty"`
	Version   string `json:"Version,omitempty"`
}

type UpdateImageAnalyzeTask added in v1.0.140

type UpdateImageAnalyzeTask struct{}

type UpdateImageAnalyzeTaskBody added in v1.0.140

type UpdateImageAnalyzeTaskBody struct {

	// REQUIRED; 任务名称
	Name string `json:"Name"`

	// REQUIRED; 服务 ID
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 待更新的任务 ID,您可以通过调用 GetImageAnalyzeTasks [https://www.volcengine.com/docs/508/1160417] 获取指定地区全部离线评估任务详情。
	TaskID string `json:"TaskId"`

	// 任务描述
	Desc string `json:"Desc,omitempty"`

	// 仅当Type取值UriFile时,配置有效。 是否模拟模板每阶段输出,取值如下所示:
	// * true:是,一个模版中可以选择多种图像处理, 模拟输出时会将所有的处理逐步叠加并编码为最终图片格式运行并输出评估结果。
	// * false:否。
	EvalPerStage bool `json:"EvalPerStage,omitempty"`

	// txt 评估文件的 Store URI,该文件需上传至指定服务对应存储中。
	// * Type取值UrlFile时,填写合法 URL
	// * Type取值UriFile时,填写指定服务的存储 URI
	ResURI []string `json:"ResUri,omitempty"`

	// 仅当Type取值UriFile时,配置有效。 模板名称,您可通过调用GetAllImageTemplates [https://www.volcengine.com/docs/508/9386]获取服务下所有已创建的TemplateName。
	Tpl string `json:"Tpl,omitempty"`
}

type UpdateImageAnalyzeTaskQuery added in v1.0.140

type UpdateImageAnalyzeTaskQuery struct{}

type UpdateImageAnalyzeTaskReq added in v1.0.140

type UpdateImageAnalyzeTaskReq struct {
	*UpdateImageAnalyzeTaskQuery
	*UpdateImageAnalyzeTaskBody
}

type UpdateImageAnalyzeTaskRes added in v1.0.140

type UpdateImageAnalyzeTaskRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageAnalyzeTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageAnalyzeTaskResResponseMetadata added in v1.0.140

type UpdateImageAnalyzeTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageAnalyzeTaskStatus added in v1.0.140

type UpdateImageAnalyzeTaskStatus struct{}

type UpdateImageAnalyzeTaskStatusBody added in v1.0.140

type UpdateImageAnalyzeTaskStatusBody struct {

	// REQUIRED; 更新后的任务状态。取值如下所示:
	// * Running:进行中
	// * Suspend:暂停
	// * Done:结束
	Status string `json:"Status"`

	// REQUIRED; 待更新的任务 ID,您可以通过调用GetImageAnalyzeTasks [https://www.volcengine.com/docs/508/1160417]获取指定地区全部离线评估任务 ID。
	TaskID string `json:"TaskId"`
}

type UpdateImageAnalyzeTaskStatusQuery added in v1.0.140

type UpdateImageAnalyzeTaskStatusQuery struct{}

type UpdateImageAnalyzeTaskStatusReq added in v1.0.140

type UpdateImageAnalyzeTaskStatusReq struct {
	*UpdateImageAnalyzeTaskStatusQuery
	*UpdateImageAnalyzeTaskStatusBody
}

type UpdateImageAnalyzeTaskStatusRes added in v1.0.140

type UpdateImageAnalyzeTaskStatusRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageAnalyzeTaskStatusResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageAnalyzeTaskStatusResResponseMetadata added in v1.0.140

type UpdateImageAnalyzeTaskStatusResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageAuditTask added in v1.0.140

type UpdateImageAuditTask struct{}

type UpdateImageAuditTaskBody added in v1.0.140

type UpdateImageAuditTaskBody struct {

	// REQUIRED; 审核维度,根据审核能力的不同,其具体取值不同。基础审核与智能审核之间不支持混用。
	// * 基础安全审核,仅当 AuditAbility 取值为 0 时,配置生效。
	//
	// * govern:涉政
	// * porn :涉黄
	// * illegal:违法违规
	// * terror:涉暴
	//
	//
	// * 智能安全审核,仅当 AuditAbility 取值为 1 时,配置生效。
	//
	// * 图像风险识别 * porn :涉黄,主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别
	// * sensitive1 :涉敏1,具体指涉及暴恐风险
	// * sensitive2:涉敏2,具体值涉及政治内容风险
	// * forbidden:违禁,主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别
	// * uncomfortable:引人不适,主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别
	// * qrcode:二维码,主要适用于识别常见二维码(QQ、微信、其他二维码等)
	// * badpicture:不良画面,主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别
	// * sexy:性感低俗,主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别
	// * age:年龄,主要适用于图中人物对应的年龄段识别
	// * underage:未成年相关,主要适用于儿童色情、儿童邪典等风险识别
	// * quality:图片质量,主要适用于图片模糊、纯色边框、纯色屏等风险识别
	//
	//
	// * 图文风险识别,您可在 AuditTextDimensions 配置文字审核的维度。
	//
	// :::tip 您可将智能安全审核的图像风险识别和图文风险识别搭配使用。 :::
	AuditDimensions []string `json:"AuditDimensions"`

	// REQUIRED; 指定待更新审核任务所在的服务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1158717]获取待更新任务对应的服务 ID。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 任务 ID,您可通过调用 查询所有审核任务 [https://www.volcengine.com/docs/508/1158717] 获取所需的任务 ID。
	TaskID string `json:"TaskId"`

	// 仅当EnableAuditRange取值1时,配置生效。 指定前缀审核,若你希望对某个目录进行审核,请设置路径为对应的目录名,以/结尾。例如123/
	AuditPrefix []string `json:"AuditPrefix,omitempty"`

	// 智能安全审核类型下图片文本审核的具体维度,取值如下所示:
	// * ad:广告,综合图像及文字内容智能识别广告
	// * defraud:诈骗,综合图像及文字内容智能识别诈骗
	// * charillegal:文字违规,图片上存在涉黄、涉敏、违禁等违规文字
	// :::tip 仅当 AuditDimensions 取值为智能安全审核模型时,您可将 AuditTextDimensions 与 AuditDimensions 搭配使用。 :::
	AuditTextDimensions []string `json:"AuditTextDimensions,omitempty"`

	// 回调类型,取值需要与 AuditDimensions 审核维度保持一致或少于 AuditDimensions。
	// 例如,AuditDimensions 取值 ["pron","sexy"],AuditTextDimensions 取值 ["ad"],支持您将 FreezeDimensions 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"]
	// 和 ["sexy","ad"] 任意一种。
	CallbackDimensions []string `json:"CallbackDimensions,omitempty"`

	// 回调图片类型,取值如下所示:
	// * normal:正常图片
	//
	//
	// * problem:问题图片
	//
	//
	// * frozen:冻结图片
	//
	//
	// * fail:审核失败图片
	CallbackImageTypes []string `json:"CallbackImageTypes,omitempty"`

	// 回调 URL,veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/134676#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	CallbackURL string `json:"CallbackUrl,omitempty"`

	// 仅当Type取值Upload时,配置生效。 审核范围,取值如下所示:
	// * 0:(默认)不限范围
	// * 1:指定范围
	EnableAuditRange string `json:"EnableAuditRange,omitempty"`

	// 是否开启回调,取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	EnableCallback bool `json:"EnableCallback,omitempty"`

	// 是否开启冻结,取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	EnableFreeze bool `json:"EnableFreeze,omitempty"`

	// 图片审核仅支持审核 5MB 以下的图片,若您的图片大小在 5MB~32MB,您可以开启大图审核功能,veImageX 会对图片压缩后再进行审核。开启后,将对压缩能力按照基础图片处理
	// [https://www.volcengine.com/docs/508/65935#%E5%9F%BA%E7%A1%80%E5%9B%BE%E5%83%8F%E5%A4%84%E7%90%86%E6%9C%8D%E5%8A%A1]进行计费。(您每月可使用
	// 20TB 的免费额度) 取值如下所示:
	// * true:开启
	// * false:(默认)不开启
	// :::tip
	// * 若未开启大图审核且图片大小 ≥ 5 MB,可能会导致系统超时报错;
	// * 若已开启大图审核但图片大小 ≥ 32 MB,可能会导致系统超时报错。 :::
	EnableLargeImageDetect bool `json:"EnableLargeImageDetect,omitempty"`

	// 若开启冻结,则不可为空
	FreezeDimensions []string `json:"FreezeDimensions,omitempty"`

	// 若开启冻结,则不可为空
	FreezeStrategy int `json:"FreezeStrategy,omitempty"`

	// 若开启冻结,则不可为空
	FreezeType []string `json:"FreezeType,omitempty"`

	// 仅当 EnableAuditRange 取值 1 时,配置生效。 指定前缀不审核,若你希望对某个目录不进行审核,请设置路径为对应的目录名,以/结尾。例如123/
	NoAuditPrefix []string `json:"NoAuditPrefix,omitempty"`

	// 任务地区。当前仅支持取值 cn,表示国内。
	Region string `json:"Region,omitempty"`

	// 仅当 Type 为 UrlFile 时,配置生效。
	// 审核文件的 StoreUri,为 .txt 文件,该文件需上传至指定服务对应存储中。该 txt 文件内需填写待审核图片文件的 URL,每行填写一个,最多可填写 10000 行。
	ResURI []string `json:"ResUri,omitempty"`
}

type UpdateImageAuditTaskQuery added in v1.0.140

type UpdateImageAuditTaskQuery struct{}

type UpdateImageAuditTaskReq added in v1.0.118

type UpdateImageAuditTaskReq struct {
	*UpdateImageAuditTaskQuery
	*UpdateImageAuditTaskBody
}

type UpdateImageAuditTaskRes added in v1.0.140

type UpdateImageAuditTaskRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageAuditTaskResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageAuditTaskResResponseMetadata added in v1.0.140

type UpdateImageAuditTaskResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageAuditTaskStatus added in v1.0.140

type UpdateImageAuditTaskStatus struct{}

type UpdateImageAuditTaskStatusBody added in v1.0.140

type UpdateImageAuditTaskStatusBody struct {

	// REQUIRED; 更新后的任务状态。取值如下所示:
	// * Running:审核中
	// * Suspend:审核暂停
	// * Done:审核完成
	// * Cancel:审核取消
	Status string `json:"Status"`

	// REQUIRED; 待更新的任务 ID,您可通过调用查询所有审核任务 [https://www.volcengine.com/docs/508/1160409]获取所需的任务 ID。
	TaskID string `json:"TaskId"`
}

type UpdateImageAuditTaskStatusQuery added in v1.0.140

type UpdateImageAuditTaskStatusQuery struct{}

type UpdateImageAuditTaskStatusReq added in v1.0.118

type UpdateImageAuditTaskStatusReq struct {
	*UpdateImageAuditTaskStatusQuery
	*UpdateImageAuditTaskStatusBody
}

type UpdateImageAuditTaskStatusRes added in v1.0.140

type UpdateImageAuditTaskStatusRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageAuditTaskStatusResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageAuditTaskStatusResResponseMetadata added in v1.0.140

type UpdateImageAuditTaskStatusResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageAuthKey added in v1.0.140

type UpdateImageAuthKey struct{}

type UpdateImageAuthKeyBody added in v1.0.140

type UpdateImageAuthKeyBody struct {

	// 主鉴权 key,长度为 8-32 字节,为空则不更新主鉴权值。
	PrimaryKey string `json:"PrimaryKey,omitempty"`

	// 备鉴权 key,长度为 8-32 字节,为空则不更新备鉴权值。
	SecondaryKey string `json:"SecondaryKey,omitempty"`
}

type UpdateImageAuthKeyQuery added in v1.0.140

type UpdateImageAuthKeyQuery struct {

	// 服务 ID。
	ServiceID string `json:"ServiceId,omitempty" query:"ServiceId"`
}

type UpdateImageAuthKeyReq added in v1.0.140

type UpdateImageAuthKeyReq struct {
	*UpdateImageAuthKeyQuery
	*UpdateImageAuthKeyBody
}

type UpdateImageAuthKeyRes added in v1.0.140

type UpdateImageAuthKeyRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageAuthKeyResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageAuthKeyResResponseMetadata added in v1.0.140

type UpdateImageAuthKeyResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageFileKey added in v1.0.140

type UpdateImageFileKey struct{}

type UpdateImageFileKeyBody added in v1.0.140

type UpdateImageFileKeyBody struct {

	// REQUIRED; 重命名后的文件名
	DstKey string `json:"DstKey"`

	// REQUIRED; 源文件名
	OriKey string `json:"OriKey"`
}

type UpdateImageFileKeyQuery added in v1.0.140

type UpdateImageFileKeyQuery struct {

	// REQUIRED; 服务ID
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateImageFileKeyReq added in v1.0.140

type UpdateImageFileKeyReq struct {
	*UpdateImageFileKeyQuery
	*UpdateImageFileKeyBody
}

type UpdateImageFileKeyRes added in v1.0.140

type UpdateImageFileKeyRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageFileKeyResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageFileKeyResResponseMetadata added in v1.0.140

type UpdateImageFileKeyResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageMirrorConf added in v1.0.140

type UpdateImageMirrorConf struct{}

type UpdateImageMirrorConfBody added in v1.0.140

type UpdateImageMirrorConfBody struct {

	// REQUIRED; 镜像回源下载原图时,携带的 HTTP 头部,键值都为 String 类型。
	Headers map[string]string `json:"Headers"`

	// REQUIRED; 镜像回源域名。
	Host string `json:"Host"`

	// REQUIRED; 下载图片的协议,取值为:http、https。
	Schema string `json:"Schema"`

	// 带权重回源域名。key 为 String 类型,代表镜像回源域名;value 为 Integer 类型,代表域名权重。
	Hosts map[string]int `json:"Hosts,omitempty"`

	// 镜像站
	Origin *UpdateImageMirrorConfBodyOrigin `json:"Origin,omitempty"`

	// 镜像源 URI,其中图片名用 %s 占位符替代,比如/obj/%s。
	Source string `json:"Source,omitempty"`
}

type UpdateImageMirrorConfBodyOrigin added in v1.0.140

type UpdateImageMirrorConfBodyOrigin struct {

	// REQUIRED; 镜像站配置
	Param map[string]interface{} `json:"Param"`

	// REQUIRED; 镜像站类型
	Type string `json:"Type"`
}

UpdateImageMirrorConfBodyOrigin - 镜像站

type UpdateImageMirrorConfQuery added in v1.0.140

type UpdateImageMirrorConfQuery struct {

	// REQUIRED; 服务 ID。 \
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateImageMirrorConfReq added in v1.0.140

type UpdateImageMirrorConfReq struct {
	*UpdateImageMirrorConfQuery
	*UpdateImageMirrorConfBody
}

type UpdateImageMirrorConfRes added in v1.0.140

type UpdateImageMirrorConfRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageMirrorConfResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageMirrorConfResResponseMetadata added in v1.0.140

type UpdateImageMirrorConfResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageObjectAccess added in v1.0.140

type UpdateImageObjectAccess struct{}

type UpdateImageObjectAccessBody added in v1.0.140

type UpdateImageObjectAccessBody struct {

	// 是否开启源地址访问,取值如下所示:
	// * true:开启源地址访问
	// * false:关闭源地址访问
	ObjectAccess bool `json:"ObjectAccess,omitempty"`
}

type UpdateImageObjectAccessQuery added in v1.0.140

type UpdateImageObjectAccessQuery struct {

	// 服务 ID。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId,omitempty" query:"ServiceId"`
}

type UpdateImageObjectAccessReq added in v1.0.140

type UpdateImageObjectAccessReq struct {
	*UpdateImageObjectAccessQuery
	*UpdateImageObjectAccessBody
}

type UpdateImageObjectAccessRes added in v1.0.140

type UpdateImageObjectAccessRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageObjectAccessResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageObjectAccessResResponseMetadata added in v1.0.140

type UpdateImageObjectAccessResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageStorageTTL added in v1.0.140

type UpdateImageStorageTTL struct{}

type UpdateImageStorageTTLBody added in v1.0.140

type UpdateImageStorageTTLBody struct {

	// REQUIRED; 服务 ID 。
	// * 您可以在 veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId"`

	// REQUIRED; 更新后的有效期时间。单位为秒,取值范围为 [86400, 7776000]。 若取值超过整天,则默认向上取整,例如当TTL取值为86401时,实际有效期被设置为 2 天。
	TTL int `json:"TTL"`
}

type UpdateImageStorageTTLQuery added in v1.0.140

type UpdateImageStorageTTLQuery struct{}

type UpdateImageStorageTTLReq

type UpdateImageStorageTTLReq struct {
	*UpdateImageStorageTTLQuery
	*UpdateImageStorageTTLBody
}

type UpdateImageStorageTTLRes added in v1.0.140

type UpdateImageStorageTTLRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageStorageTTLResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageStorageTTLResResponseMetadata added in v1.0.140

type UpdateImageStorageTTLResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageTaskStrategy added in v1.0.140

type UpdateImageTaskStrategy struct{}

type UpdateImageTaskStrategyBody added in v1.0.140

type UpdateImageTaskStrategyBody struct {

	// REQUIRED; 调整后的迁移策略
	RunStrategy *UpdateImageTaskStrategyBodyRunStrategy `json:"RunStrategy"`

	// REQUIRED; 任务ID,请参考CreateImageMigrateTask [https://www.volcengine.com/docs/508/1009929]获取返回的任务 ID。
	TaskID string `json:"TaskId"`
}

type UpdateImageTaskStrategyBodyRunStrategy added in v1.0.140

type UpdateImageTaskStrategyBodyRunStrategy struct {

	// 源下载 QPS 限制。如取值不为空,则长度必须为 24,表示一天 24 小时内各小时的 QPS 限制值。默认无限制。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadQPS []int `json:"ReadQps,omitempty"`

	// 源下载流量限制。单位为 Byte。如取值不为空,则长度必须为24,表示一天 24 小时内各小时的流量限制值。默认无限制。
	// * 取值为负值时,表示无限制
	// * 取值为 0 时,表示对应时间不允许迁移
	ReadRate []int `json:"ReadRate,omitempty"`
}

UpdateImageTaskStrategyBodyRunStrategy - 调整后的迁移策略

type UpdateImageTaskStrategyQuery added in v1.0.140

type UpdateImageTaskStrategyQuery struct{}

type UpdateImageTaskStrategyReq added in v1.0.140

type UpdateImageTaskStrategyReq struct {
	*UpdateImageTaskStrategyQuery
	*UpdateImageTaskStrategyBody
}

type UpdateImageTaskStrategyRes added in v1.0.140

type UpdateImageTaskStrategyRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageTaskStrategyResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateImageTaskStrategyResResponseMetadata added in v1.0.140

type UpdateImageTaskStrategyResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageTranscodeQueue added in v1.0.140

type UpdateImageTranscodeQueue struct{}

type UpdateImageTranscodeQueueBody added in v1.0.140

type UpdateImageTranscodeQueueBody struct {

	// REQUIRED; 是否启用回调。取值如下所示:
	// * true:启用
	// * false:不启用
	EnableCallback bool `json:"EnableCallback"`

	// REQUIRED; 待更新的队列 ID,您可通过调用GetImageTranscodeQueues [https://www.volcengine.com/docs/508/1107341]获取该账号下全部任务队列 ID。
	ID string `json:"Id"`

	// REQUIRED; 更新后的队列名称
	Name string `json:"Name"`

	// 更新后的队列回调配置
	CallbackConf *UpdateImageTranscodeQueueBodyCallbackConf `json:"CallbackConf,omitempty"`

	// 更新后的队列描述
	Desc string `json:"Desc,omitempty"`
}

type UpdateImageTranscodeQueueBodyCallbackConf added in v1.0.140

type UpdateImageTranscodeQueueBodyCallbackConf struct {

	// REQUIRED; 回调 HTTP 请求地址,用于接收转码结果详情。支持使用 https 和 http 协议。
	Endpoint string `json:"Endpoint"`

	// REQUIRED; 回调方式。仅支持取值 HTTP。
	Method string `json:"Method"`

	// 业务自定义回调参数,将在回调消息的callback_args中透传出去。具体回调参数请参考回调内容 [https://www.volcengine.com/docs/508/1104726#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9]。
	Args string `json:"Args,omitempty"`

	// 回调数据格式。取值如下所示:
	// * XML
	// * JSON(默认)
	DataFormat string `json:"DataFormat,omitempty"`
}

UpdateImageTranscodeQueueBodyCallbackConf - 更新后的队列回调配置

type UpdateImageTranscodeQueueQuery added in v1.0.140

type UpdateImageTranscodeQueueQuery struct{}

type UpdateImageTranscodeQueueReq added in v1.0.140

type UpdateImageTranscodeQueueReq struct {
	*UpdateImageTranscodeQueueQuery
	*UpdateImageTranscodeQueueBody
}

type UpdateImageTranscodeQueueRes added in v1.0.140

type UpdateImageTranscodeQueueRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageTranscodeQueueResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageTranscodeQueueResResponseMetadata added in v1.0.140

type UpdateImageTranscodeQueueResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageTranscodeQueueStatus added in v1.0.140

type UpdateImageTranscodeQueueStatus struct{}

type UpdateImageTranscodeQueueStatusBody added in v1.0.140

type UpdateImageTranscodeQueueStatusBody struct {

	// REQUIRED; 待更新的队列 ID,您可通过调用GetImageTranscodeQueues [https://www.volcengine.com/docs/508/1107341]获取该账号下全部任务队列 ID。
	ID string `json:"Id"`

	// REQUIRED; 更新后的队列状态。取值如下所示:
	// * Pending:排队中
	// * Running:执行中
	Status string `json:"Status"`
}

type UpdateImageTranscodeQueueStatusQuery added in v1.0.140

type UpdateImageTranscodeQueueStatusQuery struct{}

type UpdateImageTranscodeQueueStatusReq added in v1.0.140

type UpdateImageTranscodeQueueStatusReq struct {
	*UpdateImageTranscodeQueueStatusQuery
	*UpdateImageTranscodeQueueStatusBody
}

type UpdateImageTranscodeQueueStatusRes added in v1.0.140

type UpdateImageTranscodeQueueStatusRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageTranscodeQueueStatusResResponseMetadata `json:"ResponseMetadata"`

	// REQUIRED; Anything
	Result interface{} `json:"Result"`
}

type UpdateImageTranscodeQueueStatusResResponseMetadata added in v1.0.140

type UpdateImageTranscodeQueueStatusResResponseMetadata struct {

	// REQUIRED
	Action string `json:"Action"`

	// REQUIRED
	Region string `json:"Region"`

	// REQUIRED
	RequestID string `json:"RequestId"`

	// REQUIRED
	Service string `json:"Service"`

	// REQUIRED
	Version string `json:"Version"`
}

type UpdateImageUploadFiles added in v1.0.140

type UpdateImageUploadFiles struct{}

type UpdateImageUploadFilesBody added in v1.0.140

type UpdateImageUploadFilesBody struct {

	// REQUIRED; 更新操作。
	// * 取值为 0 表示刷新 URL
	// * 取值为 1 表示禁用 URL
	// * 取值为 2 表示解禁 URL
	// * 取值为 4 表示预热 URL
	// * 取值为 5 表示目录刷新
	// * 取值为 6 表示样式刷新
	Action int `json:"Action"`

	// REQUIRED; 待操作的图片 URL 列表,最多传 100 个。
	// * 当 [Action] 取值为 5 时,表示待刷新的目录列表,目录必须以 / 结尾,不支持刷新根目录,也不支持海外域名;
	// * 当 [Action] 取值为 6 时,表示样式刷新,一次性最多传入 5 个 url,单个 url 最多匹配10万个样式,暂不支持海外使用。
	ImageUrls []string `json:"ImageUrls"`
}

type UpdateImageUploadFilesQuery added in v1.0.140

type UpdateImageUploadFilesQuery struct {

	// REQUIRED; 服务 ID。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateImageUploadFilesReq added in v1.0.140

type UpdateImageUploadFilesReq struct {
	*UpdateImageUploadFilesQuery
	*UpdateImageUploadFilesBody
}

type UpdateImageUploadFilesRes added in v1.0.140

type UpdateImageUploadFilesRes struct {

	// REQUIRED
	ResponseMetadata *UpdateImageUploadFilesResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result *UpdateImageUploadFilesResResult `json:"Result,omitempty"`
}

type UpdateImageUploadFilesResResponseMetadata added in v1.0.140

type UpdateImageUploadFilesResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UpdateImageUploadFilesResResult added in v1.0.140

type UpdateImageUploadFilesResResult struct {

	// REQUIRED
	FailUrls []string `json:"FailUrls"`

	// REQUIRED; 操作成功的图片 URL 列表。
	ImageUrls []string `json:"ImageUrls"`
}

UpdateImageUploadFilesResResult - 视请求的接口而定

type UpdateRefer added in v1.0.140

type UpdateRefer struct{}

type UpdateReferBody added in v1.0.140

type UpdateReferBody struct {

	// REQUIRED; 域名,您可以通过获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取服务下域名信息。
	Domain string `json:"domain"`

	// REQUIRED; Referer 配置
	ReferLink *UpdateReferBodyReferLink `json:"refer_link"`
}
type UpdateReferBodyReferLink struct {

	// 是否允许空 Referer 访问,取值如下所示:
	// * true:允许
	// * false:不允许
	AllowEmptyRefer bool `json:"allow_empty_refer,omitempty"`

	// 是否开启 Referer 访问限制,取值如下所示:
	// * true:开启
	// * false:关闭
	Enabled bool `json:"enabled,omitempty"`

	// 是否选择白名单模式,取值如下所示:
	// * true:选择白名单
	// * false:选择黑名单
	IsWhiteMode bool `json:"is_white_mode,omitempty"`

	// Referer 的正则表达式的列表,仅支持填写 IPv4 和 IPv6 格式的 IP 地址,参数长度范围为(1,1024)。不支持域名、泛域名、CIDR 网段。
	RegexValues []string `json:"regex_values,omitempty"`

	// 是否启用正则表达列表,取值如下所示:
	// * true:启用
	// * false:不启用
	RegexValuesEnabled bool `json:"regex_values_enabled,omitempty"`

	// Referer 通用规则列表,根据是否为白名单,为对应的白/黑名单的值。您可以指定一个或者多个 IP 地址,域名和泛域名。支持填写二级域名,支持混合输入。
	// * IP 地址格式支持 IPv4 和 IPv6,最多可输入 100 个 IP 地址。
	// * 域名无需包含http://或https://。
	// :::tipvalues 和 regex_valses 均存在时,两者同时生效。 :::
	Values []string `json:"values,omitempty"`
}

UpdateReferBodyReferLink - Referer 配置

type UpdateReferQuery added in v1.0.140

type UpdateReferQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateReferReq added in v1.0.140

type UpdateReferReq struct {
	*UpdateReferQuery
	*UpdateReferBody
}

type UpdateReferRes added in v1.0.140

type UpdateReferRes struct {
	ResponseMetadata *UpdateReferResResponseMetadata `json:"ResponseMetadata,omitempty"`
	Result           string                          `json:"Result,omitempty"`
}

type UpdateReferResResponseMetadata added in v1.0.140

type UpdateReferResResponseMetadata struct {
	Action    string `json:"Action,omitempty"`
	Region    string `json:"Region,omitempty"`
	RequestID string `json:"RequestId,omitempty"`
	Service   string `json:"Service,omitempty"`
	Version   string `json:"Version,omitempty"`
}

type UpdateResponseHeader added in v1.0.140

type UpdateResponseHeader struct{}

type UpdateResponseHeaderBody added in v1.0.140

type UpdateResponseHeaderBody struct {

	// 域名,您可以通过获取服务下全部域名 [https://www.volcengine.com/docs/508/9379]获取服务下域名信息。
	Domain string `json:"domain,omitempty"`

	// Resp Headers 配置
	RespHdrs []*UpdateResponseHeaderBodyRespHdrsItem `json:"resp_hdrs,omitempty"`
}

type UpdateResponseHeaderBodyRespHdrsItem added in v1.0.140

type UpdateResponseHeaderBodyRespHdrsItem struct {

	// REQUIRED; 在 veImageX 响应用户请求时,是否校验请求头中的 Origin 字段。仅对响应头部Access-Control-Allow-Origin有效,取值如下所示:
	// * true:开启校验,veImageX 会校验 Origin 字段。 * 如果校验成功,响应头中会包含 Access-Control-Allow-Origin 字段。字段值与 Origin 字段值相同。
	// * 如果校验失败,响应头中不会包含 Access-Control-Allow-Origin 字段。
	//
	//
	// * false:关闭校验,veImageX 不会校验 Origin 字段。响应头中将始终包含 Access-Control-Allow-Origin 头部和您配置的值。
	AccessOriginControl bool `json:"access_origin_control"`

	// Header Key,请见支持配置的响应头 [https://www.volcengine.com/docs/508/196704#%E6%94%AF%E6%8C%81%E9%85%8D%E7%BD%AE%E7%9A%84%E5%93%8D%E5%BA%94%E5%A4%B4]。
	Key string `json:"key,omitempty"`

	// Header Value,设置该响应头字段的值。字段值不能超过 1,024 个字符,可以包含除美元符号($),Delete(ASCII code 127)外的可打印 ASCII 字符。
	Value string `json:"value,omitempty"`
}

type UpdateResponseHeaderQuery added in v1.0.140

type UpdateResponseHeaderQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在veImageX 控制台服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateResponseHeaderReq added in v1.0.140

type UpdateResponseHeaderReq struct {
	*UpdateResponseHeaderQuery
	*UpdateResponseHeaderBody
}

type UpdateResponseHeaderRes added in v1.0.140

type UpdateResponseHeaderRes struct {
	ResponseMetadata *UpdateResponseHeaderResResponseMetadata `json:"ResponseMetadata,omitempty"`
	Result           string                                   `json:"Result,omitempty"`
}

type UpdateResponseHeaderResResponseMetadata added in v1.0.140

type UpdateResponseHeaderResResponseMetadata struct {
	Action    string `json:"Action,omitempty"`
	Region    string `json:"Region,omitempty"`
	RequestID string `json:"RequestId,omitempty"`
	Service   string `json:"Service,omitempty"`
	Version   string `json:"Version,omitempty"`
}

type UpdateServiceName added in v1.0.140

type UpdateServiceName struct{}

type UpdateServiceNameBody added in v1.0.140

type UpdateServiceNameBody struct {

	// REQUIRED; 服务名称,最多不超过 32 个字符。
	ServiceName string `json:"ServiceName"`
}

type UpdateServiceNameQuery added in v1.0.140

type UpdateServiceNameQuery struct {

	// REQUIRED; 服务 ID。
	// * 您可以在 veImageX 控制台 服务管理 [https://console.volcengine.com/imagex/service_manage/]页面,在创建好的图片服务中获取服务 ID。
	// * 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息 [https://www.volcengine.com/docs/508/9360]。
	ServiceID string `json:"ServiceId" query:"ServiceId"`
}

type UpdateServiceNameReq added in v1.0.140

type UpdateServiceNameReq struct {
	*UpdateServiceNameQuery
	*UpdateServiceNameBody
}

type UpdateServiceNameRes added in v1.0.140

type UpdateServiceNameRes struct {

	// REQUIRED
	ResponseMetadata *UpdateServiceNameResResponseMetadata `json:"ResponseMetadata"`

	// 视请求的接口而定
	Result interface{} `json:"Result,omitempty"`
}

type UpdateServiceNameResResponseMetadata added in v1.0.140

type UpdateServiceNameResResponseMetadata struct {

	// REQUIRED; 请求的接口名,属于请求的公共参数。
	Action string `json:"Action"`

	// REQUIRED; 请求的Region,例如:cn-north-1
	Region string `json:"Region"`

	// REQUIRED; RequestID为每次API请求的唯一标识。
	RequestID string `json:"RequestId"`

	// REQUIRED; 请求的服务,属于请求的公共参数。
	Service string `json:"Service"`

	// REQUIRED; 请求的版本号,属于请求的公共参数。
	Version string `json:"Version"`
}

type UploadAddress

type UploadAddress struct {
	SessionKey  string      `json:"SessionKey"`
	UploadHosts []string    `json:"UploadHosts"`
	StoreInfos  []StoreInfo `json:"StoreInfos"`
}

type UploadAuthOpt

type UploadAuthOpt func(option *uploadAuthOption)

func WithUploadKeyPtn

func WithUploadKeyPtn(ptn string) UploadAuthOpt

func WithUploadOverwrite added in v1.0.111

func WithUploadOverwrite(overwrite bool) UploadAuthOpt

type UploadPayload added in v1.0.116

type UploadPayload struct {
	Hash string `json:"hash"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL