Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to modify the path mapping in the custom domain name settings of a service. The path mapping rule can be modified before it is bound to the custom domain name.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: ModifySubDomain. |
| 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 service ID. |
| SubDomain | Yes | String | Custom domain name whose path mapping is to be modified. |
| IsDefaultMapping | Yes | Boolean | Whether to change to the default path mapping. true: use the default path mapping; false: use the custom path mapping. |
| CertificateId | No | String | Certificate ID, which is required if the HTTPS protocol is included. |
| Protocol | No | String | Custom domain name protocol type after modification. Valid values: http, https, http&https. |
| PathMappingSet.N | No | Array of PathMapping | Path mapping list after modification. |
| NetType | No | String | Network type. Valid values: INNER, OUTER. |
| IsForcedHttps | No | Boolean | Whether to force HTTP requests to redirect to HTTPS. Default value: false. When this parameter is true, API Gateway will redirect all requests using the custom domain name over the HTTP protocol to the HTTPS protocol for forwarding. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | Boolean | Whether the custom domain name is successfully modified. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=ModifySubDomain
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxx
&CertificateId=''
&IsDefaultMapping=false
&Protocol=http
&NetType=OUTER
&PathMappingSet.0.Path=/
&PathMappingSet.0.Environment=release
&<Common request parameters>{
"Response": {
"Result": true,
"RequestId": "d7f6116b-8184-4bdd-8fbe-1ecbcfa1ea30"
}
}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.CertificateIdBindError | An error occurred while binding a certificate. |
| FailedOperation.CertificateIdError | The certificate does not exist or you do not have permission to view it. Please upload a valid certificate in the SSL Certificates Service Console. |
| FailedOperation.PathMappingSetError | An error occurred while setting the path mapping. |
| FailedOperation.ServiceError | Service error. |
| FailedOperation.ServiceNotExist | The service does not exist. |
| FailedOperation.SetCustomPathMappingError | The custom domain name already uses the default path mapping, so no custom path can be set. |
| FailedOperation.SubDomainFormatError | The custom domain name format is incorrect. |
| FailedOperation.UnknownProtocolTypeError | The protocol type is incorrect. |
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the intelligent customer service or submit a ticket. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| UnsupportedOperation.ForceHttps | Cannot force HTTPS when the protocol is HTTP. |
| UnsupportedOperation.InvalidServiceTrade | The service is currently isolated and therefore the operation is not supported. |
Was this page helpful?