1. 接口描述
接口请求域名: ssa.tencentcloudapi.com 。
资产安全页资产详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAssetDetail。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Params | 是 | String | 查询过滤参数 示例值:{"id":"xxx"} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | AssetDetail | 资产详情 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资产安全页资产详情
输入示例
POST / HTTP/1.1
Host: ssa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetDetail
<公共请求参数>
{
"Params": "{\"id\":\"xxx\"}"
}
输出示例
{
"Response": {
"Data": {
"Region": "华南地区(广州)",
"VpcId": "基础网络",
"ProductType": null,
"AssetStatus": "运行中",
"AssetType": "cvm",
"Id": "1445149556-cvm-ins-3o0cn0bo",
"Tag": [
{
"Fname": "test1",
"Fid": 255
},
{
"Fname": "test2",
"Fid": 256
},
{
"Fname": "dasd",
"Fid": 257
},
{
"Fname": "222",
"Fid": 258
}
],
"Name": "云鼎-张云飞-LINUX测试",
"AssetUniqid": "ins-3o0cn0bo",
"InstanceType": "I2.MEDIUM4",
"InstanceState": "RUNNING",
"PublicIpAddresses": [
"118.89.39.26"
],
"PrivateIpAddresses": [
"10.104.119.159"
],
"EngineVersion": "",
"Vip": "10.104.119.159",
"Status": null,
"LoadBalancerVips": null,
"Uin": null,
"CreationDate": null,
"Domain": null,
"InstanceId": "ins-3o0cn0bo",
"DiskType": null,
"DiskSize": null,
"CertType": null,
"ProjectName": "",
"CertEndTime": null,
"ValidityPeriod": null,
"SsaAssetDiscoverTime": "2020-03-31 21:34:55",
"AssetSubnetId": "",
"AssetSubnetName": "",
"AssetVpcName": "",
"ClusterType": 0,
"NameSpace": "",
"AssetCreateTime": "",
"LoadBalancerType": null,
"AssetIpv6": [],
"AssetVulNum": 0,
"GroupName": "",
"Port": [
"http(8080)",
"http(80)"
],
"RiskConfig": [
"安全组配置",
"主机安全防护状态",
"密钥对登陆"
],
"Event": "[{\"key\":\"11\",\"doc_count\":1334}]",
"Vul": "[]",
"SSHRisk": "",
"RDPRisk": "",
"EventRisk": "资产失陷"
},
"RequestId": "f86588f7-fb1f-4fdd-9c8b-c882f044eeb0"
}
}
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 | 参数错误。 |