summaryrefslogtreecommitdiff
path: root/data/en_us/elasticsearch/2019-04-22/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/elasticsearch/2019-04-22/api-docs.php')
-rw-r--r--data/en_us/elasticsearch/2019-04-22/api-docs.php468
1 files changed, 468 insertions, 0 deletions
diff --git a/data/en_us/elasticsearch/2019-04-22/api-docs.php b/data/en_us/elasticsearch/2019-04-22/api-docs.php
new file mode 100644
index 0000000..48ce59c
--- /dev/null
+++ b/data/en_us/elasticsearch/2019-04-22/api-docs.php
@@ -0,0 +1,468 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'elasticsearch',
+ 'version' => '2019-04-22',
+ ],
+ 'directories' => [
+ [
+ 'id' => 62994,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeVSwitches',
+ ],
+ ],
+ [
+ 'id' => 62996,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeVpcs',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'DescribeVSwitches' => [
+ 'summary' => '获取用户交换机列表',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64424',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ 'required' => false,
+ 'title' => '交换机所属区域id',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'vpc-25cdvfeq58pl****',
+ 'required' => false,
+ 'title' => '要查询的交换机所属VPC的ID。',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '1',
+ 'format' => 'int32',
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'required' => false,
+ 'title' => '列表的页码',
+ 'type' => 'integer',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '10',
+ 'format' => 'int32',
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'required' => false,
+ 'title' => '分页查询时每页的行数',
+ 'type' => 'integer',
+ 'default' => '50',
+ ],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'cn-hangzhou-d',
+ 'required' => false,
+ 'title' => '要查询的交换机的ID。',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B',
+ 'type' => 'string',
+ ],
+ 'VSwitches' => [
+ 'description' => '',
+ 'properties' => [
+ 'VSwitch' => [
+ 'description' => '',
+ 'items' => [
+ 'properties' => [
+ 'Status' => [
+ 'description' => '',
+ 'example' => 'Available',
+ 'title' => '交换机的状态，取值：'."\n"
+ .'Pending：配置中。'."\n"
+ .'Available：可用。',
+ 'type' => 'string',
+ 'enum' => [],
+ ],
+ 'VSwitchId' => [
+ 'description' => '',
+ 'example' => 'vsw-25bcdxs7pv1****',
+ 'title' => '交换机的ID。',
+ 'type' => 'string',
+ ],
+ 'IsDefault' => [
+ 'description' => '',
+ 'example' => 'true',
+ 'title' => '是否是默认交换机。取值：'."\n"
+ .'true：是默认交换机。'."\n"
+ .'false：非默认交换机。',
+ 'type' => 'boolean',
+ ],
+ 'CidrBlock' => [
+ 'description' => '',
+ 'example' => '172.16.0.0/24',
+ 'title' => '交换机的IPv4网段。',
+ 'type' => 'string',
+ ],
+ 'GmtCreate' => [
+ 'description' => '',
+ 'example' => '2022-01-18T12:43:57Z',
+ 'title' => '交换机的创建时间。',
+ 'type' => 'string',
+ ],
+ 'VSwitchName' => [
+ 'description' => '',
+ 'example' => 'vswitch',
+ 'title' => '交换机的名称。',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ 'title' => '交换机数据结构体。',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '交换机数组结果',
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"VSwitchName\\": \\"vswitch\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVSwitchesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B</RequestId>\\n <VSwitches>\\n <VSwitch>\\n <Status>Available</Status>\\n <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>\\n <IsDefault>true</IsDefault>\\n <CidrBlock>172.16.0.0/24</CidrBlock>\\n <GmtCreate>2022-01-18T12:43:57Z</GmtCreate>\\n <VSwitchName>vswitch</VSwitchName>\\n </VSwitch>\\n </VSwitches>\\n</DescribeVSwitchesResponse>","errorExample":""}]',
+ 'title' => 'DescribeVSwitches',
+ ],
+ 'DescribeVpcs' => [
+ 'summary' => 'VPC列表',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64423',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchGHNE3U',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ 'required' => false,
+ 'title' => '区域ID',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => 'cn-hangzhou-d',
+ 'required' => false,
+ 'title' => '可用区Id',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '1',
+ 'format' => 'int32',
+ 'minimum' => '1',
+ 'required' => false,
+ 'title' => '分页查询页码',
+ 'type' => 'integer',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'example' => '50',
+ 'format' => 'int32',
+ 'required' => false,
+ 'title' => '分页查询每页大小',
+ 'type' => 'integer',
+ 'default' => '50',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B',
+ 'title' => '唯一请求ID',
+ 'type' => 'string',
+ ],
+ 'Vpcs' => [
+ 'description' => '',
+ 'properties' => [
+ 'Vpc' => [
+ 'description' => '',
+ 'items' => [
+ 'description' => '',
+ 'properties' => [
+ 'VpcId' => [
+ 'description' => '',
+ 'example' => 'vpc-bp1qpo0kug3a20qqe****',
+ 'title' => 'vpc唯一标识',
+ 'type' => 'string',
+ ],
+ 'VpcName' => [
+ 'description' => '',
+ 'example' => 'vpc1',
+ 'title' => 'vpc名称',
+ 'type' => 'string',
+ ],
+ 'Status' => [
+ 'description' => '',
+ 'example' => 'Available',
+ 'title' => 'VPC的状态，取值：'."\n"
+ .'Pending：配置中。'."\n"
+ .'Available：可用。',
+ 'type' => 'string',
+ 'enum' => [],
+ ],
+ 'IsDefault' => [
+ 'description' => '',
+ 'example' => 'true',
+ 'title' => '是否是该地域的默认VPC',
+ 'type' => 'boolean',
+ ],
+ 'CidrBlock' => [
+ 'description' => '',
+ 'example' => '192.168.0.0/16',
+ 'title' => 'VPC的IPv4网段。',
+ 'type' => 'string',
+ ],
+ 'RegionNo' => [
+ 'description' => '',
+ 'example' => 'cn-hangzhou',
+ 'title' => 'VPC所在的地域ID。',
+ 'type' => 'string',
+ ],
+ 'GmtCreate' => [
+ 'description' => '',
+ 'example' => '2021-04-18T15:02:37Z',
+ 'title' => 'VPC的创建时间。',
+ 'type' => 'string',
+ ],
+ 'GmtModified' => [
+ 'description' => '',
+ 'example' => '2021-04-18T15:02:37Z',
+ 'title' => 'VPC的修改时间。',
+ 'type' => 'string',
+ ],
+ 'VSwitchs' => [
+ 'description' => '',
+ 'items' => [
+ 'description' => '',
+ 'example' => 'vsw-bp1nhbnpv2blyz8dl****',
+ 'title' => 'vpc交换机标识',
+ 'type' => 'string',
+ ],
+ 'title' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ ],
+ 'title' => '单个vpc信息',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '返回结果，vpc集合',
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B\\",\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1qpo0kug3a20qqe****\\",\\n \\"VpcName\\": \\"vpc1\\",\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n \\"VSwitchs\\": [\\n \\"vsw-bp1nhbnpv2blyz8dl****\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B</RequestId>\\n <Vpcs>\\n <Vpc>\\n <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>\\n <VpcName>vpc1</VpcName>\\n <Status>Available</Status>\\n <IsDefault>true</IsDefault>\\n <CidrBlock>192.168.0.0/16</CidrBlock>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <GmtCreate>2021-04-18T15:02:37Z</GmtCreate>\\n <GmtModified>2021-04-18T15:02:37Z</GmtModified>\\n <VSwitchs>vsw-bp1nhbnpv2blyz8dl****</VSwitchs>\\n </Vpc>\\n </Vpcs>\\n</DescribeVpcsResponse>","errorExample":""}]',
+ 'title' => 'DescribeVpcs',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-qingdao',
+ 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-2',
+ 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1',
+ 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-south-1',
+ 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-finance',
+ 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-finance-1',
+ 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-north-2-gov-1',
+ 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-guangzhou',
+ 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wulanchabu',
+ 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 13:12:38 +0000