获取Cmem实例列表

最近更新时间：2024-03-12 01:39:51

我的收藏

本页目录：

1. 接口描述

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

获取Cmem实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstances。
Version	是	String	公共参数，本接口取值：2019-03-18。
Region	是	String	公共参数，详见产品支持的地域列表。
OrderBy	否	String	枚举范围： AddTimeStamp, InstanceName, ProjectId 示例值：AddTimeStamp
SearchKeys.N	否	Array of String	查找的关键字示例值：["\u5b57\u7b26\u4e32\u578b"]
UniqSubnetIds.N	否	Array of String	子网ID列表示例值：["xx"]
Vips.N	否	Array of String	VIP列表示例值：["xx"]
OrderType	否	Integer	0倒序，1正序，默认倒序示例值：0
InstanceNames.N	否	Array of String	实例名称列表示例值：["\u5b57\u7b26\u4e32\u578b"]
UniqVpcIds.N	否	Array of String	VPC ID列表示例值：["xx"]
ProjectIds.N	否	Array of Integer	项目ID列表示例值：[0]
Offset	否	Integer	偏移量，取Limit整数倍示例值：1
Limit	否	Integer	实例列表的大小，参数默认值100 示例值：1
InstanceIds.N	否	Array of String	实例ID列表示例值：["\u6709\u7b26\u53f7\u6574\u578b"]

3. 输出参数

参数名称	类型	描述
InstanceList	Array of InstanceListInfo	实例详细信息列表
TotalNum	Integer	实例数量示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

请求示例

输入示例

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

{
    "Limit": 2,
    "Offset": 0,
    "OrderBy": "createtime "
}

输出示例

{
    "Response": {
        "InstanceList": [
            {
                "AddTimeStamp": "2023-03-06 20:18:26",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900082,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-ei31rc25",
                "InstanceId": "cmem-ei31rc25",
                "InstanceName": "cmem-ei31rc25",
                "IsolateTimeStamp": "2023-03-06 20:18:26",
                "ModTimeStamp": "2023-03-13 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 1,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "10.66.46.111",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-06 20:18:32",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900083,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-juos84wf",
                "InstanceId": "cmem-juos84wf",
                "InstanceName": "cmem-juos84wf",
                "IsolateTimeStamp": "2023-03-06 20:18:32",
                "ModTimeStamp": "2023-03-13 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 1,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "10.66.46.112",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-06 20:19:06",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900085,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-XXXXXXXX",
                "InstanceId": "cmem-XXXXXXXX",
                "InstanceName": "cmem-XXXXXXXX",
                "IsolateTimeStamp": "2023-03-06 20:19:06",
                "ModTimeStamp": "2023-03-13 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 1,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "10.66.46.113",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-06 20:19:15",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900086,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-XXXXXXXX",
                "InstanceId": "cmem-XXXXXXXX",
                "InstanceName": "cmem-XXXXXXXX",
                "IsolateTimeStamp": "2023-03-06 20:19:15",
                "ModTimeStamp": "2023-03-13 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 1,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "10.66.46.114",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-06 20:23:24",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900088,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-XXXXXXXX",
                "InstanceId": "cmem-XXXXXXXX",
                "InstanceName": "cmem-XXXXXXXX",
                "IsolateTimeStamp": "2023-03-06 20:23:24",
                "ModTimeStamp": "2023-03-13 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 0,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "10.66.46.116",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-06 20:24:38",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900089,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-XXXXXXXX",
                "InstanceId": "cmem-XXXXXXXX",
                "InstanceName": "cmem-XXXXXXXX",
                "IsolateTimeStamp": "2023-03-06 20:24:38",
                "ModTimeStamp": "2023-03-20 11:15:00",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 0,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            },
            {
                "AddTimeStamp": "2023-03-20 11:30:34",
                "AppId": 251223625,
                "AutoRenewFlag": 0,
                "CmemId": 999900091,
                "DeadlineTimeStamp": "0001-01-01 08:05:43",
                "Expire": 0,
                "InstanceDesc": "cmem-XXXXXXXX",
                "InstanceId": "cmem-XXXXXXXX",
                "InstanceName": "cmem-XXXXXXXX",
                "IsolateTimeStamp": "2023-03-20 11:30:34",
                "ModTimeStamp": "2023-03-20 11:30:34",
                "PayMode": 0,
                "ProjectId": 0,
                "RegionId": 1,
                "SetId": 999901,
                "Status": 0,
                "SubnetId": 0,
                "Tags": [],
                "UniqSubnetId": "",
                "UniqVpcId": "",
                "Vip": "",
                "VpcId": 0,
                "Vport": 9101,
                "ZoneId": 100007
            }
        ],
        "RequestId": "57bc4b72-18d6-4047-abba-3f5c71f2XXXXX",
        "TotalNum": 7
    }
}

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.DbOperationFailed	数据库操作异常
FailedOperation.SystemError	系统内部错误
InternalError.InternalError	内部错误
InvalidParameter.InvalidParameter	业务参数错误
MissingParameter.EmptyParam	参数为空
ResourceNotFound.AccountDoesNotExists	未提供有效的账号
ResourceNotFound.InstanceNotExists	请求的实例不存在
UnauthorizedOperation.NoCAMAuthed	Cam鉴权失败