describe-remote-write-config¶
- subtitle
Describe remote storage configuration
- version
0.9.121
Description¶
Returns a remote storage configuration
Synopsis¶
describe-remote-write-config
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--id
(string)
UUID of the remote storage configuration
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
remoteWriteConfig -> (object)
Remote write storage configuration
address -> (string)
Address of the remote storage
authMethod -> (string)
Authentication method of the remote storage
enabled -> (boolean)
Enabled state of the remote storage config
id -> (string)
UUID of the remote storage configuration
name -> (string)
Name of the remote storage configuration
accountId -> (string)
Account ID which the remote storage configuration belongs to
authHeader -> (object)
Authorization header configuration response
type -> (string)
Authorization header type
basicAuth -> (object)
Basic auth configuration response
username -> (string)
Username for the remote storage configuration
customHeaders -> (map)
Additional custom HTTP header key-value pairs that are sent along with each remote write request.
key -> (string)
value -> (string)
scope -> (object)
Remote write storage configuration scope for response
environmentCrn -> (string)
Environment CRN filter for the scope. Empty means no filtering
type -> (string)
The type of this remote storage configuration. Allowed values: all | controlplane | environments
integrationConfig -> (object)
The configuration for public cloud metric integration
requestSignerCertificate -> (object)
The configuration for public cloud metric integration
cdpAccessKeyId -> (string)
The key id of the public cloud certificate
privateKey -> (string)
The key information of the certificate
writeRelabelConfigs -> (string)
Relabeling and filtering rules to be applied to the remote write config
tls -> (object)
Tls configuration for response
insecureSkipVerify -> (boolean)
Skip tls verification
isClientKeyFieldEmpty -> (boolean)
Returns true if the ClientKey field is empty
serverName -> (string)
Tls ServerName extension to indicate the name of the server.
clientCertificate -> (string)
Certificate for client cert authentication to the server
Form Factors¶
private