Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to deactivate a service.
Only after a service is published to an environment can its APIs be called. You can call this API to deactivate a service in the release environment. Once deactivated, the service cannot be called.
A maximum of 20 requests can be initiated per second for this API.
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: UnReleaseService. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-08. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ServiceId | Yes | String | Unique ID of the service to be deactivated. |
EnvironmentName | Yes | String | Name of the environment to be deactivated. Valid values: test (test environment), prepub (pre-release environment), release (release environment). |
ApiIds.N | No | Array of String | List of APIs to be deactivated, which is a reserved field. |
Parameter Name | Type | Description |
---|---|---|
Result | Boolean | Whether deactivation succeeded. Note: this field may return null, indicating that no valid values can be obtained. |
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. |
https://apigateway.tencentcloudapi.com/?Action=UnReleaseService
&ServiceId=service-ody35h5e
&EnvironmentName=prepub
&<Common request parameters>
{
"Response": {
"Result": true,
"RequestId": "42aafae4-3023-4211-a10a-109163118bb0"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.InvalidRegion | Incorrect region. |
LimitExceeded.RequestLimitExceeded | The request frequency has reached the limit. Please try again later. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.InvalidService | The corresponding service is invisible. |
UnauthorizedOperation | The operation is unauthorized. |
UnsupportedOperation.UnpackError |
Was this page helpful?