1. 接口描述
接口请求域名： trp.tencentcloudapi.com 。
查自定义码规则列表
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCustomRules。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-15。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Keyword | 否 | String | 搜索关键字 示例值：关键字 |
| PageSize | 否 | Integer | 条数 示例值：10 |
| PageNumber | 否 | Integer | 页数 示例值：1 |
| CorpId | 否 | Integer | 企业ID 示例值：0 |
| Status | 否 | Integer | 码规则状态 0:未生效 1:已生效 -1:已失效 示例值：1 |
| MerchantId | 否 | String | 商户ID 示例值：商户ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CustomRules | Array of CustomRule | 码规则列表 |
| TotalCount | Integer | 总数 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查自定义码规则列表
输入示例
POST / HTTP/1.1
Host: trp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCustomRules
<公共请求参数>
{
"Keyword": "",
"PageSize": 10,
"PageNumber": 1
}输出示例
{
"Response": {
"TotalCount": 0,
"CustomRules": [
{
"CustomId": "gss06ki67crv",
"Name": "demo2",
"CorpId": 10000,
"MerchantId": "6b1tvtwfve3n",
"CodeLength": 16,
"Status": 1,
"CodeParts": [],
"CreateTime": "2022-09-19T11:46:53.000Z",
"UpdateTime": "2022-09-19T11:48:06.000Z"
}
],
"RequestId": "eaa3ccac-d2f5-4df0-a8b3-7b51324e9283"
}
}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签名/鉴权错误。 |
| AuthFailure.CorpExpired | 企业服务时间已到期。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
