You need to enable JavaScript to run this app.
导航

API 参数更新

最近更新时间2023.06.05 15:36:30

首次发布时间2022.11.23 15:14:36

关于本次更新的变更公告,参见 SDK 变更说明

更新说明

本文档列出的参数更新中:

  • 数据类型发生变更,但不是变更为指针的参数,仅 Volcengine SDK for Java 的用户需要关注。
  • 数据类型变更为指针的参数,仅 Volcengine SDK for Go 的用户需要关注。
  • 新增和删除的参数,所有 Volcengine SDK 的用户都需要关注。

Volcengine SDK for Go 和 Volcengine SDK for Java 的示例代码也更新了。您可以参照示例代码的更新来更新您的代码。

AddCdnDomainRequest

参数新增

AreaAccessRule:类型 *AreaAccessRule
CustomErrorPage:类型 *CustomErrorPage
MethodDeniedRule:类型 *MethodDeniedRule
OriginArg:类型 []OriginArgRule
OriginSni:类型 *OriginSni
RedirectionRewrite:类型 *RedirectionRewrite
RemoteAuth:类型 *RemoteAuth
UaAccessRule:类型 *UserAgentAccessRule

参数变更与名称变更
ServiceType 类型由 str 修改为 *str
BandwidthLimit *BandwidthLimit 结构体存在修改
Compression *Compression:
Switch 类型由 bool 修改为 *bool
ServiceType 类型修改为 *str
Cache []CacheControlRule 结构体存在修改
CaCheKey []CacheKeyGenerationRule 结构体存在修改
DownloadSpeedLimit *DownloadSpeedLimit 结构体存在修改
HTTPS []HTTPS 结构体存在修改
OriginRule []OriginRule 结构体存在修改
NegativeCache 的类型名称由 []NegativeCacheRule 修改为 []NegativeCache。同时 []NegativeCache 结构体也引入了变更。
ResourceTags 的类型名称由 []ResourceTagEntry 修改为 []ResourceTag
IPv6 *IPv6 结构体存在修改:
Switch 类型由 bool 修改为 *bool
IpAccessRule *IpAccessRule 结构体存在修改:
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
IpFreqLimit []IpFreqLimit 结构体存在修改
IpSpeedLimit []IpSpeedLimit 存在修改
OriginAccessRule *OriginAccessRule 结构体存在修改:
AllowEmpty 类型由 bool 修改为 *bool
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
Quic *Quic 结构体存在修改:
Switch 类型由 bool 修改为 *bool
RefererAccessRule *RefererAccessRule 结构体存在修改:
AllowEmpty 类型由 bool 修改为 *bool
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
SignedUrlAuth *SignedUrlAuth 结构体存在修改
VideoDrag *VideoDrag 结构体存在修改:
Switch 类型由 bool 修改为 *bool

UpdateCdnConfigRequest

参数删除
ResourceTags

说明

如果您需要对 ResourceTags 进行操作,可以使用以下 API:

  • AddResourceTags:添加资源标签
  • UpdateResourceTags:更新资源标签
  • ListResourceTags:查询标签清单
  • DeleteResourceTags:删除资源标签

参数变更与名称变更
Domain 类型由 str 修改为 *str
OriginProtocol 类型由 str 修改为 *str
NegativeCache 的类型名称由 []NegativeCacheRule 修改为 []NegativeCache
其余变更和 AddCdnDomainRequest 相同

DescribeCdnConfigResponse

Result DescribeCdnConfigResult
名称变更:DomainConfig 的类型名称由 DomainConfig 修改为 DomainVolcanoDetail

同时,在以下参数层级内,存在参数更新:

Result DescribeCdnConfigResult
DomainConfig DomainVolcanoDetail

参数新增

AreaAccessRule:类型 *AreaAccessRule
CustomErrorPage:类型 *CustomErrorPage
MethodDeniedRule:类型 *MethodDeniedRule
OriginArg:类型 []OriginArgRule
OriginSni:类型 *OriginSni
RedirectionRewrite:类型 *RedirectionRewrite
RemoteAuth:类型 *RemoteAuth
UaAccessRule:类型 *UserAgentAccessRule

参数变更与名称变更

BandwidthLimit 类型由 BandwidthLimit 修改为 *BandwidthLimit
BandwidthLimit *BandwidthLimit:
Switch 类型由 bool 修改为 *bool
Cname 类型由 str 修改为 *str
Compression 类型由 Compression 修改为 *Compression
Compression *Compression:
Switch 类型由 bool 修改为 *bool
Domain 类型由 str 修改为 *str
DownloadSpeedLimit 类型由 DownloadSpeedLimit 修改为 *DownloadSpeedLimit
FollowRedirect 类型由 bool 修改为 *bool
HTTPS 类型由 HTTPS 修改为 *HTTPS
HTTPS []HTTPS 结构体存在修改
OriginRule []OriginRule 结构体存在修改
NegativeCache 的类型名称由 []NegativeCacheRule 修改为 []NegativeCache。同时 NegativeCache 结构体引入了变更。
HttpForcedRedirect 类型由 HttpForcedRedirect 修改为 *HttpForcedRedirect
IPv6 类型由 IPv6 修改为 *IPv6
IPv6 *IPv6:
Switch 类型由 bool 修改为 *bool
IpAccessRule 类型由 IpAccessRule 修改为 *IpAccessRule
IpAccessRule *IpAccessRule:
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
IpFreqLimit 类型由 IpFreqLimit 修改为 *IpFreqLimit
IpFreqLimit []IpFreqLimit 结构体存在修改
IpSpeedLimit 类型由 IpSpeedLimit 修改为 *IpSpeedLimit
IpSpeedLimit [IpSpeedLimit](#ipspeedlimit) 存在修改
OriginAccessRule 类型由 OriginAccessRule 修改为 *OriginAccessRule
OriginAccessRule *OriginAccessRule:
AllowEmpty 类型由 bool 修改为 *bool
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
OriginHost 类型由 str 修改为 *str
OriginRange 类型由 bool 修改为 *bool
Project 类型由 str 修改为 *str
Quic 类型由 Quic 修改为 *Quic
Quic *Quic:
Switch 类型由 bool 修改为 *bool
RefererAccessRule 类型由 RefererAccessRule 修改为 *RefererAccessRule
RefererAccessRule *RefererAccessRule:
AllowEmpty 类型由 bool 修改为 *bool
RuleType 类型由 str 修改为 *str
Switch 类型由 bool 修改为 *bool
ServiceRegion 类型由 str 修改为 *str
ServiceType 类型由 str 修改为 *str
SignedUrlAuth 类型由 SignedUrlAuth 修改为 *SignedUrlAuth
SignedUrlAuth *SignedUrlAuth 结构体存在修改
Cache 数据类型 []CacheControlRule 结构体存在修改
CaCheKey []CacheKeyGenerationRule 结构体存在修改
DownloadSpeedLimit *DownloadSpeedLimit 结构体存在修改
Status 类型由 str 修改为 *str
UpdateTime 类型由 int 修改为 *int
VideoDrag 类型由 VideoDrag 修改为 *VideoDrag
VideoDrag *VideoDrag:
Switch 类型由 bool 修改为 *bool

ListCdnDomainsRequest

参数新增

ExactMatch:类型 *bool
HTTPS:类型 *bool
IPv6:类型 *bool
OriginProtocol:类型 *str
PrimaryOrigin:类型 *str
Project:类型 *str
ServiceRegion:类型 *str
TagConnective:类型 *str

ListCdnDomainsResponse

Result ListCdnDomainsResult
名称变更:Data 类型由 []DomainSummary 修改为 []ListCdnDomainDomain

同时,ListCdnDomainDomain 结构体存在以下修改。

参数新增

BackupOrigin:类型 []str
HTTPS:类型 bool
IPv6:类型 bool
OriginProtocol:类型 str
PrimaryOrigin:类型 []str
ResourceTags:类型 []ResourceTag

参数删除
Resources

参数变更
ResourceTags []ResourceTag 存在修改

AddResourceTagsRequest

名称变更

ResourceTags 的类型名称由 []ResourceTagEntry 修改为 []ResourceTag。同时 ResourceTag 结构体也引入了变更。

DeleteResourceTagsRequest

名称变更

ResourceTags 的类型名称由 []ResourceTagEntry 修改为 []ResourceTag。同时 ResourceTag 结构体也引入了变更。

UpdateResourceTagsRequest

名称变更

ResourceTags 的类型名称由 []ResourceTagEntry 修改为 []ResourceTag。同时 ResourceTag 结构体也引入了变更。

ListResourceTagsResponse

名称变更

ResourceTags 的类型名称由 []ResourceTagEntry 修改为 []ResourceTag。同时 ResourceTag 结构体也引入了变更。

DescribeAccountingDataRequest

参数新增

BillingRegion:类型 *str
Interval:类型 *int
IsWildcardDomain:类型 *bool
Protocol:类型 *str

DescribeAccountingDataResponse

Result DescribeAccountingDataResult
名称变更: Resources 的类型名称由 []ResourceStatData 修改为 []AccountingDataDetail
Resources []AccountingDataDetail
参数新增: BillingRegion 类型 str
名称变更:Metrics 的类型名称由 []MetricStatData 修改为 []AccountingData
Metrics []AccountingData
名称变更:Values 的类型名称由 []TimeSeriesData 修改为 []DataPoint
Values []DataPoint
名称变更: Timestamp 的参数名称修改为 TimeStamp

DescribeContentBlockTasksResponse

Result DescribeContentBlockTasksResult:
名称变更: Data 的类型名称由 []ContentTask 修改为 []DescribeContentBlockTasksTaskInfo

DescribeCdnDataResponse

Result DescribeCdnDataResult
名称变更:Resources 的类型名称由 []ResourceStatData 修改为 []NrtDataResource
Resources []NrtDataResource
参数新增: BillingRegion 类型 str
名称变更:Metrics 的类型名称由 []MetricStatData 修改为 []MetricTimestampValue
Metrics []MetricTimestampValue
名称变更:Values 的类型名称由 []TimeSeriesData 修改为 []TimestampValue

DescribeCdnAccessLogRequest

参数新增
ServiceRegion:类型 *str

DescribeCdnDataRequest

参数新增
DisaggregateMetrics:类型 *str
IsWildcardDomain:类型 *bool

DescribeCdnDataDetailResponse

Result: DescribeCdnDataDetailResult
名称变更:Domain 的参数名称修改为 Name
名称变更:DataDetails 的类型名称由 []DataDetail 修改为 []NrtDataDetails
DataDetails []NrtDataDetails
名称变更:Metrics 的类型名称由 []MetricStatData 修改为 []MetricTimestampValue
Metrics []MetricTimestampValue
名称变更:Values 的类型名称由 []TimeSeriesData 修改为 []TimestampValue

DescribeCdnOriginDataRequest

参数新增
DisaggregateMetrics:类型 *str
IsWildcardDomain:类型 *bool

DescribeCdnOriginDataResponse

Result DescribeCdnOriginDataResult
名称变更:Resources 的类型名称由 []ResourceStatData 修改为 []NrtDataResource
Resources []NrtDataResource
参数新增: BillingRegion 类型 str
名称变更:Metrics 的类型名称由 []MetricStatData 修改为 []MetricTimestampValue
Metrics []MetricTimestampValue
名称变更:Values 的类型名称由 []TimeSeriesData 修改为 []TimestampValue

DescribeContentBlockTasksRequest

参数新增
URL:类型 *str

参数删除
Url
Domain

参数变更
EndTime 类型由 int 修改为 *int
StartTime 类型由 int 修改为 *int

DescribeCdnServiceResponse

Result DescribeCdnServiceResult
名称变更:ServiceInfos 的类型名称由 []ServiceInformation 修改为 []TopInstanceDetail
ServiceInfos []TopInstanceDetail
参数新增:InstanceCategory 类型 str
参数新增:MetricType 类型 str
参数新增:ServiceRegion 类型 str

DescribeCdnUpperIpRequest

参数变更
IpVersion 类型由 str 修改为 *str

DescribeContentTasksRequest

参数新增
Remark:类型 *str

参数变更
EndTime 类型由 int 修改为 *int
StartTime 类型由 int 修改为 *int

DescribeContentTasksResponse

Result DescribeContentTasksResult
Data []ContentTask
参数新增:Process 类型 str
参数新增:Remark 类型 str

DescribeEdgeNrtDataSummaryRequest

参数新增
DisaggregateMetrics:类型 *str

DescribeEdgeNrtDataSummaryResponse

Result DescribeEdgeNrtDataSummaryResult
名称变更:Resources 类型由 []ResourceSummary 修改为 []NrtDataSummaryResource
Resources []NrtDataSummaryResource
参数新增:BillingRegion 类型 str
名称变更:Metrics 的类型名称由 []MetricSummary 修改为 []MetricValue

DescribeEdgeStatisticalDataRequest

参数变更
Domain 类型由 str 修改为 *str

DescribeEdgeStatisticalDataReponse

Result DescribeEdgeStatisticalDataResult
名称变更: Resources 的类型名称由 []ResourceStatData 修改为 []EdgeStatisticalDataResource
Resources []EdgeStatisticalDataResource
名称变更: Metrics 的类型名称由 []MetricStatData 修改为 []AccountingData
Metrics []AccountingData
名称变更: Values 的类型名称由 []TimeSeriesData 修改为 []DataPoint
Values []DataPoint
名称变更: Timestamp 的参数名称修改为 TimeStamp

DescribeEdgeTopNrtDataResponse

名称变更
TopDataDetails 的类型名称由 []TopDetail 修改为 []TopNrtDataDetail

DescribeEdgeTopStatisticalDataRequest

参数变更
Metric 类型由 *str 修改为 str

DescribeEdgeTopStatisticalDataResponse

Result DescribeEdgeTopStatisticalDataResult
参数新增:Item 类型 str
参数新增:Metric 类型 str
名称变更:Domain 的参数名称修改为 Name
名称变更:TopDataDetails 的类型名称由 []TopDataDetail 修改为 []EdgeTopStatisticalDataDetail

DescribeEdgeTopStatusCodeRequest

参数新增
BillingRegion:类型 *str

DescribeEdgeTopStatusCodeResponse

名称变更
TopDataDetails 的类型名称由 []TopStatusDetail 修改为 []TopStatusCodeDetail

DescribeOriginNrtDataSummaryRequest

参数新增
Area:类型 *str
DisaggregateMetrics:类型 *str
IpVersion:类型 *str
Isp:类型 *str
Protocol:类型 *str
Region:类型 *str

DescribeOriginNrtDataSummaryResponse

Result DescribeOriginNrtDataSummaryResult
名称变更:Resources 类型由 []ResourceSummary 修改为 []NrtDataSummaryResource
Resources []NrtDataSummaryResource
参数新增:BillingRegion 类型 str
名称变更:Metrics 的类型名称由 []MetricSummary 修改为 []MetricValue

DescribeOriginTopNrtDataRequest

参数新增
Area:类型 *str

参数变更
EndTime 类型由 *int 修改为 int
StartTime 类型由 *int 修改为 int

DescribeOriginTopNrtDataResponse

Result DescribeOriginTopNrtDataResult
名称变更:TopDataDetails 的类型名称由 []TopDetail 修改为 []TopNrtDataDetail
TopDataDetails []TopNrtDataDetail
参数新增: Quic 类型 int

DescribeOriginTopStatusCodeRequest

参数新增
Area:类型 *str
BillingRegion:类型 *str

DescribeOriginTopStatusCodeResponse

Result DescribeOriginTopStatusCodeResult
名称变更:TopDataDetails 的类型名称由 []TopStatusDetail 修改为 []TopStatusCodeDetail

DescribeIPListInfoResponse

名称变更
Result 的类型名称由 []DescribeIPInfoResult 修改为 []IPInfo

SubmitBlockTaskRequest

参数新增
Persistent:类型 *bool

BaseModel

CacheControlRule

参数变更: Condition *Condition 结构体存在修改
CacheAction *CacheAction
参数变更:Action 类型由 str 修改为 *str
参数变更:Ttl 类型由 int 修改为 *int

CacheKeyGenerationRule

参数变更: Condition *Condition 结构体存在修改
CacheKeyAction *CacheKeyAction
CacheKeyComponents []CacheKeyComponent
参数变更:Action 类型由 str 修改为 *str
参数变更:IgnoreCase 类型由 bool 修改为 *bool
参数变更:Object 类型由 str 修改为 *str
参数变更:Subobject 类型由 str 修改为 *str

DownloadSpeedLimit

DownloadSpeedLimitRules []DownloadSpeedLimitRule
参数变更: Condition *Condition 结构体存在修改
DownloadSpeedLimitAction *DownloadSpeedLimitAction
参数新增: SpeedLimitTime 类型 *SpeedLimitTime
参数删除: DownloadSpeedLimitRate
参数删除: DownloadSpeedLimitRateAfter
参数变更: SpeedLimitRate 类型由 int 修改为 *int
参数变更: SpeedLimitRateAfter 类型由 int 修改为 *int

HTTPS

参数新增: OCSP 类型 *bool
参数变更:DisableHttp 类型由 bool 修改为 *bool
参数变更:HTTP2 类型由 bool 修改为 *bool
参数变更:Switch 类型由 bool 修改为 *bool
参数变更:CertInfo *CertInfo 结构体存在修改
参数变更:ForcedRedirect []ForcedRedirect 结构体存在修改

CertInfo

参数新增: CertName 类型 *str
参数新增: ConfiguredDomain 类型 *str
参数新增: Desc 类型 *str
参数新增: DnsName 类型 *str
参数新增: EffectiveTime 类型 *int
参数新增: Source 类型 *str
参数新增: Status 类型 *str
参数变更: CertId 类型由 str 修改为 *str
Certificate *Certificate
参数变更: Certificate 类型由 str 修改为 *str
参数变更: PrivateKey 类型由 str 修改为 *str

ForcedRedirect

参数变更:EnableForcedRedirect 类型由 bool 修改为 *bool
参数变更:StatusCode 类型由 str 修改为 *str

ResourceTag

参数变更:Key 类型由 str 修改为 *str
参数变更:Value 类型由 str 修改为 *str

NegativeCache

参数变更:NegativeCacheRule 类型由 NegativeCacheAction 修改为 *NegativeCacheAction
参数变更:Condition *Condition 结构体存在修改
NegativeCacheRule *NegativeCacheAction
参数变更:Action 类型由 str 修改为 *str
参数变更:StatusCode 类型由 str 修改为 *str
参数变更:Ttl 类型由 int 修改为 *int

OriginRule

参数变更:OriginAction 类型由 OriginAction 修改为 *OriginAction
参数变更:Condition *Condition 结构体存在修改
OriginAction *OriginAction
OriginLines []OriginLine
参数新增: OriginHost 类型 *str
参数变更:Address 类型由 str 修改为 *str
参数变更:HttpPort 类型由 str 修改为 *str
参数变更:HttpsPort 类型由 str 修改为 *str
参数变更:InstanceType 类型由 str 修改为 *str
参数变更:OriginType 类型由 str 修改为 *str
参数变更:Weight 类型由 str 修改为 *str

BandwidthLimit

参数变更:Switch 类型由 bool 修改为 *bool
参数变更:Condition *Condition 结构体存在修改
BandwidthLimitRule *BandwidthLimitRule
BandwidthLimitAction *BandwidthLimitAction
参数变更:BandwidthThreshold 类型由 int 修改为 *int
参数变更:LimitType 类型由 str 修改为 *str
参数变更:SpeedLimitRate 类型由 int 修改为 *int

IpFreqLimit

参数变更:Switch 类型由 bool 修改为 *bool
IpFreqLimitRules []IpFreqLimitRule
参数变更:Condition *Condition 结构体存在修改
IpFreqLimitAction *IpFreqLimitAction
参数新增:StatusCode 类型 *str
参数删除: StateCode
参数变更: Action 类型由 str 修改为 *str
参数变更: FreqLimitRate 类型由 int 修改为 *int

IpSpeedLimit

参数变更: Switch 类型由 bool 修改为 *bool
IpSpeedLimitRules []IpSpeedLimitRule
参数变更:Condition *Condition 结构体存在修改
IpSpeedLimitAction *IpSpeedLimitAction
参数变更:SpeedLimitRate 类型由 int 修改为 *int

SignedUrlAuth

参数变更: Switch 类型由 bool 修改为 *bool
SignedUrlAuthRules []SignedUrlAuthRule
参数变更: Condition *Condition 结构体存在修改
SignedUrlAuthAction *SignedUrlAuthAction
参数新增: RewriteM3u8 类型 *bool
参数变更: BackupSecretKey 类型由 str 修改为 *str
参数变更: Duration 类型由 int 修改为 *int
参数变更: MasterSecretKey 类型由 str 修改为 *str
参数变更: SignName 类型由 str 修改为 *str
参数变更: TimeFormat 类型由 str 修改为 *str
参数变更: TimeName 类型由 str 修改为 *str
参数变更: URLAuthType 类型由 str 修改为 *str

Condition

参数变更:Connective 类型由 str 修改为 *str
ConditionRule []ConditionRule
参数变更:Object 类型由 str 修改为 *str
参数变更:Operator 类型由 str 修改为 *str
参数变更:Type 类型由 str 修改为 *str
参数变更:Value 类型由 str 修改为 *str