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

【产品变更】SDK 变更说明

最近更新时间2023.11.09 15:56:12

首次发布时间2022.11.23 15:23:23

火山引擎内容分发网络 SDK 新版本上线了。

说明

更新说明

发布日期
2022年11月25日

发布版本

  • Volcengine SDK for Go:1.0.71
  • Volcengine SDK for Python:1.0.64
  • Volcengine SDK for PHP:1.0.55
  • Volcengine SDK for Java:1.0.70

包含更新

  • 在 Volcengine SDK for Go 的部分 API 中,某些参数的数据类型变更为指针。如果您计划更新 SDK,参见 Volcengine SDK for Go 更新说明
  • 在 Volcengine SDK for Java 的部分 API 中,某些结构体名称和参数名称有变更。如果您计划更新 SDK,参见 Volcengine SDK for Java 更新说明。在您更新 SDK 后,如果收到了类似 无法找到该类型 的错误消息,您需要调整代码。
  • 在 Volcengine SDK for Python 中,有一个 API 的名称发生了变更。如果您计划更新 SDK,参见 Volcengine SDK for Python 更新说明
  • 以下更新适用于所有语言的 Volcengine SDK:
    • 新增了证书相关的 API。参见新增 API
    • 更新了部分 API 的参数。参见 API 参数更新
    • ResponseMetadata 中,RequestID 变更为 RequestId

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

Volcengine SDK for Go 更新说明

在 Volcengine SDK for Go 的部分 API 中,某些参数的数据类型变更为指针。以下表格列出了受影响的 API。

API 名称API 功能变更为指针类型的参数
AddCdnDomain添加加速域名参见 AddCdnDomainRequest 参数。
UpdateCdnConfig修改加速域名配置与 AddCdnDomain 相同。
DescribeCdnConfig获取加速域名配置参见 DescribeCdnConfigResponse 参数。
DescribeContentTasks获取刷新与预热任务列表EndTime、StartTime
DescribeContentBlockTasks获取 URL 封禁与解封任务列表Url、Domain、EndTime、StartTime
DescribeCdnUpperIp获取回源层节点的所有 IPIpVersion
DescribeCdnDataDetail获取单个域名的省份和 ISP 的细分数据Domain
DescribeEdgeStatisticalData获取独立访客的细分数据Domain
DescribeEdgeTopStatisticalData获取热点及访客的统计排名Metric
DescribeEdgeTopNrtData获取访问数据的统计排名EndTime、StartTime
DescribeOriginTopNrtData获取回源数据的统计排名EndTime、StartTime

代码调整示例

以 AddCdnDomain 为例,以下的截图演示了如何调整代码。图中红色底色的代码是需要调整的代码,黄色底色的代码是调整后的代码。
alt

Volcengine SDK for Java 更新说明

在 Volcengine SDK for Java 中的 API 中,某些结构体名称和参数名称有变更。以下表格列出了受影响的 API。

API 名称API 功能发生名称变更的参数

AddCdnDomain

添加加速域名

在 AddCdnDomainRequest 参数中:

  • NegativeCache 的类型名称由 NegativeCacheRule[] 变更为 NegativeCache[]

  • ResourceTags 的类型名称由ResourceTagEntry[] 变更为 ResourceTag[]

UpdateCdnConfig

修改加速域名配置

在 UpdateCdnConfigRequest 参数中:

  • NegativeCache 的类型名称由NegativeCacheRule[] 变更为 NegativeCache[]

AddResourceTags

添加资源标签

在 AddResourceTagsRequest 参数中:

  • ResourceTags 的类型名称由ResourceTagEntry[] 变更为 ResourceTag[]

DeleteResourceTags

删除资源标签

在 DeleteResourceTagsRequest 参数中:

  • ResourceTags 的类型名称由ResourceTagEntry[] 变更为 ResourceTag[]

UpdateResourceTags

更新资源标签

在 UpdateResourceTagsResponse 参数中:

  • ResourceTags 的类型名称由ResourceTagEntry[] 变更为 ResourceTag[]

ListResourceTags

查询标签清单

在 ListResourceTagsResponse 参数中:

  • ResourceTags 的类型名称由ResourceTagEntry[] 变更为 ResourceTag[]

DescribeAccountingData

获取计费指标的细分数据

在 DescribeAccountingDataResponse 参数中:

  • Resources 的类型名称由ResourceStatData[] 变更为 AccountingDataDetail[]

  • Metrics 的类型名称由MetricStatData 变更为 []AccountingData[]

  • Values 的类型名称由TimeSeriesData[] 变更为 DataPoint[]

  • Timestamp 的参数名称变更为 TimeStamp

DescribeCdnConfig

获取域名配置详情

在 DescribeCdnConfigResponse 参数中:

  • DomainConfig 的类型名称由 DomainConfig 变更为 DomainVolcanoDetail

  • NegativeCache 的类型名称由NegativeCacheRule[] 变更为 NegativeCache[]

DescribeCdnDataDetail

获取单个省份和运营商的细分数据

在 DescribeCdnDataDetailResponse 参数中:

  • Domain 的参数名称变更为 Name

  • DataDetails 的类型名称由DataDetail[] 变更为 NrtDataDetails[]

  • Metrics 的类型名称由MetricStatData 变更为 MetricTimestampValue

  • Values 的类型名称由TimeSeriesData[] 变更为 TimestampValue[]

DescribeCdnData

获取访问统计的细分数据

在 DescribeCdnDataResponse 参数中:

  • Resources 的类型名称由ResourceStatData[] 变更为 NrtDataResource[]

  • Metrics 的类型名称由MetricStatData[] 变更为 MetricTimestampValue[]

  • Values 的类型名称由TimeSeriesData[] 变更为 TimestampValue[]

DescribeCdnOriginData

获取回源统计的细分数据

在 DescribeCdnOriginDataResponse 参数中:

  • Resources 的类型名称由ResourceStatData[] 变更为 NrtDataResource[]

  • Metrics 的类型名称由MetricStatData[] 变更为 MetricTimestampValue[]

  • Values 的类型名称由TimeSeriesData[] 变更为 TimestampValue[]

DescribeCdnService

获取服务相关信息

在 DescribeCdnServiceResponse 参数中:

  • ServiceInfos 的类型名称由ServiceInformation[] 变更为 TopInstanceDetail[]

DescribeContentBlockTasks

获取封禁解封任务信息

在 DescribeContentBlockTasksResponse 参数中:

  • Data 的类型名称由ContentTask[] 变更为 DescribeContentBlockTasksTaskInfo[]

DescribeEdgeNrtDataSummary

获取访问统计的汇总数据

在 DescribeEdgeNrtDataSummaryResponse 参数中:

  • Resources 的类型名称由ResourceSummary[] 变更为 NrtDataSummaryResource[]

  • Metrics 的类型名称由MetricSummary[] 变更为 MetricValue[]

DescribeEdgeStatisticalData

获取独立访客的细分数据

在 DescribeEdgeStatisticalDataResponse 参数中:

  • Resources 的类型名称由ResourceStatData[] 变更为 EdgeStatisticalDataResource[]

  • Metrics 的类型名称由MetricStatData[] 变更为 AccountingData[]

  • Values 的类型名称由TimeSeriesData[] 变更为 DataPoint[]

  • Timestamp 的参数名称变更为 TimeStamp

DescribeEdgeTopNrtData

获取访问数据的统计排序

在 DescribeEdgeTopNrtDataResponse 参数中:

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

DescribeEdgeTopStatisticalData

获取热点及访客统计排序

在 DescribeEdgeTopStatisticalDataResult 参数中:

  • TopDataDetails 的类型名称由TopDataDetail[] 变更为 EdgeTopStatisticalDataDetail[]

DescribeEdgeTopStatusCode

获取访问状态码的统计排序

在 DescribeEdgeTopStatusCodeResponse 参数中:

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

DescribeIPListInfo

批量获取 IP 归属信息

在 DescribeIPListInfoResponse 参数中:

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

DescribeOriginNrtDataSummary

获取回源统计的汇总数据

在 DescribeOriginNrtDataSummaryResponse 参数中:

  • Resources 的类型名称由ResourceSummary[] 变更为 NrtDataSummaryResource[]

  • Metrics 的类型名称由MetricSummary[] 变更为 MetricValue[]

DescribeOriginTopNrtData

获取回源数据的统计排序

在 DescribeOriginTopNrtDataResponse 参数中:

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

DescribeOriginTopStatusCode

获取回源状态码的统计排序

在 DescribeOriginTopStatusCodeResponse 参数中:

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

ListCdnDomains

获取域名列表

在 ListCdnDomainsResponse 参数中:

  • Data 的类型名称由DomainSummary[] 变更为 ListCdnDomainDomain[]

升级示例

以 AddCdnDomain 为例,以下的截图演示了如何调整代码。图中红色底色的代码是需要调整的代码,绿色底色的代码是调整后的代码。
alt

Volcengine SDK for Python 更新说明

Volcengine SDK for Python 中有一个 API 的名称发生了变更。以下表格列出了受影响的 API。

API 名称API 功能变更后的 API 名称
describe_iplist_info批量获取 IP 归属信息describe_ip_list_info

新增 API

新版本的 SDK 新增了以下 API:

如何查看您使用的 SDK 版本

在您升级 SDK 前,您可能需要检查您当前正在使用的 SDK 的版本。SDK 的版本就是 SDK 安装包的版本。包版本的查看方法依赖于安装包的工具。以下列表展示了如何在常用的包安装工具中查看 SDK 安装包的版本。

  • Volcengine SDK for Go:您可以打开 go.mod 文件来查看包的版本。
  • Volcengine SDK for Python:如果您使用 pip 安装 SDK,您可以使用 pip list 命令或者 pip show volcengine 命令来查看包的版本。
  • Volcengine SDK for PHP:如果您使用 Composer 安装 SDK,您可以使用 composer show volcengine/volc-sdk-php -i 命令来查看包的版本。
  • Volcengine SDK for Java:如果您使用 Maven 安装 SDK,可以在 pom.xml 文件的目录下运行 mvn -Dverbose dependency:tree 命令来查看包的版本。