ListKeys

Last Updated: Mar 13, 2017

Returns all users’ KeyIDs.

  • Request format
  1. PageNumber=number&PageSize=number
  • Request parameters

    • PageNumber

      • Description: Current page number

      • Type: Integer

      • Valid value: An integer greater than 0. The default value is 1.

      • Required or not: No

    • PageSize

      • Description: Number of items on each page

      • Type: Integer

      • Valid value: An integer greater than 0 and less than 101. The default value is 10.

      • Required or not: No

  • Request example

  1. https://kms.cn-hangzhou.aliyuncs.com/?Action=ListKeys
  2. &PageNumber=1
  3. &PageSize=10
  4. &<Other public parameters>
  • Return format
  1. {
  2. "TotalCount": integer,
  3. "PageNumber": integer,
  4. "PageSize": integer,
  5. "Keys":{
  6. "Key":[
  7. {
  8. "KeyId": "string"
  9. },
  10. {
  11. "KeyId": "string"
  12. }
  13. ]
  14. },
  15. "RequestId":"string"
  16. }
  • Return parameters
    • KeyId
      • Description: Globally unique identifier of a key
      • Type: String
    • TotalCount
      • Description: Total number of keys
      • Type: Integer
    • PageNumber
      • Description: Current page number
      • Type: Integer
    • PageSize
      • Description: Number of items on each page
      • Type: Integer
    • RequestId
      • Description: Random access ID
      • Type: String
  • Return example:
  1. //json response
  2. {
  3. "Keys": {
  4. "Key": [
  5. {
  6. "KeyId": "key1"
  7. },
  8. {
  9. "KeyId": "key2"
  10. },
  11. {
  12. "KeyId": "key3"
  13. }
  14. ]
  15. },
  16. "TotalCount": 3,
  17. "PageNumber": 1,
  18. "PageSize": 10,
  19. "RequestId": "1fbcd12a-1b7f-468f-84a3-1ff3444dfd8b"
  20. }
  21. //xml response
  22. <KMS>
  23. <Keys>
  24. <Key>
  25. <KeyId>key1</KeyId>
  26. </Key>
  27. <Key>
  28. <KeyId>key2</KeyId>
  29. </Key>
  30. <Key>
  31. <KeyId>key3</KeyId>
  32. </Key>
  33. </Keys>
  34. <TotalCount>3</TotalCount>
  35. <PageNumber>1</PageNumber>
  36. <PageSize>10</PageSize>
  37. <RequestId>1050b8f1-b264-496d-a782-6299cbaf15f8</RequestId>
  38. </KMS>
Thank you! We've received your feedback.