DescribeKey

Last Updated: Mar 13, 2017

Returns information about a specified KeyID.

  • Request format
  1. KeyId="string"
  • Request parameters

    • KeyId
      • Description: Globally unique identifier of a key
      • Type: String
      • Required or not: Yes
  • Request example

  1. https://kms.cn-hangzhou.aliyuncs.com/?Action=DescribeKey
  2. &KeyId=<your-key-id>
  3. &<Other public parameters>
  • Return format
  1. {
  2. "KeyMetadata": {
  3. "CreationDate": "string",
  4. "Description": "string",
  5. "KeyId": "string",
  6. "KeyState": "string",
  7. "KeyUsage": "string",
  8. "DeleteDate": "string",
  9. "Creator": "string"
  10. },
  11. "RequestId":"string"
  12. }
  • Return parameters

    • CreationDate
      • Description: Date and time when a key is created
      • Type: String
    • KeyId
      • Description: Globally unique identifier of a key
      • Type: String
        • KeyState
      • Description: State of a key
      • Type: String
    • KeyUsage
      • Description: Usage of a key
      • Type: String
    • Description
      • Description: Description of CMK
      • Type: String
        • DeleteDate
        • Description: The time when KMS plans to be deleted (UTC time). Empty string means key will not be deleted.
        • Type: String
        • Creator
        • Description: the primary account id of key creator
        • Type: String
    • RequestId
      • Description: Random access ID
      • Type: String
  • Return example:

  1. //json response
  2. {
  3. "KeyMetadata": {
  4. "CreationDate": "2016-03-25T10:42:40Z",
  5. "Description": "test",
  6. "KeyId": "*******************",
  7. "KeyState": "Enabled",
  8. "KeyUsage": "ENCRYPT/DECRYPT",
  9. "DeleteDate": "",
  10. "Creator": "*******************"
  11. },
  12. "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
  13. }
  14. //xml response
  15. <KMS>
  16. <KeyMetadata>
  17. <CreationDate>2016-03-25T10:40:47Z</CreationDate>
  18. <Description>test</Description>
  19. <KeyId>*******************</KeyId>
  20. <KeyState>Enabled</KeyState>
  21. <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
  22. <DeleteDate></DeleteDate>
  23. <Creator>*******************</Creator>
  24. </KeyMetadata>
  25. <RequestId>6cb4bf6b-d9c9-4660-af5f-2328378e7257</RequestId>
  26. </KMS>
Thank you! We've received your feedback.