tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateServiceAccount

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

    1. API Description

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

    This API is used to create 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: CreateServiceAccount.
    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 account name
    Permissions.N Yes Array of Permission Policy list
    Description No String Service account description
    Duration No Integer Validity in days starting from the current day. It takes a higher priority than ExpiresAt.
    ExpiresAt No Integer Expiry time (timestamp, in milliseconds)
    Disable No Boolean Whether to disable the service account

    3. Output Parameters

    Parameter Name Type Description
    Name String Service account name (the prefix tcr$ is automatically added)
    Password String Service account password, which is displayed only once
    ExpiresAt Integer Expiry time of the service account (timestamp)
    CreateTime Timestamp ISO8601 Creation time of the service account
    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 Creating a service account with specified Duration

    This example shows you how to create a service account with the specified Duration.

    Input Example

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

{
    "RegistryId": "tcr-45uu7ras",
    "Name": "test",
    "Description": "for test",
    "Duration": 10,
    "Permissions": [
        {
            "Resource": "test",
            "Actions": [
                "tcr:PullRepository",
                "tcr:PushRepository",
                "tcr:CreateRepository"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "CreateTime": "2023-03-28T15:48:31+08:00",
        "ExpiresAt": 1680853711137,
        "Name": "tcr$test",
        "Password": "oNKUtqrB5Eb68JufkVanSwuhmC4Ergn7",
        "RequestId": "20b67612-28a0-4c51-8efb-0fe14bc23a64"
    }
}

    Example2 Creating a service account

    This example shows you how to create a service account.

    Input Example

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

{
    "RegistryId": "abc",
    "Name": "abc",
    "Description": "abc",
    "Duration": 0,
    "ExpiresAt": 0,
    "Disable": true,
    "Permissions": [
        {
            "Resource": "abc",
            "Actions": [
                "abc"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "Name": "tcr$abc",
        "Password": "abc",
        "ExpiresAt": 0,
        "CreateTime": "2020-09-22T00:00:00+00:00",
        "RequestId": "abc"
    }
}

    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.
    OperationDenied.QuotaOverLimit Reached the upper limit of quota.
    UnknownParameter Unknown parameter error. Please check and try again.
    UnsupportedOperation Unsupported operation
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy