1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
获取安全组关联实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAssociatedInstanceList。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Offset | 是 | Integer | 列表偏移量 示例值：0 |
| Limit | 是 | Integer | 每页记录条数 示例值：10 |
| Area | 是 | String | 地域代码（例：ap-guangzhou）,支持腾讯云全地域 示例值：ap-beijing |
| SearchValue | 否 | String | 额外检索条件（JSON字符串） |
| By | 否 | String | 排序字段 |
| Order | 否 | String | 排序方式（asc:升序,desc:降序） |
| SecurityGroupId | 否 | String | 安全组ID |
| Type | 否 | String | 实例类型,'3'是cvm实例,'4'是clb实例,'5'是eni实例,'6'是云数据库 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 实例数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：2 |
| Data | Array of AssociatedInstanceInfo | 实例列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询安全组关联实例列表
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssociatedInstanceList
<公共请求参数>
{
"Area": "xx",
"SecurityGroupId": "xx",
"SearchValue": "xx",
"By": "xx",
"Limit": 1,
"Offset": 1,
"Type": "xx",
"Order": "xx"
}输出示例
{
"Response": {
"Data": [
{
"InstanceId": "eni-4ymwnaoe",
"InstanceName": "test-private",
"Type": 5,
"VpcId": "vpc-406waega",
"VpcName": "vpc---",
"PublicIp": "",
"Ip": "192.168.0.13,192.168.0.3",
"SecurityGroupCount": 1
},
{
"InstanceId": "eni-oskydbvm",
"InstanceName": "privat-test",
"Type": 5,
"VpcId": "vpc-dvc0qmmm",
"VpcName": "Dno",
"PublicIp": "",
"Ip": "172.21.0.12",
"SecurityGroupCount": 0
}
],
"Total": 2,
"RequestId": "8f563b4d-8151-4db0-a822-9bde279d2079"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| UnauthorizedOperation | 未授权操作。 |