使用ViewSmartAccessGatewayDns查询智能接入网关设备DNS信息-智能接入网关-阿里云-智能接入网关(SAG)-阿里云帮助中心

接口说明

目前仅设备版本为 3.4.2 及以上的 SCG5000 和 SCG5000-5G 设备支持查询智能接入网关设备 DNS 信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

smartag:ViewSmartAccessGatewayDns

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SagInsId	string	是	智能接入网关实例 ID。	sag-sv487b7lno6go5****
SagSn	string	是	智能接入网关设备序列号。	sagf4ea****
RegionId	string	是	智能接入网关实例所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-shanghai
CrossAccount	boolean	否	是否只查询跨账号所属的智能接入网关实例。取值： false（默认值）：否。 true：是。	false
ResourceUid	string	否	智能接入网关实例所属的阿里云账号（主账号）ID。	109790620697****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	571AC2E7-8119-58E9-8BFA-1D580CBD1E56
SlaveDns	string	备 DNS 服务器 IP 地址。	8.8.XX.XX
TaskStates	array<object>	查询任务信息状态。
	object	查询任务信息状态。
ErrorMessage	string	错误信息。Successful 标识查询任务成功。	Successful
State	string	异步任务状态。取值： Initialized：查询任务初始化。 Offline：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后会继续下发。 Succeed：查询任务下发成功。 Processing：查询任务下发中。 VersionNotSupport：智能接入网关设备当前版本不支持。 BuildRequestError：管控不支持。 HardwareError：由于设备原因查询任务下发失败。 TaskNotExist：查询任务不存在。 OfflineNotConfiged：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后也不会下发。	Succeed
ErrorCode	string	错误码。200 标识查询任务成功。	200
CreateTime	string	查询任务创建时间。时间戳的格式采用 Unix 时间戳，表示从格林威治时间 1970 年 01 月 01 日 00 时 00 分 00 秒至创建查询任务时的总时长。	1586857309000
MasterDns	string	主 DNS 服务器 IP 地址。	114.114.XXX.XXX

示例

正常返回示例

JSON格式

{
  "RequestId": "571AC2E7-8119-58E9-8BFA-1D580CBD1E56",
  "SlaveDns": "8.8.XX.XX",
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586857309000"
    }
  ],
  "MasterDns": "114.114.XXX.XXX"
}

错误码

HTTP status code	错误码	错误信息	描述
400	GATEWAY.InvalidSN	The specified gateway serial number does not exist.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。
400	SAG.SoftwareNotSupport	The specified software instance does not support ACL.
400	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.	该智能接入网关尚未激活，请先激活该实例。
400	DeviceNotExist	The specified device does not exist
400	MissParameter.GatewayId	The input parameter GatewayId that is mandatory for processing this model is not supplied.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。