ListIpMappingRules - 查询授权规则IP重定向信息

更新时间:
复制 MD 格式

调用ListIpMappingRules接口查询授权规则IP重定向信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

iotcc:ListIpMappingRules

list

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#CloudConnectorId}

无 无

请求参数

名称

类型

必填

描述

示例值

IoTCloudConnectorId

string

是

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****

IpMappingRuleIds

array

否

需要进行 IP 重定向的授权规则的 ID。

string

否

需要进行 IP 重定向的授权规则的 ID。最多支持 20 个授权规则 ID。

im-irrp3bzuu5nrbx****

MappingIps

array

否

需要进行重定向的 IP 地址。

string

否

需要进行重定向的 IP 地址。最多支持 20 个重定向的 IP 地址。

47.0.XX.XX

IpMappingRuleStatuses

array

否

授权规则 IP 重定向的状态。最多支持 20 个授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

string

否

授权规则 IP 重定向的状态。最多支持 20 个授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

Created

IpMappingRuleNames

array

否

需要进行 IP 重定向的授权规则名称。

string

否

需要进行 IP 重定向的授权规则名称。最多支持 20 个授权规则名称。

长度为 2~128 个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

name

DestinationIps

array

否

重定向的目标 IP 地址。

string

否

重定向的目标 IP 地址。最多支持 20 个目标 IP 地址。

192.168.10.8

NextToken

string

否

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

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

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

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResults

integer

否

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20。

20

RegionId

string

是

实例所在的地域 ID。

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

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

请求 ID。

RequestId

string

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

TotalCount

integer

列表条目数。

10

NextToken

string

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

  • 如果 NextToken 为空表示没有下一次查询。

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

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResults

integer

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

20

IpMappingRules

array<object>

授权规则 IP 重定向列表。

object

授权规则 IP 重定向列表。

IoTCloudConnectorId

string

云连接器实例 ID。

iotcc-bp1odcab8tmno0hdq****

IpMappingRuleId

string

需要进行 IP 重定向的授权规则的 ID。

im-irrp3bzuu5nrbx****

IpMappingRuleStatus

string

授权规则 IP 重定向的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Updating:更新中。

  • Associating:IP 绑定中。

  • Dissociating:IP 解绑中。

  • Deleting:删除中。

  • Deleted:已删除。

Created

MappingIp

string

需要进行重定向的 IP 地址。

47.0.XX.XX

DestinationIp

string

重定向的目标 IP 地址。

192.168.10.8

IpMappingRuleName

string

需要进行 IP 重定向的授权规则名称。

name

IpMappingRuleDescription

string

需要进行 IP 重定向的授权规则描述。

description

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "IpMappingRules": [
    {
      "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
      "IpMappingRuleId": "im-irrp3bzuu5nrbx****",
      "IpMappingRuleStatus": "Created",
      "MappingIp": "47.0.XX.XX",
      "DestinationIp": "192.168.10.8",
      "IpMappingRuleName": "name",
      "IpMappingRuleDescription": "description"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 Forbidden.RAM Ram user does not have permission to perform this operation. RAM用户无权限执行此操作。
400 ResourceNotFound.IoTCloudConnector The param of IoTCloudConnectorId is illegal. IoTCloudConnectorId参数非法

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

变更历史

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