Overview

Cloudera Private Cloud Control Plane Monitoring Metrics Administration API

Version information

Version : 0.9.126 (BETA)

License information

License : Apache 2.0
Terms of service : null

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Create remote storage configuration

POST /api/v1/metrics/createRemoteWriteConfig

Description

Creates a new remote storage configuration.

Parameters

Type Name Description Schema

Body

input
required

CreateRemoteWriteConfigRequest request params

CreateRemoteWriteConfigRequest

Responses

HTTP Code Description Schema

200

OK

CreateRemoteWriteConfigResponse

default

The default response on an error.

Error

Tags

  • remote storage configuration

Delete remote storage configuration

POST /api/v1/metrics/deleteRemoteWriteConfig

Description

Deletes a remote storage configuration.

Parameters

Type Name Description Schema

Body

input
required

DeleteRemoteWriteConfigRequest request params

DeleteRemoteWriteConfigRequest

Responses

HTTP Code Description Schema

200

OK

DeleteRemoteWriteConfigResponse

default

The default response on an error.

Error

Tags

  • remote storage configuration

Describe remote storage configuration

POST /api/v1/metrics/describeRemoteWriteConfig

Description

Returns a remote storage configuration

Parameters

Type Name Description Schema

Body

input
required

DescribeRemoteWriteConfigRequest request params

DescribeRemoteWriteConfigRequest

Responses

HTTP Code Description Schema

200

OK

DescribeRemoteWriteConfigResponse

default

The default response on an error.

Error

Tags

  • remote storage configuration

List remote storage configurations

POST /api/v1/metrics/listRemoteWriteConfigs

Description

Returns all remote storage configurations in the given account

Parameters

Type Name Description Schema

Body

input
required

ListRemoteWriteConfigsRequest request params

ListRemoteWriteConfigsRequest

Responses

HTTP Code Description Schema

200

OK

ListRemoteWriteConfigsResponse

default

The default response on an error.

Error

Tags

  • remote storage configuration

Update remote storage configuration

POST /api/v1/metrics/updateRemoteWriteConfig

Description

Updates remote storage configuration.

Parameters

Type Name Description Schema

Body

input
required

UpdateRemoteWriteConfigRequest request params

UpdateRemoteWriteConfigRequest

Responses

HTTP Code Description Schema

200

OK

UpdateRemoteWriteConfigResponse

default

The default response on an error.

Error

Tags

  • remote storage configuration

Definitions

AuthHeader

Authorization header configuration

Name Description Schema

credentials
required

Authorization header credentials

string

shouldUpdateCredentialsField
optional

Returns true if the credentials field was changed and should be updated

boolean

type
optional

Authorization header type
Default : "Bearer"

string

AuthHeaderForResponse

Authorization header configuration response

Name Description Schema

type
optional

Authorization header type
Default : "Bearer"

string

BasicAuth

Basic auth configuration

Name Description Schema

password
optional

Password for the remote storage config

string

shouldUpdatePasswordField
optional

Returns true if the password field was changed and should be updated

boolean

username
required

Username for the remote storage configuration

string

BasicAuthForResponse

Basic auth configuration response

Name Description Schema

username
required

Username for the remote storage configuration

string

CreateRemoteWriteConfigRequest

Create remote write storage configuration request

Name Description Schema

remoteWriteConfig
required

Remote storage configuration

RemoteWriteConfigRequestForCreate

CreateRemoteWriteConfigResponse

Create remote write storage configuration response

Name Description Schema

remoteWriteConfig
required

Remote storage configuration

RemoteWriteConfigResponse

DeleteRemoteWriteConfigRequest

Delete remote write storage configuration request

Name Description Schema

id
required

UUID of the remote storage configuration

string

DeleteRemoteWriteConfigResponse

Delete remote write storage configuration response

Type : object

DescribeRemoteWriteConfigRequest

Describe remote write storage configuration request

Name Description Schema

id
required

UUID of the remote storage configuration

string

DescribeRemoteWriteConfigResponse

Describe remote write storage configuration response

Name Description Schema

remoteWriteConfig
required

Remote storage configuration

RemoteWriteConfigResponse

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

IntegrationConfig

The configuration for public cloud metric integration

Name Description Schema

requestSignerCertificate
required

The public cloud side certificate to use for request signing

RequestSignerCertificate

IntegrationConfigForResponse

The configuration for public cloud metric integration

Name Description Schema

requestSignerCertificate
required

The public cloud side certificate to use for request signing

RequestSignerCertificateForResponse

ListRemoteWriteConfigsRequest

List remote write storage configurations request

Type : object

ListRemoteWriteConfigsResponse

List remote write storage configurations response

Name Description Schema

remoteWriteConfigs
required

List of remote storage configs

< RemoteWriteConfigResponse > array

RemoteWriteConfigRequestForCreate

Remote write storage configuration request for create

Name Description Schema

address
required

Address of the remote storage

string

authHeader
optional

Authorization header parameters

AuthHeader

authMethod
required

Authentication method of the remote storage

string

basicAuth
optional

Basic auth parameters

BasicAuth

customHeaders
optional

Additional custom HTTP header key-value pairs that are sent along with each remote write request.

< string, string > map

enabled
required

Enabled state of the remote storage config

boolean

integrationConfig
optional

The configuration for public cloud metric integration

IntegrationConfig

name
required

Name of the remote storage configuration

string

scope
required

The scope of this remote storage config

RemoteWriteConfigScope

tls
optional

Tls configuration parameters

TlsConfig

writeRelabelConfigs
optional

Relabeling and filtering rules to be applied to the remote write config

string

RemoteWriteConfigResponse

Remote write storage configuration

Name Description Schema

accountId
required

Account ID which the remote storage configuration belongs to

string

address
required

Address of the remote storage

string

authHeader
optional

Authorization header parameters

AuthHeaderForResponse

authMethod
required

Authentication method of the remote storage

string

basicAuth
optional

Basic auth parameters

BasicAuthForResponse

customHeaders
optional

Additional custom HTTP header key-value pairs that are sent along with each remote write request.

< string, string > map

enabled
required

Enabled state of the remote storage config

boolean

id
required

UUID of the remote storage configuration

string

integrationConfig
optional

The configuration for public cloud metric integration

IntegrationConfigForResponse

name
required

Name of the remote storage configuration

string

scope
optional

The scope of this remote storage config

RemoteWriteConfigScopeForResponse

tls
optional

Tls configuration parameters

TlsConfigForResponse

writeRelabelConfigs
optional

Relabeling and filtering rules to be applied to the remote write config

string

RemoteWriteConfigScope

Remote write storage configuration scope

Name Description Schema

environmentCrn
required

Environment CRN filter for the scope. Empty means no filtering

string

type
required

The type of this remote storage config. Allowed values: all | controlplane | environments

string

RemoteWriteConfigScopeForResponse

Remote write storage configuration scope for response

Name Description Schema

environmentCrn
required

Environment CRN filter for the scope. Empty means no filtering

string

type
required

The type of this remote storage configuration. Allowed values: all | controlplane | environments

string

RemoteWriteStorageRequestForUpdate

Remote write storage configuration request for update

Name Description Schema

address
required

Address of the remote storage

string

authHeader
optional

Authorization header parameters

AuthHeader

authMethod
required

Authentication method of the remote storage

string

basicAuth
optional

Basic auth parameters

BasicAuth

customHeaders
optional

Additional custom HTTP header key-value pairs that are sent along with each remote write request.

< string, string > map

enabled
required

Enabled state of the remote storage config

boolean

id
required

UUID of the remote storage configuration

string

integrationConfig
optional

The configuration for public cloud metric integration

IntegrationConfig

name
required

Name of the remote storage configuration

string

scope
required

The scope of this remote storage config

RemoteWriteConfigScope

tls
optional

Tls configuration parameters

TlsConfig

writeRelabelConfigs
optional

Relabeling and filtering rules to be applied to the remote write config

string

RequestSignerCertificate

The configuration for public cloud metric integration

Name Description Schema

cdpAccessKeyId
optional

The key id of the public cloud certificate

string

privateKey
optional

The key information of the certificate

string

RequestSignerCertificateForResponse

The configuration for public cloud metric integration

Name Description Schema

cdpAccessKeyId
optional

The key id of the public cloud certificate

string

privateKey
optional

The key information of the certificate

string

TlsConfig

Tls configuration

Name Description Schema

clientCertificate
optional

Certificate for client cert authentication to the server

string

clientKey
optional

Key for client cert authentication to the server

string

insecureSkipVerify
required

Skip tls verification

boolean

serverName
optional

Tls ServerName extension to indicate the name of the server.

string

shouldUpdateClientKeyField
optional

Returns true if the ClientKey field was changed and should be updated

boolean

TlsConfigForResponse

Tls configuration for response

Name Description Schema

clientCertificate
optional

Certificate for client cert authentication to the server

string

insecureSkipVerify
required

Skip tls verification

boolean

isClientKeyFieldEmpty
required

Returns true if the ClientKey field is empty

boolean

serverName
optional

Tls ServerName extension to indicate the name of the server.

string

UpdateRemoteWriteConfigRequest

Update remote write storage configuration request

Name Description Schema

remoteWriteConfig
required

Remote storage configuration

RemoteWriteStorageRequestForUpdate

UpdateRemoteWriteConfigResponse

Update remote write storage configuration response

Name Description Schema

remoteWriteConfig
required

Remote storage configuration

RemoteWriteConfigResponse

Copyright © 2024 Cloudera, Inc. All rights reserved.