'1.0',
'info' => ['style' => 'RPC', 'product' => 'elasticsearch', 'version' => '2019-04-22'],
'directories' => [
[
'id' => 62994,
'title' => '交换机',
'type' => 'directory',
'children' => ['DescribeVSwitches'],
],
[
'id' => 62996,
'title' => 'VPC',
'type' => 'directory',
'children' => ['DescribeVpcs'],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'DescribeVSwitches' => [
'summary' => '根据条件查询VSwitch列表。',
'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' => ['title' => '交换机所属区域id', 'description' => '待查询的交换机所属的地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['title' => '要查询的交换机所属VPC的ID。', 'description' => '待查询的交换机所属VPC的ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-25cdvfeq58pl****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '列表的页码', 'description' => '交换机列表的页码。默认值:1,取值范围:1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页查询时每页的行数', 'description' => '分页查询时设置的每页行数。默认值:50,取值范围:1~50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '50'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['title' => '要查询的交换机的ID。', 'description' => '待查询的交换机所属的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B'],
'VSwitches' => [
'title' => '交换机数组结果',
'description' => '交换机数组结果。',
'type' => 'object',
'properties' => [
'VSwitch' => [
'title' => '交换机数据结构体。',
'description' => '交换机的详细信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'title' => '交换机的状态,取值:'."\n"
.'Pending:配置中。'."\n"
.'Available:可用。',
'description' => '交换机的状态,取值:'."\n"
."\n"
.'- Pending:配置中'."\n"
.'- Available:可用',
'type' => 'string',
'example' => 'Available',
'enum' => [],
],
'VSwitchId' => ['title' => '交换机的ID。', 'description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-25bcdxs7pv1****'],
'IsDefault' => ['title' => '是否是默认交换机。取值:'."\n"
.'true:是默认交换机。'."\n"
.'false:非默认交换机。', 'description' => '是否是默认交换机。取值:'."\n"
."\n"
.'- true:是默认交换机'."\n"
.'- false:不是默认交换机', 'type' => 'boolean', 'example' => 'true'],
'CidrBlock' => ['title' => '交换机的IPv4网段。', 'description' => '交换机的IPv4网段。', 'type' => 'string', 'example' => '172.16.0.0/24'],
'GmtCreate' => ['title' => '交换机的创建时间。', 'description' => '交换机的创建时间。', 'type' => 'string', 'example' => '2022-01-18T12:43:57Z'],
'VSwitchName' => ['title' => '交换机的名称。', 'description' => '交换机的名称。', 'type' => 'string', 'example' => 'vswitch'],
],
],
],
],
],
],
],
],
],
'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":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B\\n \\n \\n Available\\n vsw-25bcdxs7pv1****\\n true\\n 172.16.0.0/24\\n 2022-01-18T12:43:57Z\\n vswitch\\n \\n \\n","errorExample":""}]',
'title' => '查询交换机列表',
],
'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' => ['title' => '区域ID', 'description' => '待查询的VPC所属的地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['title' => '可用区Id', 'description' => '查询的VPC所属的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-d'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页查询页码', 'description' => 'VPC列表的页码。默认值:1,取值范围:1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页查询每页大小', 'description' => '分页查询时设置的每页行数。默认值:50,取值范围:1~50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '50'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '唯一请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B'],
'Vpcs' => [
'title' => '返回结果,vpc集合',
'description' => 'VPC数组结果。',
'type' => 'object',
'properties' => [
'Vpc' => [
'title' => '单个vpc信息',
'description' => '单个VPC的详细信息。',
'type' => 'array',
'items' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'vpc唯一标识', 'description' => 'VPC的ID。', 'type' => 'string', 'example' => 'vpc-bp1qpo0kug3a20qqe****'],
'VpcName' => ['title' => 'vpc名称', 'description' => 'VPC名称。', 'type' => 'string', 'example' => 'vpc1'],
'Status' => [
'title' => 'VPC的状态,取值:'."\n"
.'Pending:配置中。'."\n"
.'Available:可用。',
'description' => 'VPC的状态,取值:'."\n"
."\n"
.'- Pending:配置中。'."\n"
.'- Available:可用。',
'type' => 'string',
'example' => 'Available',
'enum' => [],
],
'IsDefault' => ['title' => '是否是该地域的默认VPC', 'description' => '是否是该地域的默认VPC,取值:'."\n"
."\n"
.'- true:是该地域的默认VPC。'."\n"
.'- false:不是该地域的默认VPC。', 'type' => 'boolean', 'example' => 'true'],
'CidrBlock' => ['title' => 'VPC的IPv4网段。', 'description' => 'VPC的IPv4网段。', 'type' => 'string', 'example' => '192.168.0.0/16'],
'RegionNo' => ['title' => 'VPC所在的地域ID。', 'description' => 'VPC所在的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'GmtCreate' => ['title' => 'VPC的创建时间。', 'description' => 'VPC的创建时间。', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'],
'GmtModified' => ['title' => 'VPC的修改时间。', 'description' => 'VPC的修改时间。', 'type' => 'string', 'example' => '2021-04-18T15:02:37Z'],
'VSwitchs' => [
'title' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息',
'description' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息。',
'type' => 'array',
'items' => ['title' => 'vpc交换机标识', 'description' => '交换机的ID。', 'type' => 'string', 'example' => 'vsw-bp1nhbnpv2blyz8dl****'],
],
],
],
],
],
],
],
],
],
],
'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":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B\\n \\n \\n vpc-bp1qpo0kug3a20qqe****\\n vpc1\\n Available\\n true\\n 192.168.0.0/16\\n cn-hangzhou\\n 2021-04-18T15:02:37Z\\n 2021-04-18T15:02:37Z\\n vsw-bp1nhbnpv2blyz8dl****\\n \\n \\n","errorExample":""}]',
'title' => '查询VPC列表',
],
],
'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'],
],
];