文档

ListAvailableServiceAddress - 查询服务地址信息

查询指定智能接入网关设备配置的服务地址信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:ListAvailableServiceAddressList
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAgId}

请求参数

名称类型必填描述示例值
RegionIdstring

智能接入网关实例所属地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
AddressTypestring

智能接入网关实例服务地址类型,当前支持的取值:

  • ProbeTask:拨测源 IP。
  • RemoteWeb:远程登录 IP。
说明 若不传值则查询所有的服务地址。
ProbeTask
SagIdstring

智能接入网关实例 ID。

sag-****
Snstring

智能接入网关设备序列号。

sag****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

324223F3-93D3-4CE4-B26F-66C0C3809922
Codestring

响应码。

200
Messagestring

响应消息。

Success
Dataobject []
Addressstring

服务地址。

192.168.1.1
AddressTypestring

服务地址类型。

ProbeTask

示例

正常返回示例

JSON格式

{
  "RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code": "200",
  "Message": "Success",
  "Data": [
    {
      "Address": "192.168.1.1",
      "AddressType": "ProbeTask"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidId.SNThe specified smart access gateway serial number does not exist.输入的SAG序列号不存在。
400InvalidServiceAddressTypeThe specified service address type is invalid.服务地址类型不合法。
403InvalidId.SMARTAGThe specified smart access gateway instance id is invalid.无效的智能接入网关实例ID。

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

  • 本页导读 (1)
文档反馈