本页面适用于当前正在使用 V2 Alpha 版 Cloud Support API 并希望迁移到 V2 Beta 版的客户。
V2 Beta 版使用入门
如果您已经在使用 V2 Alpha 版,则无需执行任何额外的设置即可开始使用 V2 Beta 版。您可以使用相同的服务账号/凭据,并且系统已经为您启用 API。
如需调用 V2 Beta 版端点,只需将请求网址的 /v2alpha/
部分替换为 /v2beta/
即可。例如,下面演示了如何将 cases.get
调用从 V2 Alpha 版升级到 V2 Beta 版:
V2 Alpha 版:GET https://cloudsupport.googleapis.com/v2alpha/projects/123/cases/abc
V2 Beta 版:GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc
对案例分类的重大更改
从 V2 Alpha 版更改为 V2 Beta 版的唯一行为是案例分类类型。
V2 Alpha 版案例分类
字段 | 创建案例的必需参数。 | 说明 |
---|---|---|
productType
|
是 | string 分类对应的商品类型。 |
value
|
是 | string 在创建案例时使用的分类,例如“技术问题 > 计算 > Compute Engine” |
V2 Beta 版案例分类
字段 | 创建案例的必需参数。 | 说明 |
---|---|---|
id
|
是 | string 分类的唯一 ID。必须指定此字段才能创建案例。 |
displayName
|
否 | string 分类的显示名称。 |
我们为什么要进行这些更改?
移除
productType
字段- 早期的 API 设计要求我们添加此字段,但随着 API 的不断完善,它已过时。
- 此字段是必填字段,但唯一的有效值是
GOOGLE_CLOUD
。这会为每个案例创建请求添加样板。
将
value
分为id
和displayName
- V2 Alpha 版中的
value
字段必须是人类可读的(以便用户能够从选项列表中进行选择)以及机器可读(以便我们的 API 能够识要创建的案例类型)。 - V2 Beta 版将这些问题分为两个字段。
id
是分类的机器可读部分,displayName
是分类的人类可读的部分。 - 这使我们能够灵活地更改显示名称,而不会破坏 API 集成。例如,我们可能希望将来对
displayName
进行多次翻译,但id
在所有翻译上保持不变,因为它们代表相同的案例分类。
- V2 Alpha 版中的