ModifyService

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

1. API Description

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

This API is used to modify the relevant information of a service. After a service is created, its name, description, and service type can be modified.

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: ModifyService.
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 Unique ID of the service to be modified.
ServiceName No String Service name after modification.
ServiceDesc No String Service description after modification.
Protocol No String Service frontend request type after modification, such as http, https, and http&https.
NetTypes.N No Array of String Network type list, which is used to specify the supported network types. INNER: private network access; OUTER: public network access. Default value: OUTER.

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 Modifying service

Input Example

https://apigateway.tencentcloudapi.com/?Action=ModifyService
&ServiceId=service-0c96l2bo
&ServiceName=test_https
&ServiceDesc=https
&Protocol=https
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e3705d00-bfe0-4fde-942c-cebd6b12431b"
  }
}

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.ServiceError Service error.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.NotInOptions The parameter value is incorrect, as it is not an available option.
ResourceNotFound.InvalidService The corresponding service is invisible.
UnsupportedOperation.ModifyNetType The network type cannot be modified
UnsupportedOperation.ReduceNetTypes Network types cannot be reduced.