容器安全服务
- Product Introduction
- Operation Guide
- Vulnerability Detection
- Image Risk Management
- Cluster Risk Management
- Baseline Management
- Runtime Security
- Advanced Defense
- Abnormal Process
- File Tampering
- High-Risk Syscall
- Policy Management
- Container Network Policy
- Log Analysis
- Hybrid Cloud Installation Guide
- Troubleshooting
- API Documentation
- Making API Requests
- Network Security APIs
- Cluster Security APIs
- Security Compliance APIs
- Runtime security - High-risk syscalls
- Runtime Security - Reverse Shell APIs
- Runtime Security APIs
- Alert Settings APIs
- Advanced prevention - K8s API abnormal requests
- Asset Management APIs
- Security Operations - Log Analysis APIs
- Runtime Security - Trojan Call APIs
- Runtime Security - Container Escape APIs
- Image Security APIs
- Billing APIs
DescribeImageAutoAuthorizedRule
Last updated: 2024-12-06 15:48:21
1. API Description
Domain name for API request: tcss.intl.tencentcloudapi.com.
This API is used to query an automatic licensing rule 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: DescribeImageAutoAuthorizedRule. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
| Region | No | String | Common Params. This parameter is not required. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| IsEnabled | Integer | Whether the rule takes effect. Valid values: 0 (no); 1 (yes). |
| RangeType | String | Scope. Valid values: MANUAL (specified servers); ALL (all images).Note: This field may return null, indicating that no valid values can be obtained. |
| HostCount | Integer | Number of servers when the scope is MANUALNote: This field may return null, indicating that no valid values can be obtained. |
| MaxDailyCount | Integer | Maximum number of image licenses per day. 0: Unlimited.Note: This field may return null, indicating that no valid values can be obtained. |
| RuleId | Integer | Rule ID, which is 0 if not specified.Note: This field may return null, indicating that no valid values can be obtained. |
| 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 an automatic licensing rule for local images
Input Example
https://tcss.intl.tencentcloudapi.com/?Action=DescribeImageAutoAuthorizedRule
&<Common request parameters>
Output Example
{
"Response": {
"MaxDailyCount": 0,
"RangeType": "xx",
"RuleId": 1,
"HostCount": 0,
"RequestId": "xx",
"IsEnabled": 0
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| InternalError | An internal error occurred. |
| InternalError.MainDBFail | The database operation failed. |
| InvalidParameter | The parameter is incorrect. |
| InvalidParameter.ParsingError | A parameter parsing error occurred. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No