调用ModifySmartAccessGateway修改智能接入网关的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smartag:ModifySmartAccessGateway | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SmartAGId | string | 是 | 智能接入网关实例 ID。 | sag-0ovhf732a9j0****** |
Name | string | 否 | 智能接入网关的名称。 长度为 2~128 个字符,必须以字母或中文开头,可包含数字,点号(.),下划线(_)和短横线(-)。 | SAG |
Description | string | 否 | 智能接入网关的描述。 长度为 2~256 个字符,必须以字母或中文开头,但不能以 | SAG描述 |
CidrBlock | string | 否 | 线下机构客户端用来通信的私网网段,确保各私网网段不冲突。 如果智能接入网关终端设备的 LAN 口配置为动态方式,则线下已开启 DHCP 的客户端使用的 IP 地址会从您指定的第一个私网网段中分配。 | 172.16.0.0/24 |
RegionId | string | 是 | 智能接入网关的所属区域。 | cn-hangzhou |
SecurityLockThreshold | integer | 否 | 离线锁定功能用户设定的阈值,大于等于 0。 单位:秒。 | 3 |
RoutingStrategy | string | 否 | 线下路由同步方式:
| static |
Position | string | 否 | 智能接入网关所部署的位置。 | [ { "adcode":"", "label":"浙江省杭州市xx区xx路xx号", "value":"B0FFGxxxx", "center":"120.190xxxx, 30.182xxxx", "_new":"true" } ] |
EnableSoftwareConnectionAudit | boolean | 否 | 是否开启 SAG App 连接日志审计。
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SAG.IpCountTooLittle | The number of available IP addresses of the CIDR block is fewer than the number of SslConnectionSpec. | 地址段可用IP数少于连接数。 |
400 | SAG.SslConnectionSpecInvalid | The number of SslConnectionSpec is invalid. | 连接数非法。 |
400 | SAG.CcnCidrNoConfig | You must configure the CIDR block of CCN. | 绑定的云连接网地址段未配置。 |
400 | SAG.CidrEmpty | You must specify the CIDR blocks of SAG. | 智能网关地址段为空。 |
400 | SAG.ConflictCidr.CcnSnatCidr | The SAG CIDR block is in conflict with the CCN CIDR block. | 智能网关地址段与云连接网地址段冲突。 |
400 | SAG.ConflictSnatIp | The specified SNAT IP address is invalid. | 指定的SNAT IP存在冲突。 |
400 | SAG.InstanceIdEmpty | You must specify the SAG instance ID. | 智能接入网关实例ID为空。 |
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能接入网关实例不存在。 |
400 | SAG.InvalidCidr | The specified CIDR block is invalid. | 智能网关地址段非法。 |
400 | SAG.InvalidCidr.NoBelongCcnCidr | The specified SAG CIDR block does not belong to the CCN CIDR block. | 智能网关地址段不属于云接网地址段。 |
400 | SAG.InvalidSnatCidr | The specified SNAT CIDR block is invalid. | 智能网关SNAT CIDR非法。 |
400 | SAG.InvalidSnatIp | The specified SNAT IP address is invalid. | 智能网关SNAT IP非法。 |
400 | CCN.CidrEmpty | You must specify the CCN CIDR block. | 云连接网的地址段为空。 |
400 | CCN.SnatCidrConflict | The specified SNAT CIDR block is invalid. | 指定的SNAT地址段存在冲突。 |
400 | ActionNotSupport | The specified instance does not support this action. | 当前实例不支持此功能。 |
400 | CCN.SnatCidrNoConfig | You must configure the SNAT CIDR block of the CCN. | 云连接网的SNAT地址段尚未配置。 |
400 | SAG.CidrUsedByRoutableAddress | A routable internal IP address belongs to the specified internal CIDR block. You cannot modify this CIDR block. | 当前修改的私网地址段已经被私网可路由地址使用,无法修改。 |
400 | InvalidName | The specified name is invalid. | 您输入的名称不合法。 |
400 | SAG.CidrAmountLimit | The maximum number of static routes for the SAG instance is exceeded. | 智能接入网关实例设置的静态路由已经到达上限。 |
400 | SAG.InvalidCidrFormat | The specified CIDR format is invalid. | 私网地址段格式非法。 |
400 | SAG.CidrOverlap | The specified CIDR overlaps with an existing CIDR. | 存在重叠私网地址段。 |
400 | SAG.Arrearage | The specified SAG instance has overdue payments. Renew the instance first. | 智能接入网关实例已经欠费,请先续费。 |
400 | SAG.NoActive | The specified SAG instance has not been activated. | 智能接入网关实例还未激活,请先激活。 |
400 | SAG.NotAllowConfigCidr | You cannot specify a static CIDR block when the dynamic routing strategy is used. | 动态路由模式不允许配置静态地址段。 |
403 | CidrConflict | Cidr is conflict, Please Check your input. | - |
403 | MissingParameter | The input parameter is missing, please check your input. | 输入参数缺失,请检查您的输入。 |
403 | InvalidId.SMARTAG | The specified smart access gateway instance id is invalid. | 无效的智能接入网关实例ID。 |
403 | InvalidCidr | Cidr is illegal, please check your input. | Cidr不合法,请检查您的输入 |
403 | Forbidden | User not authorized to operate on the specified resource. | 用户没有操作此资源的权限。 |
403 | VbrConflict.ChangeSubnet | The subnet of the gateway conflicts with the VBR. Modify the subnet first. | 该智能接入网关的子网网段与VBR有冲突,请修改子网网段。 |
403 | VbrConflict.CreateBackup | The subnet of the gateway conflicts with the VBR. Create a backup relationship first. | 该智能接入网关的子网网段与VBR有冲突,请先创建专线备份。 |
403 | SmartAccessGatewayNotBind | The instance has not yet been bound. | 该实例未被绑定。 |
403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | 智能接入网关当前版本不支持该功能特性。 |
500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | 该智能接入网关已经到期停服,请续费。 |
500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | 该智能接入网关尚未激活,请先激活该实例。 |
500 | InternalError | An error occurred while processing your request. | 请求失败,发生未知错误。 |
访问错误中心查看更多错误码。