diff options
Diffstat (limited to 'data/zh_cn/alikafka/2018-10-15/api-docs.php')
| -rw-r--r-- | data/zh_cn/alikafka/2018-10-15/api-docs.php | 1466 |
1 files changed, 1466 insertions, 0 deletions
diff --git a/data/zh_cn/alikafka/2018-10-15/api-docs.php b/data/zh_cn/alikafka/2018-10-15/api-docs.php new file mode 100644 index 0000000..242fd16 --- /dev/null +++ b/data/zh_cn/alikafka/2018-10-15/api-docs.php @@ -0,0 +1,1466 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'alikafka', + 'version' => '2018-10-15', + ], + 'directories' => [ + [ + 'id' => 57971, + 'title' => '实例', + 'type' => 'directory', + 'children' => [ + 'GetInstanceList', + ], + ], + [ + 'id' => 57973, + 'title' => 'Topic', + 'type' => 'directory', + 'children' => [ + 'CreateTopic', + 'DeleteTopic', + 'GetTopicList', + 'GetTopicStatus', + ], + ], + [ + 'id' => 57978, + 'title' => '消费组', + 'type' => 'directory', + 'children' => [ + 'CreateConsumerGroup', + 'DeleteConsumerGroup', + 'GetConsumerList', + 'GetConsumerProgress', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetInstanceList' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '58598', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码，返回 “200” 代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success.', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'ABA4A7FD-E10F-45C7-9774-A5236015****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceVO' => [ + 'description' => '实例列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-bp1l6hrlykj3405r7****', + ], + 'VSwitchId' => [ + 'description' => 'VSwitch ID。', + 'type' => 'string', + 'example' => 'vsw-bp13rg6bcpkxofr78****', + ], + 'ExpiredTime' => [ + 'description' => '过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568908800000', + ], + 'DeployType' => [ + 'description' => '部署类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566215995000', + ], + 'SslEndPoint' => [ + 'description' => 'SSL 接入点。', + 'type' => 'string', + 'example' => '47.111.110.11:9093,121.40.96.141:9093,47.111.118.133:****', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => 'alikafka_pre-cn-mp919o4v****', + ], + 'Name' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'alikafka_pre-cn-mp919o4v****', + ], + 'ServiceStatus' => [ + 'description' => '服务状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'EndPoint' => [ + 'description' => '默认接入点。', + 'type' => 'string', + 'example' => '192.168.0.212:9092,192.168.0.210:9092,192.168.0.211:****', + ], + 'RegionId' => [ + 'description' => '实例所属的地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'UpgradeServiceDetailInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UpgradeServiceDetailInfoVO' => [ + 'description' => '升级服务详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Current2OpenSourceVersion' => [ + 'description' => '开源版本。', + 'type' => 'string', + 'example' => '0.10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success.\\",\\n \\"RequestId\\": \\"ABA4A7FD-E10F-45C7-9774-A5236015****\\",\\n \\"Success\\": true,\\n \\"InstanceList\\": {\\n \\"InstanceVO\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1l6hrlykj3405r7****\\",\\n \\"VSwitchId\\": \\"vsw-bp13rg6bcpkxofr78****\\",\\n \\"ExpiredTime\\": 1568908800000,\\n \\"DeployType\\": 4,\\n \\"CreateTime\\": 1566215995000,\\n \\"SslEndPoint\\": \\"47.111.110.11:9093,121.40.96.141:9093,47.111.118.133:****\\",\\n \\"InstanceId\\": \\"alikafka_pre-cn-mp919o4v****\\",\\n \\"Name\\": \\"alikafka_pre-cn-mp919o4v****\\",\\n \\"ServiceStatus\\": 5,\\n \\"EndPoint\\": \\"192.168.0.212:9092,192.168.0.210:9092,192.168.0.211:****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UpgradeServiceDetailInfo\\": {\\n \\"UpgradeServiceDetailInfoVO\\": [\\n {\\n \\"Current2OpenSourceVersion\\": \\"0.10\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceListResponse>\\r\\n <Message>operation success.</Message>\\r\\n <RequestId>0220FACD-4D57-4F46-BA77-AD333498****</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n <InstanceList>\\r\\n <InstanceVO>\\r\\n <Name>alikafka_pre-cn-mp919o4v****</Name>\\r\\n <DeployType>4</DeployType>\\r\\n <CreateTime>1566215995000</CreateTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <InstanceId>alikafka_pre-cn-mp919o4v****</InstanceId>\\r\\n <SslEndPoint>47.111.110.11:9093,121.40.96.141:9093,47.111.118.133:****</SslEndPoint>\\r\\n <EndPoint>192.168.0.212:9092,192.168.0.210:9092,192.168.0.211:****</EndPoint>\\r\\n <ExpiredTime>1568908800000</ExpiredTime>\\r\\n <VSwitchId>vsw-bp13rg6bcpkxofr78****</VSwitchId>\\r\\n <VpcId>vpc-bp1l6hrlykj3405r7****</VpcId>\\r\\n <UpgradeServiceDetailInfo>\\r\\n <Current2OpenSourceVersion>0.10</Current2OpenSourceVersion>\\r\\n </UpgradeServiceDetailInfo>\\r\\n <ServiceStatus>5</ServiceStatus>\\r\\n </InstanceVO>\\r\\n </InstanceList>\\r\\n</GetInstanceListResponse>","errorExample":""}]', + 'title' => '获取某地域下所购买的实例的信息', + 'summary' => '调用 GetInstanceList 获取您在某地域下所购买的实例的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTopic' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '58592', + 'abilityTreeNodes' => [ + 'FEATUREalikafka855U02', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。'."\n" + ."\n" + .'可调用 [GetInstanceList](https://help.aliyun.com/document_detail/94533.html?spm=a2c4g.11186623.2.12.774c7dc8F5cWRE#concept-94533-zh) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_pre-cn-mp919o4v****', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Topic 的名称。'."\n" + ."\n" + .'- 只能包含字母、数字、下划线（_）和短横线（-）。'."\n" + .'- 长度为 3-64 个字符，多于 64 个字符将被自动截取。'."\n" + .'- 一旦创建后不能再修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_topic_test', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Topic 的备注。'."\n" + ."\n" + .'限制 64 个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_topic_test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。'."\n" + ."\n" + .'返回 **200** 为成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => '请求的唯一标识 ID。', + 'type' => 'string', + 'example' => '9C0F207C-77A6-43E5-991C-9D98510A****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"9C0F207C-77A6-43E5-991C-9D98510A****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateTopicResponse>\\r\\n\\t<Message>operation success</Message>\\r\\n\\t<RequestId>9C0F207C-77A6-43E5-991C-9D98510A****</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</CreateTopicResponse>","errorExample":""}]', + 'title' => '创建 Topic', + 'summary' => '调用 CreateTopic 创建 Topic。', + 'description' => '调用该接口创建 Topic 时，请注意：'."\n" + ."\n" + .'- 单用户请求频率限制为 1 QPS。'."\n" + ."\n" + .'- 每个实例下最多可创建的 Topic 数量与您所购买的实例版本相关，详情请参见[计费说明](https://help.aliyun.com/document_detail/84737.html)。'."\n" + ."\n\n" + ."\n\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTopic' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '58594', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。'."\n" + ."\n" + .'可调用 [GetInstanceList](https://help.aliyun.com/document_detail/94533.html?spm=a2c4g.11186623.2.14.539f69b1wPqd3v#concept-94533-zh) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_post-cn-mp91a44k****', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Topic 的名称。'."\n" + ."\n" + .'- 只能包含字母、数字、下划线（_）和短横线（-）。'."\n" + .'- 长度为 3-64 个字符，多于 64 个字符将被自动截取。'."\n" + .'- 一旦创建后不能再修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Kafkatest', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9B618B3F-9506-4661-A211-D00C4556****', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"9B618B3F-9506-4661-A211-D00C4556****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTopicResponse>\\r\\n\\t<Message>operation success</Message>\\r\\n\\t<RequestId>9B618B3F-9506-4661-A211-D00C4556****</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</DeleteTopicResponse>","errorExample":""}]', + 'title' => '删除 Topic', + 'summary' => '调用 DeleteTopic 删除 Topic。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetTopicList' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '58599', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_pre-cn-0pp1954n2003 ', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '当前页面。', + 'default' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '页面大小。', + 'default' => '10000', + 'enum' => [ + '10000', + ], + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页面。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '82BD585C-17A1-486E-B3E8-AABCE8EE****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。返回 **200** 为成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success.', + ], + 'PageSize' => [ + 'description' => '页面大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Total' => [ + 'description' => 'Topic 总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TopicList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopicVO' => [ + 'description' => 'Topic 列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态码。'."\n" + ."\n" + .'- **0**：服务中。'."\n" + .'- **1**：冻结。'."\n" + .'- **2**：暂停。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Remark' => [ + 'description' => 'Topic 备注。', + 'type' => 'string', + 'example' => 'kafka_test_topic', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566804394000', + ], + 'Topic' => [ + 'description' => 'Topic 名称。', + 'type' => 'string', + 'example' => 'poptest', + ], + 'StatusName' => [ + 'description' => '状态描述。', + 'type' => 'string', + 'example' => '服务中', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => 'alikafka_pre-cn-0pp1954n****', + ], + 'RegionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"82BD585C-17A1-486E-B3E8-AABCE8EE****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success.\\",\\n \\"PageSize\\": 10000,\\n \\"Total\\": 12,\\n \\"TopicList\\": {\\n \\"TopicVO\\": [\\n {\\n \\"Status\\": 0,\\n \\"PartitionNum\\": 12,\\n \\"Remark\\": \\"kafka_test_topic\\",\\n \\"CreateTime\\": 1566804394000,\\n \\"Topic\\": \\"poptest\\",\\n \\"StatusName\\": \\"服务中\\",\\n \\"CompactTopic\\": false,\\n \\"InstanceId\\": \\"alikafka_pre-cn-0pp1954n****\\",\\n \\"LocalTopic\\": false,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TopicListResponse>\\r\\n\\t<TopicList>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>12</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1567146954000</CreateTime>\\r\\n\\t\\t\\t<Topic>poptest</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>test</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>12</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1566804394000</CreateTime>\\r\\n\\t\\t\\t<Topic>kafka_test_topic</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>kafka_test_topic11111111111111111111122222222222222</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>12</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1566804290000</CreateTime>\\r\\n\\t\\t\\t<Topic>topic_test</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>topic_test</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>6</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1565589319000</CreateTime>\\r\\n\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>test-data-migration</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>45</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1565331243000</CreateTime>\\r\\n\\t\\t\\t<Topic>normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_6</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>topic1</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t\\t<TopicVO>\\r\\n\\t\\t\\t<PartitionNum>24</PartitionNum>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<CompactTopic>false</CompactTopic>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t<InstanceId>alikafka_pre-cn-0pp1954n****</InstanceId>\\r\\n\\t\\t\\t<CreateTime>1565331241000</CreateTime>\\r\\n\\t\\t\\t<Topic>normal_topic_4fec2e97daa6f089f1a48b36b6bea34e_5</Topic>\\r\\n\\t\\t\\t<StatusName>服务中</StatusName>\\r\\n\\t\\t\\t<LocalTopic>false</LocalTopic>\\r\\n\\t\\t\\t<Remark>topic1</Remark>\\r\\n\\t\\t</TopicVO>\\r\\n\\t</TopicList>\\r\\n\\t<Message>operation success.</Message>\\r\\n\\t<PageSize>10000</PageSize>\\r\\n\\t<RequestId>BF67619B-17C5-4FE6-BFB4-83B8C9F7****</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<CurrentPage>1</CurrentPage>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Total>6</Total>\\r\\n</TopicListResponse>","errorExample":""}]', + 'title' => '获取 Topic 的列表', + 'summary' => '调用 GetTopicList 获取 Topic 的列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetTopicStatus' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '58600', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。'."\n" + ."\n" + .'可调用 [GetInstanceList](https://help.aliyun.com/document_detail/94533.html)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_pre-cn-v0h15tjmo003 ', + ], + ], + [ + 'name' => 'Topic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Topic 名称。'."\n" + ."\n" + .'可调用 [GetTopicList](https://help.aliyun.com/document_detail/94533.html?spm=a2c4g.11186623.2.11.5e374db4Cw7zT7#concept-94533-zh) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'normal_topic_9d034262835916103455551be06cc2dc_6', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态吗。返回 **200** 代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success.', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E475C7E2-8C35-46EF-BE7D-5D2A9F5D****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TopicStatus' => [ + 'description' => 'Topic 状态。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '消息总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '423', + ], + 'LastTimeStamp' => [ + 'description' => '最后一条被消费的消息的产生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566470063575', + ], + 'OffsetTable' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OffsetTable' => [ + 'description' => '偏移列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Partition' => [ + 'description' => '分区 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MinOffset' => [ + 'description' => '消息最小位点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LastUpdateTimestamp' => [ + 'description' => '最后被消费的消息的产生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566470063547', + ], + 'MaxOffset' => [ + 'description' => '消息最大位点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '76', + ], + 'Topic' => [ + 'description' => 'Topic 名称。', + 'type' => 'string', + 'example' => 'testkafka', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success.\\",\\n \\"RequestId\\": \\"E475C7E2-8C35-46EF-BE7D-5D2A9F5D****\\",\\n \\"Success\\": true,\\n \\"TopicStatus\\": {\\n \\"TotalCount\\": 423,\\n \\"LastTimeStamp\\": 1566470063575,\\n \\"OffsetTable\\": {\\n \\"OffsetTable\\": [\\n {\\n \\"Partition\\": 0,\\n \\"MinOffset\\": 0,\\n \\"LastUpdateTimestamp\\": 1566470063547,\\n \\"MaxOffset\\": 76,\\n \\"Topic\\": \\"testkafka\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTopicStatusResponse>\\r\\n\\t<Message>operation success.</Message>\\r\\n\\t<RequestId>E475C7E2-8C35-46EF-BE7D-5D2A9F5D****</RequestId>\\r\\n\\t<TopicStatus>\\r\\n\\t\\t<TotalCount>423</TotalCount>\\r\\n\\t\\t<LastTimeStamp>1566470063575</LastTimeStamp>\\r\\n\\t\\t<OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>0</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063547</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>76</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>1</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063575</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>69</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>2</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063554</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>70</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>3</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063538</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>67</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>4</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063568</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>67</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t\\t<OffsetTable>\\r\\n\\t\\t\\t\\t<Partition>5</Partition>\\r\\n\\t\\t\\t\\t<LastUpdateTimestamp>1566470063561</LastUpdateTimestamp>\\r\\n\\t\\t\\t\\t<Topic>testkafka</Topic>\\r\\n\\t\\t\\t\\t<MaxOffset>74</MaxOffset>\\r\\n\\t\\t\\t\\t<MinOffset>0</MinOffset>\\r\\n\\t\\t\\t</OffsetTable>\\r\\n\\t\\t</OffsetTable>\\r\\n\\t</TopicStatus>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</GetTopicStatusResponse>","errorExample":""}]', + 'title' => '获取 Topic 的消息收发数据', + 'summary' => '调用 GetTopicStatus 获取 Topic 的消息收发数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateConsumerGroup' => [ + 'summary' => '调用 CreateConsumerGroup 创建 Consumer Group。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '58591', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。可调用 [GetInstanceList](https://help.aliyun.com/document_detail/94533.html?spm=a2c4g.11186623.2.11.6efb754byCLl4z#concept-94533-zh) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_pre-cn-0pp1954n****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Consumer Group 名称。'."\n" + ."\n" + .'- 只能包含字母、数字、短横线（-）、下划线（_）。'."\n" + .'- 长度限制在 **3-64** 个字符，多于 **64** 个字符将被自动截取。'."\n" + .'- 一旦创建后不能再修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'consumer_group_test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。返回 **200** 为成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'B191CC4D-B067-4508-987A-ACDA8D89****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"B191CC4D-B067-4508-987A-ACDA8D89****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateConsumerGroupResponse>\\r\\n <Message>operation success</Message>\\r\\n <RequestId>B191CC4D-B067-4508-987A-ACDA8D89****</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</CreateConsumerGroupResponse>","errorExample":""}]', + 'title' => '创建消费组', + 'description' => '您在调用 CreateConsumerGroup 创建 Consumer Group 时，请注意：单用户请求频率限制为 1 QPS。'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteConsumerGroup' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '58593', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。'."\n" + ."\n" + .'可调用 [GetInstanceList](https://help.aliyun.com/document_detail/94533.html?spm=a2c4g.11186623.2.13.50a75a5f5ediNK#concept-94533-zh) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_post-cn-mp91a44k****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Consumer Group 名称。'."\n" + ."\n" + .'- 只能包含字母、数字、短横线（-）、下划线（_）。'."\n" + .'- 长度限制在 3-64 个字符，多于 64 个字符将被自动截取。'."\n" + .'- 一旦创建后不能再修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testconsumer', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。返回 **200** 代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '1AA2A2AD-2727-4573-B1C7-A0388BCD****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success\\",\\n \\"RequestId\\": \\"1AA2A2AD-2727-4573-B1C7-A0388BCD****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteConsumerGroupResponse>\\r\\n\\t<Message>operation success</Message>\\r\\n\\t<RequestId>1AA2A2AD-2727-4573-B1C7-A0388BCD61CC</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</DeleteConsumerGroupResponse>","errorExample":""}]', + 'title' => '删除消费组', + 'summary' => '调用 DeleteConsumerGroup 删除 ConsumerGroup。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetConsumerList' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '58596', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_post-cn-v0h18sav****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。返回 **200** 代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success.', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '808F042B-CB9A-4FBC-9009-00E7DDB6****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConsumerList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConsumerVO' => [ + 'description' => 'Consumer Group 列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConsumerId' => [ + 'description' => 'Consumer Group 名称。', + 'type' => 'string', + 'example' => 'CID_c34a6f44915f80d70cb42c4b14ee40c3_4', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => 'alikafka_post-cn-v0h18sav0001', + ], + 'RegionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success.\\",\\n \\"RequestId\\": \\"808F042B-CB9A-4FBC-9009-00E7DDB6****\\",\\n \\"Success\\": true,\\n \\"ConsumerList\\": {\\n \\"ConsumerVO\\": [\\n {\\n \\"ConsumerId\\": \\"CID_c34a6f44915f80d70cb42c4b14ee40c3_4\\",\\n \\"InstanceId\\": \\"alikafka_post-cn-v0h18sav0001\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetConsumerListResponse>\\r\\n <ConsumerList>\\r\\n <ConsumerVO>\\r\\n <ConsumerId>CID_c34a6f44915f80d70cb42c4b14ee40c3_4</ConsumerId>\\r\\n <InstanceId>alikafka_post-cn-v0h18sav****</InstanceId>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n </ConsumerVO>\\r\\n <ConsumerVO>\\r\\n <ConsumerId>CID_c34a6f44915f80d70cb42c4b14ee40c3_3</ConsumerId>\\r\\n <InstanceId>alikafka_post-cn-v0h18sav****</InstanceId>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n </ConsumerVO>\\r\\n </ConsumerList>\\r\\n <Message>operation success.</Message>\\r\\n <RequestId>808F042B-CB9A-4FBC-9009-00E7DDB6****</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</GetConsumerListResponse>","errorExample":""}]', + 'title' => '获取消费组列表', + 'summary' => '调用 GetConsumerList 获取 Consumer Group 列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetConsumerProgress' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '58597', + 'abilityTreeNodes' => [ + 'FEATUREalikafkaVSFQUO', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alikafka_pre-cn-mp919o4v****', + ], + ], + [ + 'name' => 'ConsumerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Consumer Group ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'kafka-test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '返回码。返回 **200** 代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'operation success.', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '252820E1-A2E6-45F2-B4C9-1056B8CE****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ConsumerProgress' => [ + 'description' => '消费状态。', + 'type' => 'object', + 'properties' => [ + 'LastTimestamp' => [ + 'description' => '此 Consumer Group 最后被消费的消息的产生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566874931671', + ], + 'TotalDiff' => [ + 'description' => '此 Consumer Group 未消费的消息总量，即堆积量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'state' => [ + 'type' => 'string', + ], + 'TopicList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopicList' => [ + 'description' => '此 Consumer Group 对应的每个 Topic 的消费进度列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalDiff' => [ + 'description' => '该 Topic 的未消费消息总量，即堆积量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LastTimestamp' => [ + 'description' => '该分区最后被消费的消息的产生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566874931649', + ], + 'Topic' => [ + 'description' => 'Topic 名称。', + 'type' => 'string', + 'example' => 'kafka-test', + ], + 'OffsetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OffsetList' => [ + 'description' => '偏移列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Partition' => [ + 'description' => '分区 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BrokerOffset' => [ + 'description' => '最大位点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'ConsumerOffset' => [ + 'description' => '消费位点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'LastTimestamp' => [ + 'description' => '该分区最后被消费的消息的产生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1566874931649', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'AUTH_RESOURCE_OWNER_ERROR', + 'errorMessage' => '%s. Please check and try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"operation success.\\",\\n \\"RequestId\\": \\"252820E1-A2E6-45F2-B4C9-1056B8CE****\\",\\n \\"Success\\": true,\\n \\"ConsumerProgress\\": {\\n \\"LastTimestamp\\": 1566874931671,\\n \\"TotalDiff\\": 0,\\n \\"TopicList\\": {\\n \\"TopicList\\": [\\n {\\n \\"TotalDiff\\": 0,\\n \\"LastTimestamp\\": 1566874931649,\\n \\"Topic\\": \\"kafka-test\\",\\n \\"OffsetList\\": {\\n \\"OffsetList\\": [\\n {\\n \\"Partition\\": 0,\\n \\"BrokerOffset\\": 9,\\n \\"ConsumerOffset\\": 9,\\n \\"LastTimestamp\\": 1566874931649\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetConsumerProgressResponse>\\r\\n <Message>operation success.</Message>\\r\\n <RequestId>252820E1-A2E6-45F2-B4C9-1056B8CE****</RequestId>\\r\\n <ConsumerProgress>\\r\\n <TotalDiff>0</TotalDiff>\\r\\n <LastTimestamp>1566874931671</LastTimestamp>\\r\\n <TopicList>\\r\\n <TopicList>\\r\\n <TotalDiff>0</TotalDiff>\\r\\n <OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>0</Partition>\\r\\n <LastTimestamp>1566874931649</LastTimestamp>\\r\\n <BrokerOffset>9</BrokerOffset>\\r\\n <ConsumerOffset>9</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>1</Partition>\\r\\n <LastTimestamp>1566874931605</LastTimestamp>\\r\\n <BrokerOffset>9</BrokerOffset>\\r\\n <ConsumerOffset>9</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>2</Partition>\\r\\n <LastTimestamp>1566874931561</LastTimestamp>\\r\\n <BrokerOffset>10</BrokerOffset>\\r\\n <ConsumerOffset>10</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>3</Partition>\\r\\n <LastTimestamp>1566874931628</LastTimestamp>\\r\\n <BrokerOffset>8</BrokerOffset>\\r\\n <ConsumerOffset>8</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>4</Partition>\\r\\n <LastTimestamp>1566874931579</LastTimestamp>\\r\\n <BrokerOffset>8</BrokerOffset>\\r\\n <ConsumerOffset>8</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>5</Partition>\\r\\n <LastTimestamp>1566874931570</LastTimestamp>\\r\\n <BrokerOffset>10</BrokerOffset>\\r\\n <ConsumerOffset>10</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>6</Partition>\\r\\n <LastTimestamp>1566874931639</LastTimestamp>\\r\\n <BrokerOffset>9</BrokerOffset>\\r\\n <ConsumerOffset>9</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>7</Partition>\\r\\n <LastTimestamp>1566874931586</LastTimestamp>\\r\\n <BrokerOffset>8</BrokerOffset>\\r\\n <ConsumerOffset>8</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>8</Partition>\\r\\n <LastTimestamp>1566874931661</LastTimestamp>\\r\\n <BrokerOffset>9</BrokerOffset>\\r\\n <ConsumerOffset>9</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>9</Partition>\\r\\n <LastTimestamp>1566874931616</LastTimestamp>\\r\\n <BrokerOffset>8</BrokerOffset>\\r\\n <ConsumerOffset>8</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>10</Partition>\\r\\n <LastTimestamp>1566874931596</LastTimestamp>\\r\\n <BrokerOffset>8</BrokerOffset>\\r\\n <ConsumerOffset>8</ConsumerOffset>\\r\\n </OffsetList>\\r\\n <OffsetList>\\r\\n <Partition>11</Partition>\\r\\n <LastTimestamp>1566874931671</LastTimestamp>\\r\\n <BrokerOffset>9</BrokerOffset>\\r\\n <ConsumerOffset>9</ConsumerOffset>\\r\\n </OffsetList>\\r\\n </OffsetList>\\r\\n <LastTimestamp>1566874931671</LastTimestamp>\\r\\n <Topic>kafka-test</Topic>\\r\\n </TopicList>\\r\\n </TopicList>\\r\\n </ConsumerProgress>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</GetConsumerProgressResponse>","errorExample":""}]', + 'title' => '查询消费组的消费状态', + 'summary' => '调用 GetConsumerProgress 查询 Consumer Group 的消费状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'alikafka.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'alikafka.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'alikafka.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'alikafka.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'alikafka.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'alikafka.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'alikafka.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'alikafka.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'alikafka.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'alikafka.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'alikafka.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'alikafka.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'alikafka.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'alikafka.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'alikafka.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'alikafka.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'alikafka.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'alikafka.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'alikafka.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'alikafka.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'alikafka.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'alikafka.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'alikafka.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'alikafka.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'alikafka.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'alikafka.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'alikafka.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'alikafka.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'alikafka.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'alikafka.na-south-1.aliyuncs.com', + ], + ], +]; |