微服务引擎 TSE 查询引擎实例列表-微服务引擎相关接口-API 中心-腾讯云

1. 接口描述

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

用于查询引擎实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSREInstances。
Version	是	String	公共参数，本接口取值：2020-12-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。
Filters.N	否	Array of Filter	请求过滤参数
Limit	否	Integer	翻页单页查询限制数量[0,1000], 默认值0 示例值：10
Offset	否	Integer	翻页单页偏移量，默认值0 示例值：0
QueryType	否	String	查询类型示例值：config
QuerySource	否	String	调用方来源示例值：tse

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数量示例值：0
Content	Array of SREInstance	实例记录
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询引擎实例列表

用于查询引擎实例列表

输入示例

POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSREInstances
<公共请求参数>

{
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Content": [
            {
                "InstanceId": "ins-a123456",
                "Name": "instance-name",
                "Edition": "1.8.6",
                "Status": "creating",
                "SpecId": "spec-id",
                "Replica": 0,
                "Type": "nacos",
                "VpcId": "vpc-id",
                "SubnetIds": [
                    "subnet-id"
                ],
                "EnableStorage": true,
                "StorageType": "SSD",
                "StorageCapacity": 0,
                "Paymode": "POSTPAID",
                "EKSClusterID": "cluster-id",
                "CreateTime": "2021-04-08 10:00:00",
                "EnvInfos": [
                    {
                        "EnvName": "dev",
                        "VpcInfos": [
                            {
                                "VpcId": "vpc-id",
                                "SubnetId": "subnet-id",
                                "IntranetAddress": "10.0.0.1"
                            }
                        ],
                        "Status": "running",
                        "StorageCapacity": 0,
                        "AdminServiceIp": "10.0.0.1",
                        "ConfigServiceIp": "10.0.0.2",
                        "EnableConfigInternet": true,
                        "ConfigInternetServiceIp": "10.0.0.3",
                        "SpecId": "spec-id",
                        "EnvReplica": 0,
                        "RunningCount": 0,
                        "AliasEnvName": "dev-alias",
                        "EnvDesc": "env-desc",
                        "ClientBandWidth": 1,
                        "EnableConfigIntranet": true
                    }
                ],
                "EngineRegion": "ap-guangzhou",
                "EnableInternet": true,
                "VpcInfos": [
                    {
                        "VpcId": "vpc-id",
                        "SubnetId": "subnet-id",
                        "IntranetAddress": "10.0.0.1"
                    }
                ],
                "ServiceGovernanceInfos": [
                    {
                        "EngineRegion": "ap-guangzhou",
                        "BoundK8SInfos": [
                            {
                                "BoundClusterId": "cluster-id",
                                "BoundClusterType": "tke",
                                "SyncMode": "demand",
                                "BindRegion": "ap-guangzhou"
                            }
                        ],
                        "VpcInfos": [
                            {
                                "VpcId": "vpc-id",
                                "SubnetId": "subnet-id",
                                "IntranetAddress": "10.0.0.1"
                            }
                        ],
                        "PgwVpcInfos": [],
                        "LimiterVpcInfos": [],
                        "AuthOpen": true,
                        "Features": [
                            "limit"
                        ],
                        "MainPassword": "password",
                        "CLSTopics": [
                            {
                                "LogSetId": "log-id",
                                "LogSetName": "log-name",
                                "TopicId": "topic-id",
                                "TopicName": "topic-name"
                            }
                        ]
                    }
                ],
                "Tags": [
                    {
                        "Key": "tag-key",
                        "Value": "tag-value"
                    }
                ],
                "EnableConsoleInternet": true,
                "EnableConsoleIntranet": true,
                "ConfigInfoVisible": true,
                "ConsoleDefaultPwd": "password",
                "TradeType": 0,
                "AutoRenewFlag": 0,
                "CurDeadline": "2024-10-08 10:00:00",
                "IsolateTime": "2024-10-08 12:00:00",
                "RegionInfos": [
                    {
                        "EngineRegion": "ap-guangzhou",
                        "Replica": 0,
                        "SpecId": "spec-id",
                        "EnableClientInternet": true,
                        "MainRegion": true,
                        "ConsoleIntranetVpcInfos": [
                            {
                                "VpcId": "vpc-id",
                                "SubnetId": "subnet-id",
                                "IntranetAddress": "10.0.0.1"
                            }
                        ],
                        "IntranetVpcInfos": [
                            {
                                "VpcId": "vpc-id",
                                "SubnetId": "subnet-id",
                                "IntranetAddress": "10.0.0.1"
                            }
                        ]
                    }
                ],
                "EKSType": "public",
                "FeatureVersion": "STANDARD",
                "EnableClientIntranet": true,
                "StorageOption": [
                    {
                        "Name": "snap",
                        "Type": "SSD",
                        "Capacity": 50
                    }
                ]
            }
        ],
        "RequestId": "req-id"
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.GetRoleError	角色获取错误。
InternalError.HttpStatusCodeError	状态码错误。
InternalError.IOError	内部服务调用异常。
InternalError.QueryError	查询内部错误。
InternalError.TagFailure	标签操作失败。
InternalError.UnknownError	未知错误。
InvalidParameterValue.BadRequestFormat	请求格式不正确。
InvalidParameterValue.QueryError	无效请求参数，查询失败。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.CamNoAuth	cam认证失败。

查询引擎实例列表

本页目录：