腾讯健康组学平台查询环境列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： omics.tencentcloudapi.com 。

查询环境列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeEnvironments。
Version	是	String	公共参数，本接口取值：2022-11-28。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	偏移量，默认为0。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：10
Filters.N	否	Array of Filter	过滤器，支持过滤字段： - EnvironmentId：环境ID - Name：名称 - Status：环境状态示例值：{"Name":["test"]}

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的数量。示例值：1
Environments	Array of Environment	环境详情列表。示例值：[{"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","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","IsManaged": false, "IsDefault": false}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询环境列表

查询环境列表。

输入示例

POST / HTTP/1.1
Host: omics.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
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。

查询环境列表

本页目录：