All Products
Search

This Product

    Bastionhost:ModifyRule

    Document Center

    Bastionhost:ModifyRule

    Last Updated:Oct 25, 2024

    Modifies the basic information of an authorization rule.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-bastionhost:ModifyRule
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the bastion host whose authorization rule you want to modify.

    Note You can call the DescribeInstances operation to query the bastion host ID.
    		bastionhost-cn-zmb2y9ydw08
    RegionIdstringNo

    The region ID of the bastion host to which the authorization rule to modify belongs.

    Note For more information about the mapping between region IDs and region names, see Regions and zones.
    		cn-hangzhou
    RuleIdstringYes

    The ID of the authorization rule to modify.

    		68
    RuleNamestringNo

    The new name of the authorization rule. The name must be 1 to 128 characters in length and can contain periods (.), underscores (_), hyphens (-), single quotation marks ('), and spaces. It cannot start with a special character.

    		test
    CommentstringNo

    The new remarks of the authorization rule. It can be up to 500 characters in length.

    EffectiveStartTimelongNo

    The start time of the new validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.

    		1669630029
    EffectiveEndTimelongNo

    The end time of the new validity period of the authorization rule. The value is a UNIX timestamp. Unit: seconds.

    		1672502400
    UserIdsarrayNo

    The IDs of the users with whom the modified authorization rule is associated.

    stringNo

    The ID of the user with whom the modified authorization rule is associated.

    		["1"]
    UserGroupIdsarrayNo

    The IDs of the user groups with which the modified authorization rule is associated.

    stringNo

    The ID of the user group with which the modified authorization rule is associated.

    		["1"]
    Hostsarray<object>No

    An array that consists of the host IDs and host account IDs with which the modified authorization rule is associated.

    objectNo
    HostIdstringNo

    The host ID.

    		[{"HostId":"1"}]
    HostAccountIdsarrayNo

    The host account IDs.

    stringNo

    The host account ID.

    		[{"HostId":"1","HostAccountIds":["1"]}]
    Databasesarray<object>No

    The databases and database accounts that a user associated with the modified rule can manage.

    objectNo
    DatabaseIdstringNo

    The database ID.

    		[ { "DatabaseId": "1" } ]
    DatabaseAccountIdsarrayNo

    The database account IDs.

    stringNo

    The database account ID.

    		[ { "DatabaseId": "1", "DatabaseAccountIds": ["1", "2"] } ]
    HostGroupsarray<object>No

    The asset groups and asset accounts that a user associated with the modified rule can manage.

    objectNo
    HostGroupIdstringNo

    The asset group ID.

    		[{"HostGroupId":"1"}]
    HostAccountNamesarrayNo

    The names of the asset accounts.

    stringNo

    The name of the asset account.

    		[{"HostGroupId":"1","HostAccountNames":["root"]}]

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		67EB57AD-5C83-537B-B2A1-6082798965F0

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "67EB57AD-5C83-537B-B2A1-6082798965F0"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe argument is invalid.The argument is invalid.
    400RuleAlreadyExistsThe rule already exists.The rule already exists.
    404RuleNotFoundThe rule is not found.The rule is not found.
    500InternalErrorAn unknown error occurred.An unknown error occurred.

    For a list of error codes, visit the Service error codes.