tencent cloud

Feedback

DescribeDBCharsets

Last updated: 2024-11-26 16:33:26

    1. API Description

    Domain name for API request: sqlserver.intl.tencentcloudapi.com.

    This API is used to query the database character sets supported by an instance.

    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: DescribeDBCharsets.
    Version Yes String Common Params. The value used for this API: 2018-03-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID in the format of mssql-j8kv137v

    3. Output Parameters

    Parameter Name Type Description
    DatabaseCharsets Array of String Database character set list
    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 the supported database character sets

    Input Example

    https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeDBCharsets
    &InstanceId=mssql-njj2mtpl
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "DatabaseCharsets": [
                "SQL_EBCDIC1141_CP1_CS_AS",
                "SQL_EBCDIC277_2_CP1_CS_AS",
                "SQL_Ukrainian_CP1251_CI_AS",
                "SQL_Ukrainian_CP1251_CS_AS"
            ],
            "RequestId": "b28ec299-0063-4195-9273-ebac5cdc485c"
        }
    }
    

    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
    InternalError Internal error.
    InternalError.DBConnectError Database connection error.
    InternalError.DBError Database error
    InvalidParameter Invalid parameter.
    InvalidParameter.InputIllegal Input error.
    InvalidParameter.InterfaceNameNotFound The API does not exist.
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.ParameterTypeError Incorrect parameter type.
    ResourceNotFound Resource not found.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    UnknownParameter Unknown parameter error