Help & DocumentationAPIsAPI GatewayService APIsBind Custom Domain Name to Service

Bind Custom Domain Name to Service

Last updated: 2019-07-24 16:21:03

API Description

This API (BindSubDomain) is used to bind a custom domain name to a service.
Each service in the API gateway provides a default domain name for users to call. If you wants to use an existing domain name, the custom domain name can be bound to the service. After cname of the default domain name is done, the custom domain name can be called directly.

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.
subDomain Yes String The custom domain name to be bound.
certificateId No String The unique ID of the certificate of the custom domain name to be bound.
isDefaultMapping No String Whether to use the default path mapping. The default is TRUE. FALSE indicates that a custom path mapping is used, and pathMappingSet is required.
pathMappingSet.n.path No Object The path of the custom path mapping. When using the custom mapping, you can map only one path to one environment, or map several paths to several environments. Once the custom mapping is used, only the custom mapping path is effective instead of the default mapping rule.
pathMappingSet.n.environment No Object The environment name of the custom path mapping.

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.

&<Common request parameters>

The returned results are as below: