获取SAG设备全局路由协议,适用于设备类型为SCG5000或SCG5000-5G的智能接入网关实例,且设备版本为3.4.2及以上。
接口说明
目前仅设备版本为 3.4.2 及以上的 SCG5000 和 SCG5000-5G 设备支持获取智能接入网关设备全局路由协议。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smartag:ViewSmartAccessGatewayGlobalRouteProtocol | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SagInsId | string | 是 | 智能接入网关实例 ID。 | sag-iv408aov6k7xxm**** |
SagSn | string | 是 | 智能接入网关设备序列号。 | sagf4ea**** |
RegionId | string | 是 | 智能接入网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
CrossAccount | boolean | 否 | 是否只查询跨账号所属的智能接入网关实例。取值:
| false |
ResourceUid | string | 否 | 智能接入网关实例所属的阿里云账号(主账号)ID。 | 109790620697**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RouteProtocol": "STATIC",
"RequestId": "D10FFDB2-AF7D-530A-A2AC-EBDC16500399",
"TaskStates": [
{
"ErrorMessage": "Successful",
"State": "Succeed",
"ErrorCode": "200",
"CreateTime": "1586843621000"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | GATEWAY.InvalidSN | The specified gateway serial number does not exist. |
400 | MissParameter.GatewayId | The input parameter GatewayId that is mandatory for processing this model is not supplied. |
400 | DeviceNotExist | The specified device does not exist |
访问错误中心查看更多错误码。