Modify Service

Last updated: 2019-07-24 16:14:17

API Description

This API (ModifyService) is used to modify the information about the service. After a service is created, its name, description and service type can be modified.

Input Parameters

The following request parameter list only provides API request parameters. Other parameters can be found in Common Request Parameters.

Parameter Name Required Type Description
serviceId Yes String The unique ID of the service to be modified.
serviceName No String Modified service name.
serviceDesc No String Modified service description.
protocol No String Modified frontend request type of the service, such as HTTP and HTTPS.

Output Parameters

Parameter Name Type Description
code Int Common error code. 0: Successful; other values: Failed. For more information, see Common Error Codes on the Error Codes page.
codeDesc String Error code at business side. For a successful operation, "Success" is returned. In case of an error, a message describing the reason for the error is returned.
message String Module error message description depending on API.
serviceId String The unique ID of the service.
serviceName String Service name.
serviceDesc String Service description.
protocol String Frontend request type of the service, such as HTTP and HTTPS.
modifiedTime Timestamp Last modification time. It is in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard. UTC time is used.

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=ModifyService
$serviceId=service-XXXX
&serviceName=newTest
&serviceDesc=newTestDescription
&protocol=https

The returned results are as below:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "serviceId":"service-XXXX",      
    "serviceName":"newTest",
    "serviceDesc":"newTestDescription",
    "protocol":"https",    
    "modifiedTime":"2017-08-07T00:00:00Z",
}