文档

ListSmartAGByAccessPoint - 查询指定接入点下实例信息

更新时间:

查询指定地域内指定接入点下智能接入网关实例信息。

调试

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

授权信息

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

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

请求参数

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

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

一个地域内包含一个或多个接入点。您可以通过 ListAccessPoints 查看地域下的接入点信息。

cn-shanghai
PageSizeinteger

分页查询时每页的条目数。默认值为 10。最大值为 50

5
AccessPointIdinteger

接入点 ID。

238
PageNumberinteger

分页查询时的页码,默认值为 1

1
SmartAGStatusstring

智能接入网关实例状态。取值:

  • Active:可用。
  • Offline:离线。
Active

返回参数

名称类型描述示例值
object
TotalCountinteger

当前接入点下智能接入网关实例总个数。

16
RequestIdstring

请求 ID。

AE203140-5D0C-4B4D-88D1-D008206B3A01
SmartAccessGatewaysobject []

智能接入网关实例信息。

RoutingStrategystring

当前智能接入网关实例线下路由同步方式。取值:

  • static:静态路由。
  • dynamic:动态路由。
static
SmartAGNamestring

智能接入网关实例名称。

test
SmartAGIdstring

智能接入网关实例 ID。

sag-p86e06z4geaji1****
SmartAGStatusstring

智能接入网关实例状态:

  • Active:可用。
  • Offline:离线。
Active
SmartAGDescriptionstring

智能接入网关实例描述。

test
AssociatedCcnIdstring

智能接入网关实例绑定的云连接网实例 ID。

ccn-l42qf3vpvb****
HardwareVersionstring

智能接入网关实例绑定的设备类型。

  • sag-1000
  • sag-100WM
sag-1000

示例

正常返回示例

JSON格式

{
  "TotalCount": 16,
  "RequestId": "AE203140-5D0C-4B4D-88D1-D008206B3A01",
  "SmartAccessGateways": [
    {
      "RoutingStrategy": "static",
      "SmartAGName": "test",
      "SmartAGId": "sag-p86e06z4geaji1****",
      "SmartAGStatus": "Active",
      "SmartAGDescription": "test",
      "AssociatedCcnId": "ccn-l42qf3vpvb****",
      "HardwareVersion": "sag-1000"
    }
  ]
}

JSON格式

{
  "TotalCount": 16,
  "RequestId": "AE203140-5D0C-4B4D-88D1-D008206B3A01",
  "SmartAccessGateways": [
    {
      "RoutingStrategy": "static",
      "SmartAGName": "test",
      "SmartAGId": "sag-p86e06z4geaji1****",
      "SmartAGStatus": "Active",
      "SmartAGDescription": "test",
      "AssociatedCcnId": "ccn-l42qf3vpvb****",
      "HardwareVersion": "sag-1000"
    }
  ]
}

错误码

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

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