All Products
Search

This Product

    :UpdateInstanceAccount

    Document Center

    :UpdateInstanceAccount

    Last Updated:Nov 28, 2024

    Updates the information about a specific account in a specific instance.

    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
    rocketmq:UpdateInstanceAccountupdate
    *Instance
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}
      none
    		none

    Request syntax

    PATCH /instances/{instanceId}/accounts/{username} HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    instanceIdstringYes

    The instance ID.

    		rmq-cn-7e22ody****
    usernamestringNo

    The username of the account.

    		test
    accountStatusstringNo

    The status of the account.

    Valid values:

    • DISABLE
    • ENABLE
    		ENABLE
    passwordstringNo

    The password of the account.

    		test

    Response parameters

    ParameterTypeDescriptionExample
    object

    Result

    requestIdstring

    The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.

    		AF9A8B10-C426-530F-A0DD-96320B39****
    successboolean

    Indicates whether the call is successful.

    		true
    databoolean

    The returned result.

    		true
    codestring

    The error code.

    		Instance.NotFound
    messagestring

    The error message.

    		The instance cannot be found.
    httpStatusCodeinteger

    The HTTP status code.

    		200
    dynamicCodestring

    The dynamic error code.

    		InstanceId
    dynamicMessagestring

    The dynamic error message.

    		instanceId
    accessDeniedDetailstring

    The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.

    		xxx

    Examples

    Sample success responses

    JSONformat

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "Instance.NotFound",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

    Error codes

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