查询指定地域的实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alikafka:ListInstance | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 实例的地域ID。 | cn-hangzhou |
| OrderId | string | 否 | 订单ID。您可以在阿里云用户中心的订单管理中获取。 | 6072673**** |
| InstanceId | array | 否 | 实例ID列表。 | |
| string | 否 | 实例ID。 | alikafka_post-cn-mp91gnw0**** | |
| Tag | object [] | 否 | 标签列表。 | |
| Key | string | 否 | 资源的标签键。
| test |
| Value | string | 否 | 资源的标签值。
| test |
| ResourceGroupId | string | 否 | 资源组ID，可通过资源组控制台查询。 | rg-ac***********7q |
返回参数
AllConfig参数说明
| 名称 | 类型 | 取值范围 | 示例值 | 描述 |
|---|---|---|---|---|
| enable.vpc_sasl_ssl | Boolean | - true - false | false | 是否开启VPC传输加密，如果要开启，必须同时开启ACL。 |
| kafka.log.retention.hours | Integer | 24～480 | 66 | 消息保留时长（小时）。 |
| enable.acl | Boolean | - true - false | false | 是否开启ACL。 |
| kafka.message.max.bytes | Integer | 1048576～10485760 | 6291456 | 最大消息大小（字节）。 |
示例
正常返回示例
JSON格式
{
"Code": 200,
"Message": "operation success.",
"RequestId": "4B6D821D-7F67-4CAA-9E13-A5A997C3****",
"Success": true,
"InstanceList": {
"InstanceVO": [
{
"VpcId": "vpc-bp1ojac7bv448nifj****",
"SpecType": "professional",
"DeployType": 5,
"CreateTime": 1577961819000,
"DiskSize": 3600,
"DiskType": 1,
"SecurityGroup": "sg-bp13wfx7kz9pkow****",
"SslEndPoint": "192.0.XX.XX:9093,198.51.XX.XX:9093,203.0.XX.XX:9093",
"InstanceId": "alikafka_pre-cn-mp919o4v****",
"AllConfig": "{\\\"enable.vpc_sasl_ssl\\\":\\\"false\\\",\\\"kafka.log.retention.hours\\\":\\\"66\\\",\\\"enable.acl\\\":\\\"false\\\",\\\"kafka.message.max.bytes\\\":\\\"6291456\\\"}",
"ServiceStatus": 5,
"EipMax": 20,
"RegionId": "cn-hangzhou",
"MsgRetain": 72,
"VSwitchId": "vsw-bp1fvuw0ljd7vzmo3****",
"ExpiredTime": 1893581018000,
"TopicNumLimit": 180,
"ZoneId": "zonei",
"IoMax": 20,
"PaidType": 1,
"Name": "alikafka_post-cn-mp91gnw0****",
"EndPoint": "192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092",
"Tags": {
"TagVO": [
{
"Key": "test",
"Value": "test"
}
]
},
"UpgradeServiceDetailInfo": {
"Current2OpenSourceVersion": "2.2.0"
},
"DomainEndpoint": "alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9092,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9092",
"SslDomainEndpoint": "alikafka-pre-cn-zv**********-1.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-2.alikafka.aliyuncs.com:9093,alikafka-pre-cn-zv**********-3.alikafka.aliyuncs.com:9093",
"SaslDomainEndpoint": "alikafka-pre-cn-zv**********-1-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-2-vpc.alikafka.aliyuncs.com:9094,alikafka-pre-cn-zv**********-3-vpc.alikafka.aliyuncs.com:9094",
"ResourceGroupId": "rg-ac***********7q\n",
"UsedTopicCount": 3,
"UsedGroupCount": 10,
"UsedPartitionCount": 25,
"KmsKeyId": "0d24xxxx-da7b-4786-b981-9a164dxxxxxx",
"StandardZoneId": "cn-hangzhou-k",
"IoMaxSpec": ""
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2022-08-03 | OpenAPI 返回结构发生变更 | |||
| ||||
| 2022-08-02 | OpenAPI 返回结构发生变更 | |||
| ||||
| 2021-12-20 | OpenAPI 返回结构发生变更 | |||
|