ListSecrets

Last updated: 2020-12-07 11:24:52

    1. API Description

    Domain name for API request: ssm.tencentcloudapi.com.

    This API is used to obtain the detailed information list of all Secrets. You can specify the filter fields and sorting order as needed.

    A maximum of 30 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ListSecrets.
    Version Yes String Common parameter. The value used for this API: 2019-09-23.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Offset No Integer Starting position of the list, starting at 0. If not specified, 0 is used by default.
    Limit No Integer Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.
    OrderType No Integer Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.
    State No Integer Filter according to Secret statuses. 0 (default): all Secrets; 1: Secrets in Enabled status; 2: Secrets in Disabled status; 3: Secrets in PendingDelete status.
    SearchSecretName No String Filter according to Secret names. If left empty, this filter is not applied.
    TagFilters.N No Array of TagFilter Tag filter condition.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of filtered Secrets according to State and SearchSecretName.
    SecretMetadatas Array of SecretMetadata List of Secret information.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining the detailed information list of Secrets

    Input Example

    https://ssm.tencentcloudapi.com/?Action=ListSecrets
    &Limit=2
    &<Common Request Parameters>

    Output Example

    {
      "Response": {
        "RequestId": "3586bdc7-c8a5-4ccd-883f-9f256a96533a",
        "TotalCount": 8,
        "SecretMetadatas": [
          {
            "SecretName": "test",
            "Description": "test version 1.0",
            "KmsKeyId": "13437ab9-e002-11e9-9936-5254006d0810",
            "KmsKeyType": "DEFAULT",
            "CreateUin": 3350000000,
            "Status": "Enabled",
            "DeleteTime": 0,
            "CreateTime": 1574160561
          },
          {
            "SecretName": "test2",
            "Description": "test desc 2",
            "KmsKeyId": "13437ab9-e002-11e9-9936-5254006d0810",
            "KmsKeyType": "DEFAULT",
            "CreateUin": 3350000000,
            "Status": "Enabled",
            "DeleteTime": 0,
            "CreateTime": 1574067178
          }
        ]
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError An internal error occurred.
    InvalidParameterValue The parameter value is invalid.
    ResourceUnavailable.NotPurchased The service is not purchased.
    UnauthorizedOperation The operation is unauthorized.