1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
获取自定义脚本信息列表
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeUserCmds。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 是 | Integer | 偏移量 |
Limit | 是 | Integer | 数量限制 |
OrderField | 否 | String | 排序字段,支持: OsType,CreateTime,ModifyTime |
Order | 否 | Integer | 排序方式,取值: 1倒序,0顺序;默认倒序 |
SearchKey | 否 | String | 关键字搜索,可搜索ID或别名,支持模糊搜索 |
CmdId | 否 | String | 查询的脚本ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 返回数量 |
UserCmds | Array of UserCmd | 脚本信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取自定义脚本信息列表
输入示例
https://bm.tencentcloudapi.com/?Action=DescribeUserCmds
&Offset=0
&Limit=10
&OrderField=createTime
&Order=1
&SearchKey=3
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 8,
"UserCmds": [
{
"AutoId": 87,
"Alias": "111",
"CmdId": "cmd-dr3ja3hq",
"OsType": "linux",
"Content": "IyEvYmluL2Jhc2gKZm9yIGkgaW4gezEuLjEwMH0KZG8KICAgIGVjaG8gJGkKCXNsZWVwIDEwCmRvbmUK",
"CreateTime": "2018-05-31 11:57:39",
"ModifyTime": "2018-06-15 20:12:59",
"AppId": 123
},
{
"AutoId": 53,
"Alias": "aa",
"CmdId": "cmd-o9o03bk8",
"OsType": "linux",
"Content": "U1hsRmRtUllUbmxNTWtwd1ltazVkMkZJUVV0UVJEbDNZVWhCUzBOcFVtcGlNMVoxWkVOQk9VbEVRVGREYm1SdllWZDRiRWxEYURCamJsWnNTMUZ3TjBObmEydFpNamt4WW01UmNrdDZjMHREV0U1eldsZFdkMHRFU1hCUGQyOUtXbGRPYjJKNVFXdFpNamt4WW01Uk4wTnVNRDA9",
"CreateTime": "2017-10-19 16:06:59",
"ModifyTime": "2017-10-19 16:54:13",
"AppId": 123
},
{
"AutoId": 28,
"Alias": "for",
"CmdId": "cmd-ow3g7elm",
"OsType": "linux",
"Content": "Iy9iaW4vYmFzaApjbGVhcgpmb3IgbnVtIGluIDEgMiAzIDQgNSA2IDcgOCA5IDEwCmRvCiAgICBlY2hvICIkbnVtIgpkb25l",
"CreateTime": "2017-10-12 21:33:00",
"ModifyTime": "2017-10-12 21:33:00",
"AppId": 123
},
{
"AutoId": 27,
"Alias": "比较两数大小",
"CmdId": "cmd-jvrav3la",
"OsType": "linux",
"Content": "Iy9iaW4vYmFzaAplY2hvICJwbGVhc2UgZW50ZXIgdHdvIG51bWJlciIKcmVhZCBhCnJlYWQgYgppZiB0ZXN0ICRhIC1lcSAkYgp0aGVuIGVjaG8gIk5PLjEgPSBOTy4yIgplbGlmIHRlc3QgJGEgLWd0ICRiCnRoZW4gZWNobyAiTk8uMSA+IE5PLjIiCmVsc2UgZWNobyAiTk8uMSA8IE5PLjIiIApmaQ==",
"CreateTime": "2017-10-12 21:14:56",
"ModifyTime": "2017-10-12 21:14:56",
"AppId": 123
},
{
"AutoId": 8,
"Alias": "1测试",
"CmdId": "cmd-c33atn9o",
"OsType": "linux",
"Content": "dW5hbWVlIC1hIApwd2QKCmxzIFwKLWwKCmVjaG8gJDEK",
"CreateTime": "2017-10-10 18:38:19",
"ModifyTime": "2017-10-10 18:49:34",
"AppId": 123
}
],
"RequestId": "5fa2a5ff-de11-414d-ae12-f45bf7a87fe4"
}
}
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 | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |