rds.tls.get

The TLS requirement and certificate; with clients=true, every client connected without TLS on either port

GET /rds/api/instances/{id}/tlsIAM rds:DescribeDBInstancesRead

Request syntax

GET /rds/api/instances/{id}/tls

Path parameters

  • idRequired

    string

    Constraints: 3-64 chars, /^(?!ewdoc-)[a-z0-9-]+$/

Query parameters

  • clientsOptional

    enum

    Also list the clients connected without TLS right now

    One of: true, false

    Default: "false"

Response

200 with required, certificate ({ serial, notAfter } or null), plaintextClients (null unless clients=true), unaskedNodes and plaintextError.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • requiredAlways

    boolean

    Whether clients that do not use TLS are refused
  • certificateAlways

    object, may be null

    The server certificate; null: the database has none
  • certificate.​serialAlways

    string

    Serial of the server certificate
  • certificate.​notAfterAlways

    string, may be null

    When it expires
  • plaintextClientsAlways

    array of object, may be null

    Clients connected without TLS now; null unless clients=true was asked
  • plaintextClients[].​nodeAlways

    string

    Node the client is connected to
  • plaintextClients[].​portAlways

    number

    5432 (direct) or 6432 (pooler)
  • plaintextClients[].​userAlways

    string

    Role
  • plaintextClients[].​databaseAlways

    string, may be null

    Database
  • plaintextClients[].​applicationAlways

    string, may be null

    application_name the client set
  • plaintextClients[].​addressAlways

    string

    Client address
  • plaintextClients[].​connectionsAlways

    number

    Connections from it
  • unaskedNodesAlways

    array of string

    Nodes that could not be asked for their clients
  • plaintextErrorAlways

    string, may be null

    Why the clients could not be listed; null otherwise

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow rds:DescribeDBInstances on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud rds tls get id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_tls_get.