Updated on 2023-11-23 GMT+08:00

Querying Secret Details

Function

This API is used to query the details about a secret.

URI

GET /v2/{project_id}/edgemgr/secrets/{secret_id}

Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

secret_id

Yes

Secret ID.

Request

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response

Response parameters

Table 3 Parameters in the response body

Parameter

Type

Description

secret

Table 4 object

Secret information.

Table 4 secret

Parameter

Type

Description

id

String

Secret ID.

name

String

Secret name.

description

String

Secret description.

secrets

Map<String, String>

Secret list.

project_id

String

Project ID.

created_at

String

Time when the secret is created.

updated_at

String

Time when the secret is updated.

type

String

Secret type.

Example response

{
    "secret": {
        "id": "12ns9eb6cc0d49a0941df2f31283mds8 ",
        "name": "test-secret",
        "description": "this is a test secret",
        "secrets": {
            "key1": "val-1",
            "key2": "val-2"
        },
        "project_id": "d16e6eb6cc0d49a0941df2f31285757a",
        "created_at": "2018-07-16T13:41:25.347335",
        "updated_at": "2018-07-18T13:41:25.347335",
        "type": "Opaque"
    }
}

Error Codes

For details, see Error Codes.