1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询自动授权规则授权范围主机信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAutoAuthorizedRuleHost。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
RuleId | 是 | Integer | 规则id 示例值:1 |
Limit | 否 | Integer | 需要返回的数量,默认为全部; 示例值:10 |
Offset | 否 | Integer | 偏移量,默认为0 示例值:0 |
Order | 否 | String | 排序字段 示例值:ASC |
By | 否 | String | 排序方式,asc,desc 示例值:ContainerCnt |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
List | Array of AutoAuthorizedRuleHostInfo | 镜像自动授权规则授权范围主机列表 示例值:[{"ContainerCnt": 97, "DockerVersion": "19.03.15", "HostID": "277622d2-afa8-4a63-97f0-9daf0540", "HostIP": "10.206.", "HostName": "tcs-dev-wor", "ImageCnt": 53, "InstanceID": "ins-5iuy", "MachineType": "CVM", "PublicIp": "119.45.14****", "Status": "ONLINE"}] |
TotalCount | Integer | 总数量 示例值:3 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询自动授权规则授权范围主机信息
输入示例
https://tcss.tencentcloudapi.com/?Action=DescribeAutoAuthorizedRuleHost
&RuleId=1
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"List": [
{
"ContainerCnt": 2,
"DockerVersion": "19.03.9",
"HostID": "8bc803fd-d85d-47b8-9e2b-9644674be677",
"HostIP": "1.1.1.1",
"HostName": "机器名称",
"ImageCnt": 1,
"InstanceID": "ins-8bc803fd",
"MachineType": "CVM",
"PublicIp": "1.1.1.1",
"Status": "ONLINE"
}
],
"RequestId": "8bc803fd-d85d-47b8-9e2b-9644674be677"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.ErrRuleNotFind | 当前规则信息未找到。 |
FailedOperation.RuleNotFind | 当前规则信息未找到。 |
InternalError | 内部错误。 |
InternalError.MainDBFail | 操作数据库失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.MissingParameter | 缺少必须参数。 |
InvalidParameter.ParsingError | 参数解析错误。 |
ResourceNotFound | 资源不存在。 |