ListAccessKeys

Last updated: 2021-07-05 18:59:37

    1. API Description

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

    This API is used to list the access keys associated with a specified CAM user.

    A maximum of 200 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: ListAccessKeys.
    Version Yes String Common parameter. The value used for this API: 2019-01-16.
    Region No String Common parameter. This parameter is not required for this API.
    TargetUin No Integer UIN of the specified user. If this parameter is left empty, access keys of the current user will be listed by default

    3. Output Parameters

    Parameter Name Type Description
    AccessKeys Array of AccessKey Access key list
    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 Listing access keys

    Input Example

    https://cam.tencentcloudapi.com/?Action=ListAccessKeys
    &TargetUin=123456
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "AccessKeys": [
        {
          "AccessKeyId": "WERDlOp351234hlczDqKDvRjsvmQsJQWEaYK",
          "Status": "Active",
          "CreateTime": "2019-12-25 14:53:03"
        },
        {
          "AccessKeyId": "A2342hOvQQQWvNdgXHrFQOHySnzb5OVP7dv8",
          "Status": "Active",
          "CreateTime": "2020-03-03 16:51:21"
        }
      ],
      "RequestId": "bbc4c6b1-ee32-416a-9135-68de318c54f2"
    }
    }
    

    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
    FailedOperation.Accesskey An error occurred while manipulating the access key.
    InvalidParameter.ParamError Invalid input parameter.
    InvalidParameter.UserNotExist User object does not exist
    OperationDenied.AccessKeyOverLimit Each account can have up to two AccessKey.
    OperationDenied.SubUin The sub-user is not allowed to use the root account key.
    OperationDenied.UinNotMatch The access key does not match the account.