有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: ms.tencentcloudapi.com 。

获取某个用户的所有资源信息。(注意:根据国家互联网用户实名制相关要求,使用该产品前,需先完成实名认证。)

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeResourceInstances。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,本接口不需要传递此参数。
Filters.N Array of Filter 支持CreateTime、ExpireTime、AppName、AppPkgName、BindValue、IsBind过滤
Offset Integer 偏移量,默认为0
示例值:0
Limit Integer 数量限制,默认为20,最大值为100。
示例值:20
Pids.N Array of Integer 资源类别id数组,13624:加固专业版,12750:企业版。空数组表示返回全部资源。
示例值:["12750\r\n"]
OrderField String 按某个字段排序,目前支持CreateTime、ExpireTime其中的一个排序。
示例值:CreateTime
OrderDirection String 升序(asc)还是降序(desc),默认:desc。
示例值:desc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合要求的资源数量
示例值:10
ResourceSet Array of ResourceInfo 符合要求的资源数组
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取某个用户的加固资源信息

获取某个用户的加固资源信息

输入示例

POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourceInstances
<公共请求参数>

{
    "Pids": [
        "12750"
    ],
    "Limit": "20",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "xx",
        "ResourceSet": [
            {
                "ResourceId": "xx",
                "Pid": 1,
                "ExpireTime": 1,
                "IsBind": 1,
                "ResourceName": "xx",
                "BindInfo": {
                    "AppPkgName": "xx",
                    "AppIconUrl": "xx",
                    "AppName": "xx"
                },
                "CreateTime": 1
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError.ServerError 服务端无法响应。
InvalidParameterValue.InvalidFilter 无效的过滤器。
InvalidParameterValue.InvalidLimit Limit不是有效的数字。
InvalidParameterValue.InvalidOffset Offset不是有效的数字。
LimitExceeded 超过配额限制。
ResourceUnavailable 资源不可用。
ResourceUnavailable.NotFound 找不到该资源。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NotWhiteUser 不是白名单用户。