1. 接口描述
接口请求域名： tse.tencentcloudapi.com 。
查询服务契约定义列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGovernanceServiceContracts。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, na-siliconvalley, na-toronto, sa-saopaulo 。 |
| InstanceId | 是 | String | 北极星引擎实例ID 示例值：ins-123456 |
| Offset | 否 | Integer | 分页偏移量 示例值：0 |
| Limit | 否 | Integer | 分页条数 示例值：100 |
| Namespace | 否 | String | 命名空间 示例值：namespace |
| Service | 否 | String | 服务名 示例值：service |
| Name | 否 | String | 契约名称 示例值：name |
| ContractVersion | 否 | String | 契约版本 示例值：v1.0.0 |
| Protocol | 否 | String | 契约协议 示例值：http |
| Brief | 否 | Boolean | 是否只展示基本信息 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 |
| Size | Integer | 返回条数 |
| ServiceContracts | Array of GovernanceServiceContract | 契约定义列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询服务契约定义列表
查询服务契约定义列表
输入示例
POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGovernanceServiceContracts
<公共请求参数>
{
"InstanceId": "abc",
"Namespace": "abc",
"Service": "abc",
"Name": "abc",
"ContractVersion": "abc",
"Protocol": "abc",
"Brief": true,
"Offset": 0,
"Limit": 0
}输出示例
{
"Response": {
"TotalCount": 0,
"Size": 0,
"ServiceContracts": [
{
"Name": "abc",
"Namespace": "abc",
"Protocol": "abc",
"ID": "abc",
"Service": "abc",
"Version": "abc",
"Revision": "abc",
"Content": "abc",
"CreateTime": "abc",
"ModifyTime": "abc",
"Interfaces": [
{
"ID": "abc",
"Method": "abc",
"Path": "abc",
"Content": "abc",
"Source": "abc",
"Revision": "abc",
"CreateTime": "abc",
"ModifyTime": "abc",
"Name": "abc"
}
]
}
],
"RequestId": "abc"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。