Overview
PublicEndpointManagement Public Service is a web service for CDP applications to manage public DNS entries and TLS certificates.
Version information
Version : 0.9.164 (BETA)
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
Create or update a DNS entry.
POST /api/v1/publicendpointmanagement/createDnsEntry
Description
Create or update a DNS entry.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete a DNS entry.
POST /api/v1/publicendpointmanagement/deleteDnsEntry
Description
Delete a DNS entry.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List all DNS entries.
POST /api/v1/publicendpointmanagement/listDnsEntries
Description
List all DNS entries for an accountId.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Definitions
CreateDnsEntryRequest
Request object for the CreateDnsEntry method.
| Name | Description | Schema |
|---|---|---|
addWildcard |
Adds the wildcard entry if TRUE. |
boolean |
dnsTarget |
The DNS target set for this domain name |
|
endpoint |
The endpoint for this cluster. |
string |
environmentCrn |
The CRN of the environment for which the DNS entry is to be created. |
string |
CreateDnsEntryResponse
Response object for the CreateDnsEntry method.
Type : object
DeleteDnsEntryRequest
Request object for the DeleteDnsEntry method.
| Name | Description | Schema |
|---|---|---|
dnsTarget |
The DNS target set for this domain name. |
|
endpoint |
The endpoint for this cluster. |
string |
environmentCrn |
The CRN of the environment, for which the DNS entry is to be deleted. |
string |
removeWildcard |
Removes the wildcard entry if TRUE. |
boolean |
DeleteDnsEntryResponse
Response object for the DeleteDnsEntry method.
Type : object
DnsEntryResponse
DnsEntryResponse represents a DNS entry with its name, type, target records, and optional TTL.
| Name | Description | Schema |
|---|---|---|
dnsRecordName |
The DNS name for this entry, e.g. example.com. |
string |
dnsRecordType |
The record type of the DNS entry, e.g. A, CNAME, etc. |
|
dnsTTL |
Time to live for the DNS entry, in seconds. |
string |
dnsTargetRecords |
The target for this DNS entry, which can be an IP address, CNAME, or AWS ELB DNS. |
DnsRecordType
The type of DNS record.
A - A record type (IPv4 address). TXT - TXT record type (text record). CNAME - CNAME record type (canonical name).
Type : enum (A, TXT, CNAME)
DnsTarget
DnsTarget represents the target of a DNS entry, which can be a set of IPs, a CNAME, or an AWS ELB DNS target.
| Name | Description | Schema |
|---|---|---|
targetCname |
CNAME target for the DNS entry, e.g. "example.com". |
string |
targetIPs |
IP addresses for the DNS entry, e.g. ["192.168.1.1", "10.0.0.1"]. |
DnsTargetRecord
DnsTargetRecord represents the target of a DNS entry.
| Name | Description | Schema |
|---|---|---|
resourceRecords |
Resource records for the DNS entry, such as IP addresses or CNAMEs. |
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
IPs
IPs holds a list of IP addresses for a DNS entry.
| Name | Description | Schema |
|---|---|---|
ips |
IP addresses for a DNS entry. |
< string > array |
ListDnsEntriesRequest
Request object for the ListDnsEntries method.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of the environment, for which the DNS entries are being listed. |
string |
pageSize |
The page size. |
integer (int32) |
pageToken |
The page token. |
string |
recordType |
The record type to filter on, e.g. A, CNAME, etc. |
ListDnsEntriesResponse
Response object for the ListDnsEntries method.
| Name | Description | Schema |
|---|---|---|
dnsEntries |
List of DNS entries for the specified environment. |
< DnsEntryResponse > array |
nextPageToken |
The page token for requesting the next page of results. |
string |
ResourceRecords
ResourceRecords holds a list of values for DNS resource records, such as IP addresses or CNAMEs.
| Name | Description | Schema |
|---|---|---|
values |
Values can be IP addresses or CNAMEs. |
< string > array |