ListAPNs - 查询APN

查询云连接器实例支持的APN列表。

调试

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

授权信息

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

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

请求参数

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

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值:1~50。默认值:10

10
RegionIdstring

云连接器实例所在的地域 ID。

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

cn-hangzhou
APNstring

运营商 APN ID。

CMWAP
ISPstring

APN 对应的运营商。取值:

  • telecom:中国电信。

  • mobile:中国移动。

  • unicom:中国联通。

mobile
Typestring

云连接器实例的版本,不同版本有不同功能限制和计费策略。取值:

  • Basic:基础版。

  • Standard:标准版。

云连接器实例默认创建标准版,如果需要创建基础版实例,请提交工单申请。

Standard

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCountinteger

总列表条目数。

1
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

10
APNsarray<object>

APN 列表。

ioTCloudConnectorGatewayModelobject

APN 列表。

ISPstring

APN 对应的运营商。取值:

  • telecom:中国电信。
  • mobile:中国移动。
  • unicom:中国联通。
mobile
APNstring

运营商 APN ID。

CMWAP
Namestring

APN 名称。

test
Descriptionstring

APN 的描述信息。

test
ZoneListarray

APN 所属可用区列表。 根据可用区列表,可以过滤出可使用的交换机列表。

zonestring

APN 所属可用区列表。 根据可用区列表,可以过滤出可使用的交换机列表。

["eu-central-1a", "eu-central-1b"]
FeatureListarray

当前 APN 属性,取值:

  • trafficMirror:流量镜像。
  • wildcardDomain:泛域名。
featurestring

当前 APN 属性,取值:

  • trafficMirror:流量镜像。
  • wildcardDomain:泛域名。
trafficMirror

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "APNs": [
    {
      "ISP": "mobile",
      "APN": "CMWAP",
      "Name": "test",
      "Description": "test",
      "ZoneList": [
        "[\"eu-central-1a\", \"eu-central-1b\"]"
      ],
      "FeatureList": [
        "trafficMirror"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更查看变更详情