接口请求域名： omics.intl.tencentcloudapi.com 。
查询环境列表。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEnvironments。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Offset | 否 | Integer | 偏移量，默认为0。 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。 |
| Filters.N | 否 | Array of Filter | 过滤器，支持过滤字段： - EnvironmentId：环境ID - Name：名称 - Status：环境状态 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的数量。 |
| Environments | Array of Environment | 环境详情列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
查询环境列表。
POST / HTTP/1.1
Host: omics.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvironments
<公共请求参数>
{
"Offset": 0,
"Limit": 1
}
{
"Response": {
"Environments": [
{
"Available": true,
"CreationTime": "2022-12-14T16:14:49+08:00",
"Description": "test description",
"EnvironmentId": "env-lljckw12",
"LastWorkflowUuid": "94922fcd-107e-4220-9a0f-cc3cd84a9a27",
"Message": "",
"Name": "test name",
"Region": "ap-guangzhou",
"ResourceIds": {
"CFSId": "cfs-iwee8gk3",
"CFSStorageType": "SD",
"CVMId": "ins-jcbptifa",
"EKSId": "cls-9j9zh13o",
"SecurityGroupId": "sg-gzsfk3r5",
"SubnetId": "subnet-qdkfn4xe",
"TDSQLCId": "cynosdbmysql-kzwghvxj",
"VPCId": "vpc-8yhq1v63"
},
"Status": "RUNNING",
"Type": "KUBERNETES",
"IsDefault": false,
"IsManaged": false
}
],
"RequestId": "1bc7ec7d-5fa9-42af-ac6d-1ef56f3bf625",
"TotalCount": 10
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| OperationDenied | 操作被拒绝。 |
文档反馈