OpenAPI最新变更

更新时间:
复制 MD 格式

本文介绍如何通过最新变更页面搜索、浏览、订阅OpenAPI发布与变更信息。

搜索变更

OpenAPI总是伴随新的需求不断迭代API能力,例如新增参数,新增OpenAPI,弃用参数,弃用OpenAPI等等,开发者若期望了解OpenAPI的能力变化,可通过最新变更页面查看各云产品各OpenAPI变更日志。以下以查找并浏览云服务器 ECS 的 OpenAPI 最新变更为例:

在最新变更页面,①在顶部搜索框中输入云产品名称(如云服务器 ECS)进行搜索;②在筛选区域中按产品类目(如弹性计算)、产品名称(如云服务器 ECS)和变更类型(全部、请求参数、返回参数、错误码、新增API、下线API、Deprecated)进一步筛选,页面下方即展示对应的 API 变更记录,包括变更日期、接口名称及变更内容。可单击订阅变更订阅关注产品的变更通知。

订阅变更

主动搜索的方式无法快速及时地同步到开发者,所以可以使用阿里云OpenAPI提供的API变更订阅能力,将变更信息及时地发送到指定钉群。

操作步骤

请按照如下步骤在钉钉群中添加自定义钉钉机器人并获取Webhook地址。

  1. 在PC版钉钉上打开您想要添加报警机器人的钉钉群,并单击右上角的群设置图标image.png。

  2. 在群设置面板中选择机器人,然后单击添加机器人。

  3. 在机器人面板选择添加机器人。

  4. 选择添加自定义(通过Wehbhook接入自定义服务),然后单击添加。

  5. 在添加机器人面板,设置如下参数,完成后勾选我已阅读并同意《自定义机器人服务及免责条款》,单击完成。

    参数

    说明

    机器人名字

    设置机器人名字为API变更消息。

    添加到群组

    API变更发送的群组。

    安全设置

    安全设置为自定义关键词,并输入自定义关键词变更。

    说明

    关键词必须按要求添加,未匹配关键词会导致消息发送失败。

  6. 在添加机器人对话框中复制Webhook地址,然后单击完成,即可在钉钉群中成功添加自定义钉钉机器人。

    更多关于Webhook的操作,参见自定义机器人接入。

    请妥善保管 Webhook 地址,不要公布在外部网站上,泄露有安全风险。

  7. 在OpenAPI门户顶部菜单栏,单击最新变更,进入最新变更页面查看阿里云产品API接口变更信息。

  8. 在最新变更页面,单击订阅变更,在订阅变更面板,选择订阅参数,通知类型选择Webhook,并将Webhook地址粘贴到联系方式输入框中,单击确认,完成订阅。

    Webhook地址格式示例:https://oapi.dingtalk.com/robot/send?access_token=XXXX。

  9. 订阅成功后,您可在钉钉群收到API变更消息通知。

    您也可快速验证Webhook地址是否正常接收消息,具体操作,请参见测试自定义机器人。