Querying a List of Secrets

Function

This API is used to query a list of secrets.

URI

GET /v2/{project_id}/edgemgr/secrets?{name=xxx,limit=xxx,offset=xxx,sort=xxx}

**Table 1** Path parameter
Parameter	Mandatory	Description
project_id	Yes	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Secret name, which supports fuzzy match.
limit	No	String	Number of records displayed on each page. The value range is 1–1000.
offset	No	String	Start position for a query. The value is a non-negative integer. The default value is 0.
sort	No	String	Sorting mode. Secrets can be sorted by name, creation time, or update time. The options are as follows: name created_at updated_at By default, the query results are sorted in ascending order. For example, sort is set to name. If the query results need to be sorted in descending order, set sort to name%3Adesc.

If no query parameter is specified, all secrets of an account are returned.
If multiple query parameters are specified, the secrets that meet all the specified query parameters are returned.

Request

**Table 3** 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 4** Parameters in the response body
Parameter	Type	Description
secrets	Array of Table 5 objects	Secret list.
count	Integer	Number of secrets that meet the conditions.

**Table 5** 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

{
    "count": 1,
    "secrets": [
        {
            "id": "12ns9eb6cc0d49a0941df2f31283mds8 ",
            "name": "test-secret",
            "description": "this is a test secret",
            "secrets": {
                "key1": "val1",
                "key3": "val3"
            },
            "project_id": "d16e6eb6cc0d49a0941df2f31285757a",
            "created_at": "2018-07-16T13:41:25.347335",
            "updated_at": "2018-07-19T13:41:25.347335",
            "type": "Opaque"
        }
    ]
}