ModifyUsersOfGroupSTD

Last updated: 2025-11-13 20:48:51

ModifyUsersOfGroupSTD

Last updated: 2025-11-13 20:48:51

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to change the user information of user groups.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyUsersOfGroupSTD.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Cluster name.
Group	Yes	String	User group name.
Users.N	No	Array of String	User list.
Description	No	String	User group description.
OperateAction	No	String	Enumeration class. Valid values: ADD, DELETE, SYNC. Enumeration class description. - ADD: Batched users to add. Adding the same user multiple times will not trigger an error. - DELETE: Batched users to remove from the user group. Deleting non-existing users will not trigger an error. - SYNC: Overwrites the entire user group. An empty list clears all existing members. Defaults to SYNC.

3. Output Parameters

Parameter Name	Type	Description
Data	Boolean	Whether modification is successful.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Editing Users in a User Group

Input Example

POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUsersOfGroupSTD
<Common request parameters>

{
    "InstanceId": "emr-o88f3whr",
    "Group": "group3",
    "Users": [
        "user1"
    ],
    "Description": "modify"
}

Output Example

{
    "Response": {
        "Data": true,
        "RequestId": "554a474b-c1dd-4627-9b80-42b4b9e95add"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud