tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ManageReplication

Last updated: 2024-12-02 15:02:48

    1. API Description

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

    This API is used to manage the instance synchronization rule.

    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: ManageReplication.
    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.
    SourceRegistryId Yes String Source instance ID
    DestinationRegistryId Yes String Destination instance ID
    Rule Yes ReplicationRule Synchronization rule
    Description No String Rule description
    DestinationRegionId No Integer Region ID of the destination instance. For example, 1 represents Guangzhou
    PeerReplicationOption No PeerReplicationOption Configuration of the synchronization rule

    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 an instance synchronization rule

    Input Example

    https://tcr.intl.tencentcloudapi.com/?Action=ManageReplication
&SourceRegistryId=tcr-xxx
&DestinationRegistryId=tcr-yyy
&DestinationRegionId=9
&Rule.Override=true
&Rule.DestNamespace=test
&Rule.Name=test
&Rule.Filters.0.Type=tag
&Rule.Filters.0.Value=test
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    Example2 Creating a synchronization rule for instances under different Tencent Cloud root accounts

    This example shows you how to create a synchronization rule between instances under different Tencent Cloud root accounts.

    Input Example

    https://tcr.intl.tencentcloudapi.com/?Action=ManageReplication
&SourceRegistryId=tcr-3498
&DestinationRegistryId=tcr-98676
&DestinationRegionId=9
&Rule.Override=true
&Rule.DestNamespace=test
&Rule.Name=test
&Rule.Filters.0.Type=tag
&Rule.Filters.0.Value=test
&PeerReplicationOption.EnablePeerReplication=true
&PeerReplicationOption.PeerRegistryUin=113498
&PeerReplicationOption.PeerRegistryToken=xxx
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

    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. Please check and try again.
    InternalError.DbError Database error. Please check and try again.
    InternalError.ErrorTcrInternal Internal error with the TCR instance.
    InternalError.ErrorTcrInvalidMediaType Invalid request header
    InternalError.ErrorTcrResourceConflict TCR instance resource conflict.
    InternalError.ErrorTcrUnauthorized No permission for TCR operation.
    InvalidParameter Parameter error. Please check and try again.
    InvalidParameter.ErrorTcrInvalidParameter Invalid TCR request.
    MissingParameter Missing parameters. Please check and try again.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.TcrResourceNotFound The resource of the TCR instance was not found.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter error. Please check and try again.
    UnsupportedOperation Unsupported operation
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy