UpdateGroupAuthorizationRuleAttribute

更新时间:
复制 MD 格式

You can modify the authorization rules for 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:UpdateGroupAuthorizationRuleAttribute

update

*CloudConnector

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

None None

Request parameters

Parameter

Type

Required

Description

Example

IoTCloudConnectorGroupId

string

Yes

The ID of the IoT Cloud Connector group.

iotccg-g00epppbi9di9y****

AuthorizationRuleDescription

string

No

A description of the authorization rule.

The description must be 2 to 256 characters in length. It must start with a letter or a Chinese character. It cannot start with http:// or https://.

rule

AuthorizationRuleName

string

No

The name of the authorization rule.

The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).

ruletest

AuthorizationRuleId

string

Yes

The ID of the authorization rule to update.

gar-ez91t41jvi6tr8****

SourceCidrs

array

No

The source CIDR blocks. Valid values of N: 1 to 20.

string

No

A source CIDR block. Valid values of N: 1 to 20.

192.168.0.1

DestinationType

string

No

The type of destination. Valid values:

  • Cidr: A CIDR block.

  • Domain: A domain name.

Cidr

DestinationPort

string

No

The destination port range. Valid values:

  • TCP or UDP: 1 to 65535. Use a forward slash (/) to separate the start port from the end port. Example: 1/200.

  • ICMP: -1/-1.

  • ALL: -1/-1.

80/80

Protocol

string

No

The protocol type. Valid values:

  • tcp.

  • udp.

  • icmp.

  • all: All protocols.

tcp

Destination

string

No

The destination to access.

47.0.XX.XX

Policy

string

No

The access policy. Valid values:

  • Permit: Allow access.

  • Deny: Deny access.

Permit

ClientToken

string

No

A client token that ensures the idempotence of the request.

You must generate a unique value for this parameter. The value can be up to 64 ASCII characters in length.

Note

If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.

123e4567-e89b-12d3-a456-426655440000

DryRun

boolean

No

Specifies whether to perform only a dry run. Valid values:

  • true: Perform a check. The authorization rule is not updated. The system checks required parameters, request format, and business limits. If the check fails, an error is returned. If the check passes, the error code DryRunOperation is returned.

  • false (default): Perform the operation. After the check passes, the system returns an HTTP 2xx status code and updates the authorization rule.

true

RegionId

string

Yes

The region ID of the IoT Cloud Connector group.

You can call the DescribeRegions operation to query the region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response information.

IoTCloudConnectorGroupId

string

The ID of the IoT Cloud Connector group.

iotccg-g00epppbi9di9y****

RequestId

string

The ID of the request.

54B48E3D-DF70-471B-AA93-08E683A1B45

AuthorizationRuleId

string

The 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 OperationDenied.NoFieldModify The operation is not allowed because of no field modify.
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 OperationDenied.CC5GInstanceNotSupport The operation is not allowed because of CC5G instance not support.
400 IllegalParam.Destination The param of Destination is illegal. The error message returned because the value of the Destination parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.