ModifyApiIncrement

Last updated: 2022-01-20 14:23:52

1. API Description

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

This API is used to incrementally update an API and mainly called by programs (different from ModifyApi, which requires that full API parameters be passed in and is suitable for use in the console).

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyApiIncrement.
Version Yes String Common parameter. The value used for this API: 2018-08-08.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ServiceId Yes String Service ID
ApiId Yes String API ID
BusinessType Yes String Authorization type of the API to be modified (you can select OAUTH, i.e., authorization API)
PublicKey No String Public key value to be modified by OAuth API
LoginRedirectUrl No String OAuth API redirect address

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 ModifyApiIncrement

Input Example

https://apigateway.tencentcloudapi.com/?Action=ModifyApiIncrement
&ServiceId="service-123"
&ApiId="api-123"
&BusinessType="OAUTH"
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "c570c877-3c23-4d84-9589-68914dab1507"
  }
}

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
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidApiBusinessType The API business type passed in must be OAUTH.
InvalidParameterValue.NothingModifyForOauth There are no modifiable items for the OAuth API.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidService The corresponding service is invisible.