CreateGroupAuthorizationRule-阿里云帮助中心

Authorization rule for creating an instance group.

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:CreateGroupAuthorizationRule

create

*CloudConnector

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

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorGroupId	string	Yes	ID of the IoT Cloud Connector group.	iotccg-g00epppbi9di9y****
AuthorizationRuleDescription	string	No	Description of the authorization rule. 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://`.	rule
AuthorizationRuleName	string	No	Name of the authorization rule. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It can contain numbers, periods (.), underscores (_), and hyphens (-).	ruletest
SourceCidrs	array	Yes	Source CIDR blocks. You can specify up to 20 CIDR blocks.
	string	No	Source CIDR block. You can specify up to 20 CIDR blocks.	192.168.0.1/24
DestinationType	string	Yes	Type of destination. Valid values: Cidr: A CIDR block. Domain: A domain name.	Cidr
DestinationPort	string	No	Destination port range. Valid values: TCP or UDP: 1 to 65535. Use a forward slash (/) to separate the start and end ports. Example: 1/200. ICMP: -1/-1. ALL: -1/-1.	80/80
Protocol	string	No	Protocol type. Valid values: tcp. udp. icmp. all: All protocols.	tcp
Destination	string	Yes	Destination address.	47.0.XX.XX
ClientToken	string	No	A client token that ensures the idempotence of the request. Generate a unique value on your client side for each request. The ClientToken parameter supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. Each API request may have a different RequestId.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Indicates whether to perform a dry run. Valid values: true: Perform a check. No authorization rule is created. The system checks required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the error code `DryRunOperation` is returned. false (default): Send a normal request. After the check passes, the system returns an HTTP 2xx status code and performs the operation.	false
RegionId	string	Yes	ID of the region where the IoT Cloud Connector group resides. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
Policy	string	Yes	Access policy. Valid values: Permit: Allow access. Deny: Deny access.	Permit
Type	string	No	Type of authorization rule. Valid values: System: System-defined rule. Customer: Custom rule. Default: Default rule.	System

Response elements

Element	Type	Description	Example
	object	List of response items.
IoTCloudConnectorGroupId	string	ID of the IoT Cloud Connector group.	iotccg-g00epppbi9di9y****
RequestId	string	ID of the request.	54B48E3D-DF70-471B-AA93-08E683A1B45
AuthorizationRuleId	string	ID of the authorization rule.	gar-ez91t41jvi6tr8****

Examples

Success response

JSON format

{
  "IoTCloudConnectorGroupId": "iotccg-g00epppbi9di9y****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "AuthorizationRuleId": "gar-ez91t41jvi6tr8****"
}

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	QuotaExceeded.IoTCCGroupInstanceLimit	The quota of IoTCCGroupPerUser is exceeded
400	ResourceAlreadyExist.AuthorizationRule	The specified resource of AuthorizationRule already exists.	The error message returned because the rule already exists.
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.
400	IllegalParam.Destination	The param of Destination is illegal.	The error message returned because the value of the Destination parameter is invalid.
400	OperationDenied.CC5GInstanceNotSupport	The operation is not allowed because of CC5G instance not support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.