Describe a BasePathMapping resource.
Request Syntax
GET /domainnames/domain_name/basepathmappings/base_path?domainNameId=domainNameId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- base_path
-
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
Required: Yes
- domain_name
-
The domain name of the BasePathMapping resource to be described.
Required: Yes
- domainNameId
-
The identifier for the domain name resource. Supported only for private custom domain names.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"basePath": "string",
"restApiId": "string",
"stage": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
HTTP Status Code: 400
- NotFoundException
-
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
- TooManyRequestsException
-
The request has reached its throttling limit. Retry after the specified time period.
HTTP Status Code: 429
- UnauthorizedException
-
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
