tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBackupStorageLocation

Last updated: 2024-11-14 14:53:43

    1. API Description

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

    This API is used to create a backup repository. You can specify the storage type (such as COS), the bucket region and the name. Up to 100 repositories can be created. Note that the settings of this API apply globally. You only need to create one backup repository, and back up TKE clusters in different regions in it.

    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: CreateBackupStorageLocation.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region No String Common Params. This parameter is not required.
    StorageRegion Yes String Repository region, such as ap-guangzhou
    Bucket Yes String COS bucket name. For COS storage type, it must start with the prefix tke-backup.
    Name Yes String Backup repository name
    Provider No String The provider of storage service. It defaults to Tencent Cloud.
    Path No String COS bucket path

    3. Output Parameters

    Parameter Name Type Description
    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 TKE storage repository

    This example shows you how to create a TKE storage repository.

    Input Example

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

{
    "StorageRegion": "ap-guangzhou",
    "Provider": "tencentcloud",
    "Bucket": "tke-backup-xxx",
    "Path": "",
    "Name": "test-registry-1"
}

    Output Example

    {
    "Response": {
        "RequestId": "4bef4bc7-edf2-4de6-a2e1-684bfc37185f"
    }
}

    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
    InternalError Internal error.
    InvalidParameter Parameter error.
    LimitExceeded Quota limit is exceeded.
    ResourceUnavailable Resource is unavailable
    UnknownParameter Unknown parameter.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy