CreateIpMappingRule-阿里云帮助中心

Call the CreateIpMappingRule operation to enable IP redirection for an authorization rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

iotcc:CreateIpMappingRule

create

*CloudConnector

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

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorId	string	Yes	ID of the cloud connector instance.	iotcc-bp1odcab8tmno0hdq****
DestinationIp	string	Yes	Target IP address for redirection.	192.168.10.8
MappingIp	string	Yes	IP address to redirect.	47.0.XX.XX
IpMappingRuleName	string	No	Name of the authorization rule that enables IP redirection. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	name
IpMappingRuleDescription	string	No	Description of the authorization rule that enables IP redirection. The description must be 2 to 256 characters in length. It must start with a letter or Chinese character. It cannot start with `http://` or `https://`.	description
ClientToken	string	No	Client token used to ensure idempotence. Generate a unique value on your client. The value must be unique across different requests. Only ASCII characters are supported. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request has a different RequestId.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Indicates whether to perform only a dry run. true: Performs a check. Does not create the IP redirection rule. Checks include required parameters, request format, and business limits. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned. false (default): Performs the operation. Returns an HTTP 2xx status code if the check passes.	false
RegionId	string	Yes	ID of the region where the instance resides. You can call the ListRegions operation to query region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Request ID.
RequestId	string	Request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
IpMappingRuleId	string	ID of the authorization rule that enables IP redirection.	im-irrp3bzuu5nrbx****

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "IpMappingRuleId": "im-irrp3bzuu5nrbx****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.RAM	Ram user does not have permission to perform this operation.	The error message returned because the RAM user does not have the permissions to perform the operation.
400	OperationDenied.DomainFeatureDisabled	The operation is not allowed because of domain feature disabled.
400	IllegalParam.Destination	The param of Destination is illegal.	The error message returned because the value of the Destination parameter is invalid.
400	ResourceAlreadyExist.AuthorizationRule	The specified resource of AuthorizationRule already exists.	The error message returned because the rule already exists.
400	Conflict.Param	The param is conflict.
400	Conflict.Cidr	The cidr is conflict.
400	ResourceNotFound.IoTCloudConnector	The param of IoTCloudConnectorId is illegal.	The error message returned because the value of the IoTCloudConnectorId parameter is invalid.
400	QuotaExceeded.sourceCidrLimit	The quota of SourceCidrsPerAuthorizationRule is exceeded
400	IllegalParam	The param is illegal.
400	QuotaExceeded.authorizationRuleInstanceLimit	The quota of AuthorizationRulePerIotCC is exceeded
400	IllegalParamFormat	The param is illegal.
400	ResourceInConfiguring.IoTCloudConnector	The specified resource of IoTCloudConnector is configuring, please try again later.
400	OperationDenied.DomainInHumanNetwork	The operation is not allowed because of domain or CIDR in human network.
400	OperationDenied.CIDRMaskTooLarge	The operation is not allowed because of CIDR too large.	The error message returned because the length of the subnet mask of the CIDR block exceeds the upper limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.