从 V2 Beta 版迁移

本页面适用于目前正在使用 Cloud Support API V2 Beta 版并希望迁移到 V2 的客户。

V2 使用入门

如果您已在使用 V2 Beta 版，则无需进行任何额外设置即可开始使用 V2。您可以使用相同的服务帐号和凭据。系统已经为您启用了该 API。

如需调用 V2 端点，只需将请求网址的 /v2beta/ 部分替换为 /v2/ 即可。例如，以下代码段展示了如何将 cases.get 调用从 V2 Beta 版升级到 V2：

V2 Beta 版：GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc

V2：GET https://cloudsupport.googleapis.com/v2/projects/123/cases/abc

对 SearchCases、Case.severity 和 Comment.plainTextBody 的重大更改

SearchCases 项端点更改

SearchCases 端点发生了以下变更：

  • 路径从：

    GET https://cloudsupport.googleapis.com/v2/cases:search

    to:

    GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search

  • filter 参数不再接受 project 或 organization 过滤器。相反，该网址中的项目/组织将用作搜索范围。

字段更改

这些字段发生了如下变化：

  • 移除了 cases 中的 severity 字段，改为使用 priority 字段。

  • 案例评论中的 plainTextBody 字段已移除，取而代之的是 body 字段。

我们为什么要进行这些更改？

  • 更改 SearchCases 路径

    • 定义搜索范围的旧方法令人困惑，并且不符合标准的 Google Cloud Platform API 设计做法。
    • 新方式可以使 SearchCases 与 API 中的其他端点（例如 ListCases）更加一致。

  • 移除 Case.severity 字段

    • 严重级别的用途与优先级相同，因此移除严重级别可以简化 API。

  • 移除 Comment.plainTextBody 字段

    • Comment.body 仅包含纯文本，因此与此字段重复，因此我们移除 plainTextBody 以简化 API。

如何适应这些变化

  • 从 SearchCase 请求中移除 project 和 organization 过滤条件，并改为在请求网址中声明它们。

  • 在您过去使用 severity 字段的位置使用 priority 字段。它们的语义含义非常相似，因此通常可以换掉这些引用。

  • 使用 body 字段，而不是 plainTextBody 字段。它们包含相同的信息。因此，很有可能将对 plainTextBody 的所有引用替换为 body。