tencent cloud

文档反馈

SwitchImageAutoAuthorizedRule

最后更新时间:2023-12-04 17:12:43

    1. API Description

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

    This API is used to enable/disable automatic licensing for local images.

    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: SwitchImageAutoAuthorizedRule.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    IsEnabled Yes Integer Whether the rule takes effect. Valid values: 0 (no); 1 (yes).
    RuleId Yes Integer Rule ID

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Enabling/Disabling automatic licensing for local images

    Input Example

    https://tcss.tencentcloudapi.com/?Action=SwitchImageAutoAuthorizedRule
    &IsEnabled=1
    &RuleId=1
    
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "xx"
        }
    }
    

    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 A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    FailedOperation.ErrRuleNotFind The rule is not found.
    FailedOperation.RuleNotFind The rule is not found.
    InternalError An internal error occurred.
    InternalError.MainDBFail The database operation failed.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    InvalidParameter.ParsingError A parameter parsing error occurred.
    ResourceNotFound The resource does not exist.