tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifySubscribeObjects

Last updated: 2022-05-12 10:02:15

1. API Description

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

This API is used to modify the subscription rule of a data subscription channel.

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: 2018-03-30.
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: 0 (full instance subscription), 1 (data subscription), 2 (structure subscription), 3 (data subscription + structure subscription)
Objects.N No Array of SubscribeObject Information of subscribed table

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID
RequestId String The unique request ID, which is returned for each request. 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.tencentcloudapi.com/?Action=ModifySubscribeObjects
&SubscribeId=subs-ieuwi83j2e
&SubscribeObjectType=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb",
    "AsyncRequestId": "19b514a7-816c43c1-ffb34ab6-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
FailedOperation.StatusInConflict This operation cannot be performed due to status conflict.
InternalError An internal error occurred.
InvalidParameter A parameter error occurred.
OperationDenied Operation denied.
ResourceNotFound The resource does not exist.
ResourceNotFound.BizResourceNotFoundError Resource not found.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy