tencent cloud

Feedback

ModifyServiceAccountPassword

Last updated: 2024-03-21 17:45:49

1. API Description

Domain name for API request: tcr.tencentcloudapi.com.

This API is used to update the password for a service level account.

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: ModifyServiceAccountPassword.
Version Yes String Common Params. The value used for this API: 2019-09-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
RegistryId Yes String Instance ID.
Name Yes String Service level account name.
Random Yes Boolean Whether to randomly generate a password.
Password No String Service level account password, 8 to 20 characters, contains at least one uppercase letter, one lowercase letter, and one number.

3. Output Parameters

Parameter Name Type Description
Password String Custom user password, displayed only once. Please make sure to retain it securely.
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 Customizing Service Level Account Password

This example shows you how to customize service level account password.

Input Example

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

{
    "RegistryId": "tcr-gijwqid7",
    "Name": "robot",
    "Random": false,
    "Password": "NewPass123"
}

Output Example

{
    "Response": {
        "Password": "NewPass123",
        "RequestId": "8c63b1e6-02b8-48af-94c2-416aa71e0c12"
    }
}

Example2 Resetting Service Level Account Password

This example shows you how to reset service level account password.

Input Example

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

{
    "RegistryId": "tcr-gijwqid7",
    "Name": "robot",
    "Random": true
}

Output Example

{
    "Response": {
        "Password": "kukui1ECDL8kr9cm6W66Me8PlhHemFmC",
        "RequestId": "60e7d0ce-c8ed-4495-9814-9397482f0d4a"
    }
}

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

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed
FailedOperation.DbError Database error
InvalidParameter Parameter error. Please check and try again.
OperationDenied Operation denied.
UnknownParameter Unknown parameter error. Please check and try again.