tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Data Transfer Service
    Documentation
    Download PDF

    ModifySubscribeObjects

    Last updated: 2024-12-04 15:34:29
    Download PDF

    1. API Description

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

    This API is used to modify the data subscription object and Kafka partition rule. For MongoDB subscription, you can also modify the output aggregation 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: ModifySubscribeObjects.
    Version Yes String Common Params. The value used for this API: 2021-12-06.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    SubscribeId Yes String Data subscription instance ID
    SubscribeObjectType Yes Integer Data subscription type. Valid values for non-mongo task: 0 (full instance update); 1 (data update); 2 (structure update); 3 (data + structure update). Valid values for mongo task: 0 (full instance update); 4 (subscribe to a table); 5 (subscribe to a collection).
    Objects.N No Array of ModifiedSubscribeObject Modified subscription database table information. It will replace the original subscription object, this field is required unless SubscribeObjectType = 0 or 2.
    DistributeRules.N No Array of DistributeRule Kafka partitioning policy. If left blank, it will remain unchanged by default. If filled, it will replace the original policy.
    DefaultRuleType No String Default partitioning policy. Data that does not meet the regex in DistributeRules will be partitioned according to the default partitioning policy.Default strategies supported by non-mongo products: table - partitioned by table name, pk - partitioned by table name + primary key. Mongo's default strategy only supports: collection-partitioned by collection name.This field is used in conjunction with DistributeRules. If DistributeRules is configured, this field is also required. If this field is configured, it is considered as configuring a DistributeRules, and the original partitioning policy will also be overwritten.
    PipelineInfo.N No Array of PipelineInfo Mongo output aggregation settings, optional for Mongo tasks. If left blank, no modification will be made by default.

    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 Modifying the subscription rule of a data subscription channel

    This example shows you how to modify the subscription rule of a data subscription, such as adding or removing certain tables.

    Input Example

    https://dts.intl.tencentcloudapi.com/?Action=ModifySubscribeObjects
&SubscribeId=subs-ieuwi83j2e
&SubscribeObjectType=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

    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
    AuthFailure The CAM signature/authentication information is incorrect.
    AuthFailure.AuthFailureError Authentication failed.
    FailedOperation Operation failed.
    FailedOperation.FailedOperationError The operation failed.
    InternalError An internal error occurred.
    InternalError.InternalErrorError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidParameterError The parameter is invalid.
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.InvalidParameterValueError The parameter is invalid.
    OperationDenied The operation was denied.
    OperationDenied.OperationDeniedError The operation was denied.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.ResourceNotFoundError The resource was not found.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.UnauthorizedOperationError The operation is unauthorized.
    UnsupportedOperation The operation is not supported.
    UnsupportedOperation.UnsupportedOperationError The operation is not supported.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy