tencent cloud

Feedback

GetAttributeKey

Last updated: 2023-01-04 11:45:00
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query the valid values of AttributeKey.

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: GetAttributeKey.
Version Yes String Common Params. The value used for this API: 2019-03-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou.
WebsiteType No String Website type. Valid values: zh, en. If this parameter is left empty, zh will be used by default

3. Output Parameters

Parameter Name Type Description
AttributeKeyDetails Array of AttributeKeyDetail Valid values of AttributeKey
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the valid values of AttributeKey

This example shows you how to query the valid values of AttributeKey.

Input Example

https://cloudaudit.tencentcloudapi.com/?Action=GetAttributeKey
&WebsiteType=zh
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6d833833-bbc6-4463-9a8f-6cc62d3a2afd",
        "AttributeKeyDetails": [
            {
                "Label": "Read-only",
                "Value": "ReadOnly",
                "Starter": "Select the read-only value",
                "LabelType": "select",
                "Order": 1
            },
            {
                "Label": "Access key",
                "Value": "AccessKeyId",
                "Starter": "Enter the access key",
                "LabelType": "text",
                "Order": 2
            },
            {
                "Label": "Request ID",
                "Value": "RequestId",
                "Starter": "Enter the request ID",
                "LabelType": "text",
                "Order": 3
            },
            {
                "Label": "Event name",
                "Value": "EventName",
                "Starter": "Select the event name",
                "LabelType": "select",
                "Order": 4
            },
            {
                "Label": "Resource name",
                "Value": "ResourceName",
                "Starter": "Enter the resource name",
                "LabelType": "text",
                "Order": 5
            },
            {
                "Label": "Resource type",
                "Value": "ResourceType",
                "Starter": "Select the resource type",
                "LabelType": "select",
                "Order": 6
            },
            {
                "Label": "Username",
                "Value": "Username",
                "Starter": "Select the username",
                "LabelType": "select",
                "Order": 7
            }
        ]
    }
}

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.SearchError An internal error occurred. Submit a ticket for assistance.