tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCosCredential

Last updated: 2024-09-02 19:06:26

1. API Description

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

This API is used to query COS key information.

A maximum of 20 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 Params. The value used for this API: DescribeCosCredential.
Version Yes String Common Params. The value used for this API: 2022-01-10.
Region No String Common Params. This parameter is not required for this API.
ApplicationId Yes String Application ID.
ApplicationFileName No String Application file name (the file must be a compressed package with a zip/rar/7z file name extension).

3. Output Parameters

Parameter Name Type Description
SecretID String Cos SecretID
SecretKey String Cos SecretKey
SessionToken String Cos SessionToken
CosBucket String Cos Bucket
CosRegion String Cos Region
Path String COS operation path.
StartTime Integer Start time of the COS key.
ExpiredTime Integer Expiration time of the COS key.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying COS Key Information

Input Example

POST / HTTP/1.1
Host: car.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCosCredential
<Common request parameters>



{
    "ApplicationId": "app-fcegkdfa",
    "ApplicationFileName": "xxx.rar"
}

Output Example

{
    "Response": {
        "SecretID": "xxx",
        "SecretKey": "xxx",
        "SessionToken": "xxx",
        "CosBucket": "examplebucket-1250000000",
        "CosRegion": "ap-guangzhou",
        "Path": "103121832/app-fcegkdfa/ver-xxx/app-fcegkdfa.rar",
        "StartTime": 1500000,
        "ExpiredTime": 1000000,
        "RequestId": "4eb17e58-68da-4e9a-b298-0894723c9022"
    }
}

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
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
FailedOperation.ApplicationLockFail Application lock failed.
FailedOperation.ApplicationNotFind Application does not exist.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
OperationDenied Operation denied.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy