从 V2 Beta 版迁移

本页面适用于目前正在使用 V2 Beta 版 Cloud Support API 并希望迁移到 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 过滤条件。相反，来自网址的项目/组织将用作搜索范围。

字段更改

这些字段发生了以下变更：

  • 移除了 case 中的 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。