DescribeWhiteBoxKeyDetails

Last updated: 2021-10-25 17:08:15

    1. API Description

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

    This API is used to get the white-box key list.

    A maximum of 50 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: DescribeWhiteBoxKeyDetails.
    Version Yes String Common parameter. The value used for this API: 2019-01-18.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    KeyStatus No Integer Filter: key status. 0: disabled, 1: enabled
    Offset No Integer This parameter has the same meaning of the Offset in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
    Limit No Integer This parameter has the same meaning of the Limit in an SQL query, indicating that up to Limit value elements can be obtained in this request. The default value is 0, indicating not to paginate.
    TagFilters.N No Array of TagFilter Tag filter condition

    3. Output Parameters

    Parameter Name Type Description
    KeyInfos Array of WhiteboxKeyInfo White-box key information list
    TotalCount Integer Total number of keys
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting white-box key list

    Input Example

    https://kms.tencentcloudapi.com/?Action=DescribeWhiteBoxKeyDetails
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "RequestId": "f6308605-f9d7-4a69-9401-c542cd414e00",
      "KeyInfos": [
        {
          "KeyId": "244dab8c-6dad-11ea-80c6-5254006d0810",
          "Alias": "xx",
          "CreateTime": 1585040099,
          "Description": "xx",
          "CreatorUin": 0,
          "OwnerUin": 0,
          "Status": "Disabled",
          "Algorithm": "SM4",
          "EncryptKey": "AAAAACL4R9T1M3r3/S9XpMbUbwHJUKbq/tll0Bop7LG90lHpj+DKmOiEE0Rs5rRrMNaCYIWzWJyU0SNQoX1WNn06QB2qrhDCXEPdwMwgJHx+YfJHUh/eSF5/LUEv27ltidqJyUk3HF5CZgjkN901hFEPf9ZCJcEo5XrORpopW7Ur6svPAjDtIPN3kUDCTqgTPC+FBX0cO/zEZFeMMAU2BPwe6f5O1x5BTrCBEf4qJDpZqT/WxXvSid8pFQ8uSxMqaf0ot57NzfuWG92oAe9HQ7bDCcfuBN7nXX+QipQIBxD/LVWk7zrHtLD/TJfAAoTuE7QKc/lSTOpI1xkTxJq/AFLd5K9EaBN7kpAkAsponZc20Tpk+KlyWE3NHdQrION9fsxtUBl5tz/l6T1j49SR5J2axZ2nnkA3o7L1WIGiv7r3tkd+",
          "DecryptKey": "AAAAACL4R9T1M3r3/S9XpMbUbwHJUKbq/tll0Bop7LG90lHpj+DKmOiEE0Rs5rRrMNaCYIWzWJyU0SNQoX1WNn06QB2qrhDCXEPdwMwgJHx+YfJHUh/eSF5/LUEv27ltidqJyUk3HF5CZgjkN901hFEPf9ZCJcEo5XrORpopW7Ur6svPAjDtIPN3kUDCTqgTPC+FBX0cO/zEZFeMMAU2BPwe6f5O1x5BTrCBEf4qJDpZqT/WxXvSid8pFQ8uSxMqaf0ot57NzfuWG92oAe9HQ7bDCcfuBN7nXX+QipQIBxD/LVWk7zrHtLD/TJfAAoTuE7QKc/lSTOpI1xkTxJq/AFLd5K9EaBN7kpAkAsponZc20Tpk+KlyWE3NHdQrION9fsxtUBl5tz/l6T1j49SR5J2axZ2nnkA3o7L1WIGiv7r3tkd+"
        },
        {
          "KeyId": "3d2de9cd-6daf-11ea-af24-5254006d0810",
          "Alias": "xxx",
          "CreateTime": 1585041000,
          "Description": "xx",
          "CreatorUin": 0,
          "OwnerUin": 0,
          "Status": "Enabled",
          "Algorithm": "SM4",
          "EncryptKey": "AAAAAE2+4Kz2XEgQkdJk2tZuDunuvGOrGd2lbD6tIZESi2sBNR/aTF2Bx/GWdl5sBNlfUKTIsrwxONNABo65mm6x1KmTUIZT/3aVVqK7PLINZ51g0t7i0gERdiimLxjVwQUstPLFqR2hrfcVR+TvheGskQgYJEpdQ1wthcOlm37SRjAvd6OdDx7gQtdutgf49SZ9YCVoYRf5phQDrKSc2WfxI96UwO2zoTCKD+aRB9u3hTzd7Z305kMJ6e+thcgUd+zzCy8KR/nAMeZ/8PKDsrQW/UsugZJLEBdrVk0vD0dQUCYGG7nSTjzS877+570H+WvyNfCCvzLvfu50PA7gLvyXLodppwqWJPOhqfPw9muoec9BD6vA1jxDnhlF6nb0GEh5V6QsAJUyVXzWMXJEce99u1DzeS4pRsc09/7GQ0HauJRz",
          "DecryptKey": "AAAAAE2+4Kz2XEgQkdJk2tZuDunuvGOrGd2lbD6tIZESi2sBNR/aTF2Bx/GWdl5sBNlfUKTIsrwxONNABo65mm6x1KmTUIZT/3aVVqK7PLINZ51g0t7i0gERdiimLxjVwQUstPLFqR2hrfcVR+TvheGskQgYJEpdQ1wthcOlm37SRjAvd6OdDx7gQtdutgf49SZ9YCVoYRf5phQDrKSc2WfxI96UwO2zoTCKD+aRB9u3hTzd7Z305kMJ6e+thcgUd+zzCy8KR/nAMeZ/8PKDsrQW/UsugZJLEBdrVk0vD0dQUCYGG7nSTjzS877+570H+WvyNfCCvzLvfu50PA7gLvyXLodppwqWJPOhqfPw9muoec9BD6vA1jxDnhlF6nb0GEh5V6QsAJUyVXzWMXJEce99u1DzeS4pRsc09/7GQ0HauJRz"
        }
      ]
    }
    }
    

    5. Developer Resources

    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 Internal error.
    InvalidParameterValue Incorrect parameter value.
    ResourceUnavailable.NotPurchased The white-box key service has not been activated.
    UnauthorizedOperation Unauthorized operation.