'1.0',
'info' => ['style' => 'RPC', 'product' => 'CloudAPI', 'version' => '2016-07-14'],
'directories' => [
[
'children' => ['DissociateInstanceWithPrivateDNS', 'DeletePrivateDNS', 'AssociateInstanceWithPrivateDNS', 'CreatePrivateDNS', 'ListPrivateDNS', 'UpdatePrivateDNS'],
'type' => 'directory',
'title' => '内网域名解析',
'id' => 432486,
],
[
'children' => ['ModifyInstanceVpcAttributeForConsole', 'CreateInstance', 'DeleteInstance', 'ModifyInstanceAttribute', 'ModifyInstanceSpec', 'EnableInstanceAccessControl', 'DisableInstanceAccessControl', 'DescribeInstances'],
'type' => 'directory',
'title' => '实例',
'id' => 432255,
],
[
'children' => ['ModifyIntranetDomainPolicy', 'CreateApiGroup', 'DeleteApiGroup', 'ModifyApiGroup', 'DescribeApiGroup', 'DescribeApiGroups', 'DescribePurchasedApiGroup', 'DescribePurchasedApiGroups'],
'type' => 'directory',
'title' => '分组',
'id' => 432264,
],
[
'children' => ['DeleteDomain', 'DeleteDomainCertificate', 'SetDomain', 'SetDomainCertificate', 'SetDomainWebSocketStatus', 'SetWildcardDomainPatterns', 'DescribeDomain', 'ReactivateDomain'],
'type' => 'directory',
'title' => '域名',
'id' => 432273,
],
[
'children' => ['CreateMonitorGroup', 'DeleteMonitorGroup', 'DescribeApiLatencyData', 'DescribeApiQpsData', 'DescribeApiTrafficControls', 'DescribeApiTrafficData', 'DescribeInstanceDropPacket', 'DescribeInstanceDropConnections', 'DescribeInstanceHttpCode', 'DescribeInstanceLatency', 'DescribeInstanceNewConnections', 'DescribeInstancePackets', 'DescribeInstanceQps', 'DescribeInstanceSlbConnect', 'DescribeInstanceTraffic', 'DescribeGroupQps'],
'type' => 'directory',
'title' => '监控',
'id' => 432282,
],
[
'children' => [
'CreateApi', 'CreateApiStageVariable', 'ImportOAS', 'ImportSwagger', 'DeleteApi', 'DeleteApiStageVariable', 'ModifyApiConfiguration', 'ModifyApi', 'DescribeApisByBackend', 'DescribeApi', 'DescribeApiMarketAttributes', 'DescribeApis', 'DescribeApiHistory', 'DescribeApisByApp', 'DescribeAuthorizedApis', 'DescribeApiDoc', 'DescribeDeployedApi', 'DescribeHistoryApis', 'DescribeImportOASTask', 'DescribePurchasedApis',
'DescribeApiHistories', 'DescribeDeployedApis', 'DescribeMarketRemainsQuota', 'DescribeDeployApiTask', 'DescribeAbolishApiTask', 'AbolishApi', 'DeployApi', 'BatchDeployApis', 'BatchAbolishApis', 'SwitchApi', 'DryRunSwagger',
],
'type' => 'directory',
'title' => 'API管理',
'id' => 432299,
],
[
'children' => ['CreateApp', 'DeleteApp', 'ModifyApp', 'DescribeApps', 'DescribeAppAttributes', 'DescribeAuthorizedApps', 'DescribeApp', 'DescribeAppSecurity', 'ResetAppCode'],
'type' => 'directory',
'title' => '应用',
'id' => 432331,
],
[
'children' => ['RemoveVpcAccess', 'RemoveVpcAccessAndAbolishApis', 'ModifyVpcAccessAndUpdateApis', 'ModifyApiGroupVpcWhitelist', 'SetVpcAccess', 'DescribeApiGroupVpcWhitelist', 'DescribeVpcAccesses', 'DescribeUpdateVpcInfoTask', 'ValidateVpcConnectivity'],
'type' => 'directory',
'title' => '专有网络',
'id' => 432341,
],
[
'children' => ['CreateAccessControlList', 'DeleteAccessControlList', 'SetAccessControlListAttribute', 'AddAccessControlListEntry', 'RemoveAccessControlListEntry', 'DescribeAccessControlListAttribute', 'DescribeAccessControlLists'],
'type' => 'directory',
'title' => '访问控制策略',
'id' => 432443,
],
[
'children' => ['DetachGroupPlugin', 'AttachGroupPlugin', 'DescribePluginsByGroup', 'DescribePluginGroups', 'CreatePlugin', 'DeletePlugin', 'AttachPlugin', 'ModifyPlugin', 'DetachPlugin', 'DescribePluginApis', 'DescribePluginsByApi', 'DescribePluginSchemas', 'DescribePluginTemplates', 'DescribePlugins'],
'type' => 'directory',
'title' => '插件',
'id' => 432351,
],
[
'children' => ['CreateDataset', 'CreateDatasetItem', 'DeleteDataset', 'DeleteDatasetItem', 'ModifyDataset', 'ModifyDatasetItem', 'DescribeDatasetInfo', 'DescribeDatasetList', 'DescribeDatasetItemInfo', 'DescribeDatasetItemList'],
'type' => 'directory',
'title' => '自定义数据集',
'id' => 432451,
],
[
'children' => ['CreateModel', 'DeleteModel', 'ModifyModel', 'DescribeModels'],
'type' => 'directory',
'title' => '模型',
'id' => 432379,
],
[
'children' => ['SetApisAuthorities', 'SetAppsAuthorities', 'RemoveApisAuthorities', 'RemoveAppsAuthorities', 'ResetAppSecret'],
'type' => 'directory',
'title' => '权限',
'id' => 432384,
],
[
'children' => ['ListTagResources', 'TagResources', 'UntagResources'],
'type' => 'directory',
'title' => '标签',
'id' => 432390,
],
[
'children' => ['DescribeSummaryData', 'DescribeRegions', 'DescribeSystemParameters', 'DescribeZones', 'OpenApiGatewayService'],
'type' => 'directory',
'title' => '服务',
'id' => 432394,
],
[
'children' => ['CreateLogConfig', 'DeleteLogConfig', 'ModifyLogConfig', 'QueryRequestLogs', 'DescribeLogConfig'],
'type' => 'directory',
'title' => '日志',
'id' => 432400,
],
[
'children' => ['SdkGenerateByAppForRegion', 'SdkGenerateByApp', 'SdkGenerateByGroup'],
'type' => 'directory',
'title' => 'SDK',
'id' => 432418,
],
[
'children' => ['CreateBackend', 'DeleteBackend', 'ModifyBackend', 'DescribeBackendList', 'DescribeBackendInfo', 'DescribeUpdateBackendTask'],
'type' => 'directory',
'title' => '后端',
'id' => 432432,
],
[
'children' => ['CreateBackendModel', 'DeleteBackendModel', 'ModifyBackendModel'],
'type' => 'directory',
'title' => '后端模型',
'id' => 432439,
],
[
'children' => ['CreateSignature', 'DeleteSignature', 'ModifySignature', 'SetSignatureApis', 'DescribeSignatures', 'DescribeApisBySignature', 'DescribeApiSignatures', 'DescribeSignaturesByApi', 'RemoveSignatureApis'],
'type' => 'directory',
'title' => '签名插件(经典网络实例)',
'id' => 432422,
],
[
'children' => ['AddTrafficSpecialControl', 'CreateTrafficControl', 'DeleteAllTrafficSpecialControl', 'DeleteTrafficControl', 'DeleteTrafficSpecialControl', 'ModifyTrafficControl', 'SetTrafficControlApis', 'DescribeTrafficControls', 'DescribeTrafficControlsByApi', 'DescribeApisByTrafficControl', 'RemoveTrafficControlApis'],
'type' => 'directory',
'title' => '流控插件(经典网络实例)',
'id' => 432406,
],
[
'children' => ['AddIpControlPolicyItem', 'CreateIpControl', 'DeleteIpControl', 'ModifyIpControl', 'ModifyIpControlPolicyItem', 'SetIpControlApis', 'DescribeApiIpControls', 'DescribeIpControlPolicyItems', 'DescribeIpControls', 'DescribeApisByIpControl', 'RemoveIpControlApis', 'RemoveIpControlPolicyItem'],
'type' => 'directory',
'title' => '访问控制插件(经典网络实例)',
'id' => 432366,
],
[
'children' => [
'DescribeApisWithStageNameIntegratedByApp', 'DescribeGroupLatency', 'DescribeGroupTraffic', 'ModifyApiGroupInstance', 'ModifyApiGroupNetworkPolicy', 'DetachApiProduct', 'SetApiProductsAuthorities', 'DescribeApiProductsByApp', 'DescribeApiProductApis', 'DescribeAppsByApiProduct', 'AttachApiProduct', 'DeleteApiProduct', 'RemoveApiProductsAuthorities', 'SetAppsAuthToApiProduct', 'DescribeApisByVpcAccess', 'DeleteAppCode', 'DeleteAppKey', 'CreateAppCode', 'CreateAppKey', 'DescribeInstanceClusterInfo',
'DescribeInstanceClusterList', 'DescribeAppSecurities', 'ExportOAS', 'CreateStageModel', 'DeleteStageModel', 'DescribeStageModels', 'ModifyStageModel',
],
'type' => 'directory',
'title' => '其他',
'id' => 432462,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AbolishApi' => [
'summary' => '下线指定运行环境的指定API。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定分组编号', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '运行环境名称,取值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
],
'description' => '',
],
],
],
'title' => '下线 API',
'description' => '- 此功能面向开放API的用户,和发布API相对应'."\n"
.'- 将指定环境中运行的指定API从运行环境里删除,需要一定的时间,最长不超过5s'."\n"
.'- API下线后将不能被调用(指定环境)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbolishApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AbolishApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ016 \\r\\n","errorExample":""}]',
],
'AddAccessControlListEntry' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp1ohqkonqybecf4llbrc'],
],
[
'name' => 'AclEntrys',
'in' => 'query',
'schema' => ['description' => '设置访问控制策略组。'."\n"
."\n"
.'* entry:访问控制策略组中要添加的IP条目,可以指定IP地址段(CIDR block),多个IP地址段之间用逗号隔开。'."\n"
."\n"
.'* comment:访问控制策略组备注说明。'."\n"
."\n"
.'>每次最多可添加50个条目,如果添加的IP条目重复,则只会添加一条,其余重复条目会被忽略。IP条目必须是IP地址段。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{\'entry\': \'192.168.1.0/24\', \'comment\': \'test\'}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
],
'description' => '',
],
],
],
'title' => '添加IP条目',
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'在实例的访问控制策略中添加IP条目。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAccessControlListEntry'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AddAccessControlListEntry',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]',
],
'AddIpControlPolicyItem' => [
'summary' => '向某个已存在的IP访问控制增加一条策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94246',
'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略。', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '指定策略限制的AppId,只有控制类型为白名单(即IpControlType为ALLOW)时,才可同时增加AppId的限制。'."\n"
."\n"
.'- 一次只能增加一个。'."\n"
.'- 为空表示没有AppId的限制。'."\n"
.'- 当该值不为空,表示在有IP限制的同时,还限制访问的AppId。'."\n"
.'- 请注意:当该值不为空,如果API的安全认证为“无认证”,将限制所有的API调用。'."\n"
.'- 当黑名单(IpControlType为REFUSE)时,该值不为空,API网关会自动忽略该值,只设置IP的限制。', 'type' => 'string', 'required' => false, 'example' => '1111111'],
],
[
'name' => 'CidrIp',
'in' => 'query',
'schema' => ['description' => '具体策略的IP或者IP段,多个请用英文分号(;)分割,最多添加10个。', 'type' => 'string', 'required' => true, 'example' => '113.125.1.101;101.11.1.1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyItemId' => ['description' => '该策略的唯一ID', 'type' => 'string', 'example' => 'P151617000829241'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '增加IP访问控制策略',
'description' => '调用该接口时请注意:'."\n"
.'- 此功能面向API提供者。'."\n"
.'- 增加该策略后,所有绑定该访问控制的API,即时生效。'."\n"
.'- 一个IP访问控制下最多添加100条策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIpControlPolicyItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AddIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyItemId\\": \\"P151617000829241\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n P151617000829241\\r\\n","errorExample":""}]',
],
'AddTrafficSpecialControl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94247',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '指定流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'tf123456'],
],
[
'name' => 'SpecialType',
'in' => 'query',
'schema' => ['description' => '特殊流控类型,可选值:'."\n"
."\n"
.'- **APP**:应用'."\n"
.'- **USER**:用户', 'type' => 'string', 'required' => true, 'example' => 'APP'],
],
[
'name' => 'SpecialKey',
'in' => 'query',
'schema' => ['description' => '根据**SpecialType**填写对应的AppId或者阿里云账号ID(账号ID请到[账号管理](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3f053654YpMPwo#/secure)页面查看)', 'type' => 'string', 'required' => true, 'example' => '3382463'],
],
[
'name' => 'TrafficValue',
'in' => 'query',
'schema' => ['description' => '对应的特殊流控值', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '添加特殊流控配置',
'summary' => '在指定流控策略下添加用户自定义特殊流控策略。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 若传入的SpecialKey已经存在,则会直接覆盖之前的配置,请慎重操作'."\n"
.'- 注意特殊流控是添加到已存在的指定流控策略下的,添加后特殊流控策略将对该策略下的所有API生效'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTrafficSpecialControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AddTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'AssociateInstanceWithPrivateDNS' => [
'summary' => '关联内网域名解析到专享实例',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-ead4f4b0bac8'."\n"],
],
[
'name' => 'IntranetDomains',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '需要绑定的内网域名解析的内网域名列表',
'type' => 'array',
'items' => ['description' => '内网域名解析的内网域名', 'type' => 'string', 'required' => false, 'example' => 'api.demo.com'],
'required' => true,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关联内网域名解析到专享实例',
'description' => '仅支持将内网域名解析关联到专享实例,不支持共享实例和专享实例集群;',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateInstanceWithPrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AssociateInstanceWithPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB999B529\\"\\n}","type":"json"}]',
],
'AttachApiProduct' => [
'summary' => '将API绑定到指定的API产品(如果指定的API产品不存在,将自动创建)',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
[
'name' => 'Apis',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'API 列表',
'type' => 'array',
'items' => [
'description' => 'API 列表',
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'required' => true, 'example' => '551877242a4b4f3a84a56b7c3570e4a7'],
'StageName' => ['description' => '环境名称,枚举为:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\"\\n}","type":"json"}]',
'title' => '将API绑定到指定API产品',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachApiProduct'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AttachApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'AttachGroupPlugin' => [
'summary' => '分组绑定插件',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => 'API网关插件ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作 API 的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '绑定插件到分组上',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachGroupPlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:AttachGroupPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","type":"json"}]',
],
'AttachPlugin' => [
'summary' => '将API和插件建立绑定关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94249',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => '绑定的API网关插件ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9a3f1a5279434f2ba74ccd91c295af9f '],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '要绑定的API分组ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '285bb759342649a1b70c2093a772e087'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'xxx'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '要绑定的API编号', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '8afff6c8c4c6447abb035812e4d66b65 '],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
'description' => '',
],
],
],
'title' => '绑定插件到API上',
'description' => '- 此接口面向开放API的用户'."\n"
.'- 绑定操作只能选择发布状态的API'."\n"
.'- 绑定以后及时生效'."\n"
.'- 修改插件后及时生效',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachPlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AttachPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\r\\n","errorExample":""}]',
],
'BatchAbolishApis' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Api',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定要操作的api',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StageId' => ['description' => '环境id', 'type' => 'string', 'required' => false, 'example' => '979fd16250644d5b82173534f465ac77'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'required' => true, 'example' => 'ced5ab777f7b440398ea70e4470124de'],
'ApiUid' => ['description' => 'API 唯一标识', 'type' => 'string', 'required' => true, 'example' => '994f72dcdaf04af0b38022c65fdbd1ac'],
'StageName' => ['description' => '环境名称', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
'required' => false,
'description' => '',
],
'required' => true,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperationId' => ['description' => '操作ID。', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06'],
],
'description' => '',
],
],
],
'title' => '批量下线API',
'summary' => '批量下线已经发布到环境的API。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAbolishApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:BatchAbolishApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]',
],
'BatchDeployApis' => [
'summary' => '批量发布API到预发/测试/线上环境。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '运行环境名称,取值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试'."\n"
."\n"
.'- PRE:预发', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'],
],
[
'name' => 'Api',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定要操作的api列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'required' => true, 'example' => 'b4f5c342b8bc4ef88ccda0332402****'],
'ApiUid' => ['description' => 'API 唯一标识', 'type' => 'string', 'required' => true, 'example' => '2b35dd68345b472f8051647306a1****'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperationId' => ['description' => '操作ID。', 'type' => 'string', 'example' => '2a322599-8e38-428a-a306-9b21ea2129bf'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06'],
],
'description' => '',
],
],
],
'title' => '批量发布API',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeployApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:BatchDeployApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"2a322599-8e38-428a-a306-9b21ea2129bf\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]',
],
'CreateAccessControlList' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'创建访问控制策略,每个用户每个region下只允许创建5个访问控制策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AclName',
'in' => 'query',
'schema' => ['description' => '访问控制策略组名称,长度限制为1~30个字符,只支持中文、字母、数字和半角句号(.)、短划线(-)、正斜线(/)和下划线(_)。访问控制策略组名称必须为地域内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAcl'],
],
[
'name' => 'AddressIPVersion',
'in' => 'query',
'schema' => ['description' => '访问控制策略组的IP版本。取值:'."\n"
.'- **IPv4**。'."\n"
.'- **IPv6**。', 'type' => 'string', 'required' => false, 'example' => 'ipv4', 'default' => 'ipv4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'AclId' => ['description' => '访问控制策略ID。', 'type' => 'string', 'example' => 'acl-bp1uqwgwmkbutnzq2r59z'],
],
'description' => '',
],
],
],
'title' => '创建访问控制策略',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessControlList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAccessControlList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"AclId\\": \\"acl-bp1uqwgwmkbutnzq2r59z\\"\\n}","type":"json"}]',
],
'CreateApi' => [
'summary' => '新建一个 API。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => '设置API的名称,组内不允许重复。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50个字符', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ApiName'],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => ['description' => 'API是否公开,可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PUBLIC'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API描述信息,最多180个字符', 'type' => 'string', 'required' => false, 'example' => 'Api description'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。', 'type' => 'string', 'required' => false, 'example' => 'APP'],
],
[
'name' => 'RequestConfig',
'in' => 'query',
'schema' => ['description' => 'Consumer向网关发送API请求的相关配置项。'."\n"
."\n"
.'更多信息,请参见[RequestConfig](~~43985~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}'],
],
[
'name' => 'ServiceConfig',
'in' => 'query',
'schema' => ['description' => '网关向后端服务发送API请求的相关配置项。'."\n"
."\n"
.'更多信息,请参见[ServiceConfig](~~43987~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}'],
],
[
'name' => 'RequestParameters',
'in' => 'formData',
'schema' => ['description' => 'Consumer向网关发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[RequestParameter](~~43986~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 2'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "OPTIONAL",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "header1",'."\n"
.' "DefaultValue": "123124",'."\n"
.' "Location": "Head"'."\n"
.' },'."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 2'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "header2",'."\n"
.' "DefaultValue": "",'."\n"
.' "Location": "Head"'."\n"
.' },'."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Query",'."\n"
.' "orderNumber": 3'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "OPTIONAL",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "query1",'."\n"
.' "DefaultValue": "1245",'."\n"
.' "Location": "Query"'."\n"
.' },'."\n"
.' {'."\n"
.' "ApiParameterName": "CaClientIp",'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Query",'."\n"
.' "orderNumber": 0'."\n"
.' },'."\n"
.' "Location": "Query",'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "Description": "ClientIP"'."\n"
.' },'."\n"
.' {'."\n"
.' "ApiParameterName": "testConstant",'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 0'."\n"
.' },'."\n"
.' "Location": "Head",'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "DefaultValue": "111"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'SystemParameters',
'in' => 'formData',
'schema' => ['description' => '网关发送给后端服务的系统参数', 'type' => 'string', 'required' => false, 'example' => '[{\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaDomain\\",\\"serviceParameterName\\":\\"host\\"}]'],
],
[
'name' => 'ConstantParameters',
'in' => 'formData',
'schema' => ['description' => '网关发送给后端服务的常量参数', 'type' => 'string', 'required' => false, 'example' => '[{\\"ConstantValue\\":\\"123\\",\\"Description\\":\\"Constant parameter\\",\\"Location\\":\\"HEAD\\",\\"ServiceParameterName\\":\\"test\\"}]'],
],
[
'name' => 'ServiceParameters',
'in' => 'formData',
'schema' => ['description' => '网关向后端服务发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[ServiceParameter](~~43988~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ServiceParameterName": "header1",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "header2",'."\n"
.' "Location": "Query",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "query1",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "ipp",'."\n"
.' "Location": "Query",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "SYSTEM"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "testConstant",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "CONSTANT"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'ServiceParametersMap',
'in' => 'formData',
'schema' => ['description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。'."\n"
."\n"
.'更多信息,请参见[ServiceParameterMap](~~43989~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ServiceParameterName": "header1",'."\n"
.' "RequestParameterName": "header1"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "header2",'."\n"
.' "RequestParameterName": "header2"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "query1",'."\n"
.' "RequestParameterName": "query1"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "ipp",'."\n"
.' "RequestParameterName": "CaClientIp"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "testConstant",'."\n"
.' "RequestParameterName": "testConstant"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'ResultType',
'in' => 'query',
'schema' => ['description' => '后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。默认为JSON。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HTML'],
],
[
'name' => 'ResultSample',
'in' => 'formData',
'schema' => ['description' => '后端服务返回应答的示例,该值仅用于生成文档使用。不对返回结果产生影响。(最大支持32KB)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{}'],
],
[
'name' => 'FailResultSample',
'in' => 'formData',
'schema' => ['description' => '后端服务失败返回应答的示例'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。(最大支持16KB)', 'type' => 'string', 'required' => false, 'example' => '{\\"requestId\\":\\"3b9b8b31-93c3-489e-8ebb-cab35a1aee51\\",\\"errCode\\":500,\\"errMsg\\":\\"connection refused\\"}'],
],
[
'name' => 'ErrorCodeSamples',
'in' => 'formData',
'schema' => ['description' => '后端服务返回的错误码示例。'."\n"
."\n"
.'更多信息,请参见[ErrorCodeSample](~~44392~~)。', 'type' => 'string', 'required' => false, 'example' => '[{\\"Code\\":\\"400\\",\\"Message\\":\\"Login failed\\",\\"Description\\":\\"Invalid user name or password\\"}]'],
],
[
'name' => 'ResultDescriptions',
'in' => 'formData',
'schema' => ['description' => 'api的返回说明', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'OpenIdConnectConfig',
'in' => 'query',
'schema' => ['description' => 'ip访问控制的开关状态,取值:-**on**:打开-**off**:关闭', 'type' => 'string', 'required' => false, 'example' => '{\\"openIdApiType\\":null,\\"idTokenParamName\\":null,\\"publicKeyId\\":null,\\"publicKey\\":null}'],
],
[
'name' => 'AllowSignatureMethod',
'in' => 'query',
'schema' => ['description' => '当**AuthType**为**APP**认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256'],
],
[
'name' => 'WebSocketApiType',
'in' => 'query',
'schema' => ['description' => '双向通信API类型:'."\n"
."\n"
.'- **COMMON**:普通API'."\n"
.'- **REGISTER**:注册API'."\n"
.'- **UNREGISTER**:注销API'."\n"
.'- **NOTIFY**:下行通知', 'type' => 'string', 'required' => false, 'example' => 'COMMON'],
],
[
'name' => 'ResultBodyModel',
'in' => 'query',
'schema' => ['description' => 'api的返回结果', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'ForceNonceCheck',
'in' => 'query',
'schema' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
."\n"
.'- 设置**ForceNonceCheck**为**false**,则不检查。创建API时默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DisableInternet',
'in' => 'query',
'schema' => ['description' => '- 设置**DisableInternet**为**true**, 仅支持内网调用API。'."\n"
.'- 设置**DisableInternet**为**false**, 则不限制调用。创建API时默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AppCodeAuthType',
'in' => 'query',
'schema' => ['description' => '当**AuthType**为**APP**认证时,可选值如下:'."\n"
."\n"
.'- **DEFAULT**:不传默认是DEFAULT(随分组设置)'."\n"
.'- **DISABLE**:不允许'."\n"
.'- **HEADER**:允许AppCode的Header认证'."\n"
.'- **HEADER_QUERY**:允许AppCode的Header及Query认证', 'type' => 'string', 'required' => false, 'example' => 'HEADER'],
],
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => false, 'example' => 'a0305308908c4740aba9cbfd63ba99b7'],
],
[
'name' => 'BackendEnable',
'in' => 'query',
'schema' => ['description' => '是否启用后端服务', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的键', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签的value'."\n", 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => '本次创建API的ID', 'type' => 'string', 'example' => '8afff6c8c4c6447abb035812e4d66b65'],
'RequestId' => ['description' => '本次创建API的请求ID', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"8afff6c8c4c6447abb035812e4d66b65\\",\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]',
'title' => '创建 API',
'description' => '- 此接口面向开放API的用户。'."\n"
.'- 同一个分组内API不允许重名。'."\n"
.'- 同一个分组内Path不允许重复。'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'CreateApiGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94264',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Weather'],
],
[
'name' => 'BasePath',
'in' => 'query',
'schema' => ['description' => 'api根路径', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '/qqq'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API分组描述,不超过180个字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'The weather informations.'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'apigateway-cn-v6419k43xxxxx'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的value', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TagStatus' => ['description' => '标签是否存在,取值:-**true**:存在-**false**:不存在', 'type' => 'boolean', 'example' => 'True'],
'BasePath' => ['description' => 'api根路径', 'type' => 'string', 'example' => '/qqq'],
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514'],
'Description' => ['description' => 'API分组描述', 'type' => 'string', 'example' => 'The weather informations'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'Weather'],
'GroupId' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7xx'],
'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'apigateway-cn-v6419k43xxxxx'],
'SubDomain' => ['description' => '系统给分组绑定的二级域名,用于测试API调用', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com'],
'InstanceType' => ['description' => '实例类型'."\n"
.'- CLASSIC_SHARED:共享实例经典网络'."\n"
.'- VPC_SHARED:共享实例(VPC)'."\n"
.'- VPC_DEDICATED:专享实例(VPC)', 'type' => 'string', 'example' => 'VPC_SHARED'],
],
'description' => '',
],
],
],
'title' => '创建API分组',
'summary' => '创建API分组。',
'description' => '创建API需要先创建分组,所属分组是API的一个基本属性信息。'."\n"
."\n"
.'- 此功能面向API提供者。'."\n"
.'- 每个用户每个区域下最多可创建100个分组。'."\n"
.'- 系统自动给分组分配二级域名,用于测试API。'."\n"
.'- 分组带有区域属性,后续创建API选择分组后就选择了区域,为减少网络延时,建议选择与后端服务相同的区域。'."\n"
.'- 创建分组后,可为分组绑定已备案的自定义域名。'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TagStatus\\": true,\\n \\"BasePath\\": \\"/qqq\\",\\n \\"RequestId\\": \\"FF3B7D81-66AE-47E0-BF69-157DCF187514\\",\\n \\"Description\\": \\"The weather informations\\",\\n \\"GroupName\\": \\"Weather\\",\\n \\"GroupId\\": \\"523e8dc7bbe04613b5b1d726c2a7xx\\",\\n \\"InstanceId\\": \\"apigateway-cn-v6419k43xxxxx\\",\\n \\"SubDomain\\": \\"523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com\\",\\n \\"InstanceType\\": \\"VPC_SHARED\\"\\n}","errorExample":""},{"type":"xml","example":"523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com\\nWeather\\nThe weather informations\\nFF3B7D81-66AE-47E0-BF69-157DCF187514\\napigateway-cn-v6419k43xxxxx\\nVPC_SHARED\\n523e8dc7bbe04613b5b1d726c2a7889d","errorExample":""}]',
],
'CreateApiStageVariable' => [
'summary' => '在某运行环境下增加变量。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94265',
'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'StageId',
'in' => 'query',
'schema' => ['description' => '环境 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
],
[
'name' => 'VariableName',
'in' => 'query',
'schema' => ['description' => '变量名,区分大小写', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serverName'],
],
[
'name' => 'SupportRoute',
'in' => 'query',
'schema' => ['description' => '是否支持路由', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'VariableValue',
'in' => 'query',
'schema' => ['description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'api.domain.com'],
],
[
'name' => 'StageRouteModel',
'in' => 'query',
'schema' => ['description' => '环境路由模型', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '{'."\n"
.' "location": "HEAD",'."\n"
.' "parameterCatalog": "CUSTOM",'."\n"
.' "parameterType": "String",'."\n"
.' "serviceParameterName": "TestConstant",'."\n"
.' "routeMatchSymbol": "IN",'."\n"
.' "routeRules": ['."\n"
.' {'."\n"
.' "conditionValue": "aaa,bbb",'."\n"
.' "resultValue": "apigateway-test.com"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529'],
],
'description' => '',
],
],
],
'title' => '创建环境变量',
'description' => '- 此功能面向API提供者'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiStageVariable'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApiStageVariable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB999B529\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 03442A3D-3B7D-434C-8A95-A5FEB999B529\\r\\n","errorExample":""}]',
],
'CreateApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'],
],
'parameters' => [
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'APP名称。支持汉字、英文字母、数字、英文格式的下划线,且必须以字母或汉字开始,长度限制为4~26个字符', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CreateAppTest'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'APP描述信息,长度不超过180个字符', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`。当参数有值,要求对应当tag.N.Key在相同的N的标签键也传入值,否则会报错。', 'type' => 'string', 'required' => false, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 500,
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'App的Key,用于调用API时使用', 'type' => 'string', 'required' => false, 'example' => '60030986'],
],
[
'name' => 'AppSecret',
'in' => 'query',
'schema' => ['description' => 'App的密码', 'type' => 'string', 'required' => false, 'example' => 'nzyNqFkRWB2uLw86'],
],
[
'name' => 'AppCode',
'in' => 'query',
'schema' => ['description' => '应用的AppCode', 'type' => 'string', 'required' => false, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc'],
],
[
'name' => 'Extend',
'in' => 'query',
'schema' => ['description' => '扩展信息', 'type' => 'string', 'required' => false, 'example' => '110210264071'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TagStatus' => ['description' => '标签是否存在,取值为:-**true**:存在-**false**:不存在', 'type' => 'boolean', 'example' => 'false'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550'],
'AppId' => ['description' => 'APP的唯一编号', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278'],
],
'description' => '',
],
],
],
'title' => '创建APP',
'summary' => '创建API网关的APP。',
'description' => '- 此功能面向调用API的用户'."\n"
.'- 每个APP有一对Key和Value密钥对,该密钥在调用API时用于身份验证'."\n"
.'- APP调用API需要建立授权关系,即授予APP调用某API的权限'."\n"
.'- 一个APP下只能有一对密钥,若密钥泄露可以重置'."\n"
.'- 每个阿里云账号创建APP的个数上限是1000个'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TagStatus\\": false,\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\",\\n \\"AppId\\": 20112314518278\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 20112314518278 \\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n","errorExample":""}]',
],
'CreateAppCode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '207738',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111203109'],
],
[
'name' => 'AppCode',
'in' => 'query',
'schema' => ['description' => '应用的APPCode编码', 'type' => 'string', 'required' => false, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88'],
],
'description' => '',
],
],
],
'title' => 'App添加AppCode',
'summary' => '给App添加AppCode。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppCode'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88\\"\\n}","type":"json"}]',
],
'CreateAppKey' => [
'summary' => 'App添加AppKey和AppSecret。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '207737',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111053351'],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'App的key', 'type' => 'string', 'required' => false, 'example' => '204203237'],
],
[
'name' => 'AppSecret',
'in' => 'query',
'schema' => ['description' => '应用AppSecret', 'type' => 'string', 'required' => false, 'example' => '6f0a4ad7918a4b41a57fc087d5b066d0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5D524309-6BED-5BB4-A735-F7D9F98B7B88'],
],
'description' => '',
],
],
],
'title' => 'App添加AppKey和AppSecret',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppKey'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAppKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D524309-6BED-5BB4-A735-F7D9F98B7B88\\"\\n}","type":"json"}]',
],
'CreateBackend' => [
'summary' => '在API网关创建后端服务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'BackendName',
'in' => 'query',
'schema' => ['description' => '后端服务名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testBackendService'],
],
[
'name' => 'BackendType',
'in' => 'query',
'schema' => ['description' => '后端服务类型,可选值有`HTTP,VPC,FC_EVENT, FC_EVENT_V3,FC_HTTP, FC_HTTP_V3,OSS,MOCK`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HTTP'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HTTP backend'],
],
[
'name' => 'CreateEventBridgeServiceLinkedRole',
'in' => 'query',
'schema' => ['description' => '是否服务关联角色', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'CreateSlr',
'in' => 'query',
'schema' => ['description' => '创建服务关联角色', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的值', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'BackendId' => ['description' => '后端服务ID', 'type' => 'string', 'example' => '0d105f80a8f340408bd34954d4e4ff22'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '66D84355-164D-53ED-81FF-03DCF181DE24'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackendId\\": \\"0d105f80a8f340408bd34954d4e4ff22\\",\\n \\"RequestId\\": \\"66D84355-164D-53ED-81FF-03DCF181DE24\\"\\n}","type":"json"}]',
'title' => '创建后端服务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackend'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateBackendModel' => [
'summary' => '创建后端服务在环境上的配置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端 ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '34e94fcd3e2e47a49824a89b8f92cb5e'],
],
[
'name' => 'BackendType',
'in' => 'query',
'schema' => ['description' => '后端类型', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTTP'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'BackendModelData',
'in' => 'query',
'schema' => ['description' => '后端模型数据。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{\\"ServiceAddress\\":\\"http://apigateway.alicloudapi.com:8080\\"}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '后端模型描述', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'model description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'BackendModelId' => ['description' => '后端模型 ID', 'type' => 'string', 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA'],
],
'description' => '',
],
],
],
'title' => '创建后端模型',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackendModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackendModelId\\": \\"4be6b110b7aa40b0bf0c83cc00b3bd86\\",\\n \\"RequestId\\": \\"64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA\\"\\n}","type":"json"}]',
],
'CreateDataset' => [
'summary' => '创建用户自定义数据集。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREapigatewayE6KZ22'],
],
'parameters' => [
[
'name' => 'DatasetName',
'in' => 'query',
'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DatasetName'],
],
[
'name' => 'DatasetType',
'in' => 'query',
'schema' => ['description' => '数据集类型,可选值:'."\n"
.'- JWT_BLOCKING : JWT黑名单'."\n"
.'- IP\\_WHITELIST\\_CIDR : IP白名单'."\n"
.'- PARAMETER_ACCESS : 参数访问控制', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'JWT_BLOCKING'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的键', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签的值', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => 'a25a6589b2584ff490e891cc********'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A96********'],
],
'description' => '',
],
],
],
'title' => '创建数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DatasetId\\": \\"a25a6589b2584ff490e891cc********\\",\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A96********\\"\\n}","type":"json"}]',
],
'CreateDatasetItem' => [
'summary' => '创建用户自定义数据集的数据条目。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '数据值(根据数据集类型填写对应类型数据值)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '106.43.XXX.XXX'],
],
[
'name' => 'ExpiredTime',
'in' => 'query',
'schema' => ['description' => '数据条目超时时间,格式为**yyyy-MM-ddTHH:mm:ssZ(UTC时间)**'."\n"
.'为空时表示永不过期', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-09-22T12:00:00Z'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,不超过180个字符', 'type' => 'string', 'required' => false, 'example' => 'Description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DatasetItemId' => ['description' => '数据集条目ID', 'type' => 'string', 'example' => '5045****'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8A5E2053-4D9F-5280-B7A9-D357********'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"RequestId\\": \\"8A5E2053-4D9F-5280-B7A9-D357********\\"\\n}","type":"json"}]',
'title' => '创建数据集条目',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
],
'CreateInstance' => [
'summary' => '创建API网关实例。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => ['description' => '付费类型。', 'type' => 'string', 'required' => true, 'example' => 'PostPaid'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'ApigatewayInstance'],
],
[
'name' => 'InstanceSpec',
'in' => 'query',
'schema' => ['description' => '实例规格', 'type' => 'string', 'required' => true, 'example' => 'api.s1.small'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '可用区,专享实例类型为传统类型专享实例为必填项,VPC融合类型专享实例可以不填', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-MAZ3(c,e)'],
],
[
'name' => 'HttpsPolicy',
'in' => 'query',
'schema' => ['description' => 'HTTPS的策略', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTTPS2_TLS1_2'],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => ['description' => '实例包年包月的时间,取值:'."\n"
."\n"
.'- PricingCycle为**Month**,表示按月付费,取值范围为**1**~**9**。'."\n"
.'- PricingCycle为**Year**,表示按年付费,取值范围为**1**~**3**。'."\n"
."\n"
.'> ChargeType取值为**PrePaid**时,本参数可用且必须传入。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PricingCycle',
'in' => 'query',
'schema' => ['description' => '指定预付费实例为包年或包月类型,取值范围如下:'."\n"
."\n"
.'- **year**:年'."\n"
.'- **month**:月'."\n"
."\n"
.'> 若付费类型为PrePaid,该参数为必传参数。', 'type' => 'string', 'required' => false, 'example' => 'Month', 'default' => 'month'],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => '续费时是否自动付费。取值:'."\n"
.'* **True**:自动付费。请确保账号有足够的余额。'."\n"
.'* **False**:控制台手动付费。具体操作为:登录控制台,在右上角选择**费用>进入费用中心**,在**订单管理**找到目标订单进行支付。'."\n"
."\n"
.'默认值:**False**。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '口令,是用来做防止重复提交请求的,请勿重复使用。如果Token字符串的前后包含空格,空格会被网关自动删除(Trim)。', 'type' => 'string', 'required' => true, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'test1'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => ['description' => '专享实例类型'."\n"
.'- vpc_connect:VPC融合类型专享实例'."\n"
.'- normal:传统类型专享实例'."\n"
."\n"
.'>该参数正在邀测中,暂未开放使用。>', 'type' => 'string', 'required' => false, 'example' => 'vpc_connect'],
],
[
'name' => 'InstanceCidr',
'in' => 'query',
'schema' => ['description' => '专享实例类型为VPC融合专享实例时,实例所在网段'."\n"
.'- 192.168.0.0/16'."\n"
.'- 172.16.0.0/12'."\n"
."\n"
.'>VPC融合专享实例会连接您指定的网段,请尽量避开冲突,以防出现云产品的私网IP和您指定网段下云服务IP冲突的情况>'."\n"
.'>该参数正在邀测中,暂未开放使用。>', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/12'],
],
[
'name' => 'UserVpcId',
'in' => 'query',
'schema' => ['description' => '专享实例类型为VPC融合专享实例时,需要连通的用户VPC ID'."\n"
.'>该参数正在邀测中,暂未开放使用。>', 'type' => 'string', 'required' => false, 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg'."\n"],
],
[
'name' => 'ZoneVSwitchSecurityGroup',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '专享实例类型为VPC融合专享实例时,需要连通网络所需要的可用区,虚拟交换机以及安全组信息'."\n"
.'>该参数正在邀测中,暂未开放使用。>',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-c'],
'VSwitchId' => ['description' => '虚拟交换机ID', 'type' => 'string', 'required' => false, 'example' => 'vsw-0xi349n11cxogmvm866tb'],
'CidrBlock' => ['description' => '交换机的IPv4网段。', 'type' => 'string', 'required' => false, 'example' => '192.168.9.0/24'],
'SecurityGroupId' => ['description' => '安全组的ID,同一个安全组内的服务可以互相访问。', 'type' => 'string', 'required' => false, 'example' => 'sg-2ze2ql9nozv8q7kmlt6e'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 3,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TagStatus' => ['description' => '标签是否存在,取值为:-**true**:存在-**false**:不存在', 'type' => 'boolean', 'example' => 'True'],
'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'apigateway-hz-b3c5dadd5***'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagStatus\\": true,\\n \\"InstanceId\\": \\"apigateway-hz-b3c5dadd5***\\",\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]',
'title' => '创建实例',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'],
],
],
],
],
],
'CreateIpControl' => [
'summary' => '在某个地域下新增IP访问控制。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94273',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlName',
'in' => 'query',
'schema' => ['description' => 'IP访问控制名称。支持大小写英文字母、中文、数字、下划线(_)、长度为`[4,50]`个字符, 且不能以下划线开头。', 'type' => 'string', 'required' => true, 'example' => 'controlNameTest'],
],
[
'name' => 'IpControlType',
'in' => 'query',
'schema' => ['description' => 'IP访问控制类型:'."\n"
."\n"
.'- **ALLOW**:IP访问控制为白名单类型'."\n"
.'- **REFUSE**:IP访问控制为黑名单类型', 'type' => 'string', 'required' => true, 'example' => 'ALLOW'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,不超过200个字符', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'IpControlPolicys',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '由ipcontrolpolicys组成的数组格式,返回策略的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppId' => ['description' => '策略限制的AppId,只有控制类型为白名单(即 IpControlType为ALLOW)时,才可同时增加AppId的限制。'."\n"
."\n"
.'- 一次只能增加一个;'."\n"
.'- 为空表示没有AppId的限制;'."\n"
.'- 当该值不为空,表示在有IP限制的同时,还限制访问的AppId;'."\n"
.'- 当该值不为空,如果API的安全认证为“无认证”,将限制所有的API调用,请注意;'."\n"
.'- 当黑名单(IpControlType为REFUSE)时,该值不为空,API网关会自动忽略该值,只设置IP的限制;'."\n"
.'- IpControlPolicys.N 中N的取值范围:`[1,100]`;', 'type' => 'string', 'required' => false, 'example' => '11111'],
'CidrIp' => ['description' => '具体策略的IP或者IP段'."\n"
."\n"
.'- 当要在创建访问控制时指定策略,该值不能为空;'."\n"
.'- 每条策略的IP或者IP段,多个请用英文分号(;)分割,最多添加10个;'."\n"
.'- IpControlPolicys.N 中N的取值范围:`[1,100]`', 'type' => 'string', 'required' => false, 'example' => '114.1.1.0/24'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IpControlId' => ['description' => '访问控制的ID', 'type' => 'string', 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
],
'description' => '',
],
],
],
'title' => '新增IP访问控制',
'description' => '调用本接口之前,您需要了解:'."\n"
.'- 此功能面向API提供者。'."\n"
.'- IP访问控制创建后,未绑定API前是无意义的,绑定API后,对绑定的API即时生效。'."\n"
.'- 具体的IP策略可以在创建IP控制时添加'."\n"
.'- 当IP访问控制下策略为空时,该策略无效。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIpControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IpControlId\\": \\"7ea91319a34d48a09b5c9c871d9768b1\\",\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CE5722A6-AE78-4741-A9B0-6C817D360510\\r\\n 7ea91319a34d48a09b5c9c871d9768b1\\r\\n","errorExample":""}]',
],
'CreateLogConfig' => [
'summary' => '为API创建日志服务的配置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94274',
'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'],
],
'parameters' => [
[
'name' => 'SlsProject',
'in' => 'query',
'schema' => ['description' => '日志服务中日志项目的名称。', 'type' => 'string', 'required' => true, 'example' => 'rec-lq-sls'],
],
[
'name' => 'SlsLogStore',
'in' => 'query',
'schema' => ['description' => 'slslogstore', 'type' => 'string', 'required' => true, 'example' => 'api-gateway'],
],
[
'name' => 'LogType',
'in' => 'query',
'schema' => [
'description' => '日志类型',
'type' => 'string',
'required' => false,
'example' => 'PROVIDER',
'default' => 'PROVIDER',
'enum' => ['PROVIDER'],
],
],
[
'name' => 'CreateSlr',
'in' => 'query',
'schema' => ['description' => '创建服务关联角色', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'],
],
'description' => '',
],
],
],
'title' => '创建日志配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLogConfig'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]',
],
'CreateModel' => [
'summary' => '在API分组的模型管理中创建模型。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94275',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['description' => '模型的名称,组内不许重复', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '模型所属的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381'],
],
[
'name' => 'Schema',
'in' => 'query',
'schema' => ['description' => '模型的JSON Schema定义', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '模型定义的描述', 'type' => 'string', 'required' => false, 'example' => 'Model Description'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ModifiedTime' => ['description' => '本次创建模型的最后修改时间', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411'],
'Description' => ['description' => '本次创建模型的描述', 'type' => 'string', 'example' => 'Model Description'],
'GroupId' => ['description' => '本次创建模型所属的分组编号', 'type' => 'string', 'example' => '30e792398d6c4569b04c0e53a3494381'],
'Schema' => ['description' => '本次创建模型的模型定义', 'type' => 'string', 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}'],
'ModelName' => ['description' => '本次创建模型的名称', 'type' => 'string', 'example' => 'Test'],
'CreatedTime' => ['description' => '本次创建模型的创建时间', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z'],
'ModelId' => ['description' => '本次创建模型的ID', 'type' => 'string', 'example' => '766c0b9538a04bdf974953b5576783ba'],
'RegionId' => ['description' => '本次创建模型的所属区域', 'type' => 'string', 'example' => 'cn-qingdao'],
'ModelRef' => ['description' => '本次创建模型的URI', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba'],
],
'description' => '',
],
],
],
'title' => '创建模型',
'description' => '- 模型定义参考[JSON架构草案4](https://tools.ietf.org/html/draft-zyp-json-schema-04?spm=a2c4g.11186623.2.10.2e977ff7p4BpQd)的规范'."\n"
.'- Json Schema只支持Object类型的元素属性。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifiedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\",\\n \\"Description\\": \\"Model Description\\",\\n \\"GroupId\\": \\"30e792398d6c4569b04c0e53a3494381\\",\\n \\"Schema\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"int64\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maximum\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"exclusiveMaximum\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"integer\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"maxLength\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\"}}}\\",\\n \\"ModelName\\": \\"Test\\",\\n \\"CreatedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"ModelId\\": \\"766c0b9538a04bdf974953b5576783ba\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ModelRef\\": \\"https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 766c0b9538a04bdf974953b5576783ba\\r\\n Model Description\\r\\n 2019-01-29T09:33:01Z\\r\\n Test\\r\\n 4173F95B-360C-460C-9F6C-4A960B904411\\r\\n {\\\\\\"type\\\\\\":\\\\\\"object\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"id\\\\\\":{\\\\\\"format\\\\\\":\\\\\\"int64\\\\\\",\\\\\\"maximum\\\\\\":100,\\\\\\"exclusiveMaximum\\\\\\":true,\\\\\\"type\\\\\\":\\\\\\"integer\\\\\\"},\\\\\\"name\\\\\\":{\\\\\\"maxLength\\\\\\":10,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}}\\"\\r\\n https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba\\r\\n 2019-01-29T09:33:01Z\\r\\n 30e792398d6c4569b04c0e53a3494381\\r\\n","errorExample":""}]',
],
'CreateMonitorGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94276',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的分组', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6735211ab9094c818f32f27bc545b6c8'],
],
[
'name' => 'RawMonitorGroupId',
'in' => 'query',
'schema' => ['description' => '监控组id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '166636221'],
],
[
'name' => 'Auth',
'in' => 'query',
'schema' => ['description' => 'api的认证状态,取值:-**ok**:成功。-**mismatch**:重定向。-**servicenotfound**:请求错误。-**unknown**:未知错误。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MonitorGroupId' => ['description' => 'api分组id,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'example' => '187421794'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '5D7136F7-9D67-5D4D-8418-6A512CCEE3A2'],
],
'description' => '',
],
],
],
'title' => '创建监控报警分组',
'summary' => '为指定API分组开启云监控报警。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '2', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CreateMonitorGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateMonitorGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MonitorGroupId\\": 187421794,\\n \\"RequestId\\": \\"5D7136F7-9D67-5D4D-8418-6A512CCEE3A2\\"\\n}","type":"json"}]',
],
'CreatePlugin' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94278',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginName',
'in' => 'query',
'schema' => ['description' => '插件名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NewCors'],
],
[
'name' => 'PluginType',
'in' => 'query',
'schema' => ['description' => '插件类型, 可选值:'."\n"
."\n"
.'- **ipControl**:IP访问控制'."\n"
.'- **trafficControl**:流量控制'."\n"
.'- **backendSignature**:后端签名'."\n"
.'- **jwtAuth**:JWT(OpenId Connect)'."\n"
.'- **cors**:CORS跨域资源访问'."\n"
.'- **caching**:缓存'."\n"
.'- **basicAuth**: Basic Auth'."\n"
.'- **routing**:后端路由'."\n"
.'- **accessControl**:参数访问控制'."\n"
.'- **errorMapping**:错误码映射'."\n"
.'- **circuitBreaker**:断路器(仅专享实例)'."\n"
.'- **remoteAuth**:第三方鉴权(仅专享实例)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cors'],
],
[
'name' => 'PluginData',
'in' => 'query',
'schema' => ['description' => '插件定义语句,支持json、yaml', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '---'."\n"
.'unit: SECOND '."\n"
.'apiDefault: 1000 '."\n"
.'userDefault: 30 '."\n"
.'appDefault: 30 '."\n"
.'specials: '."\n"
.' - type: "APP" '."\n"
.' policies:'."\n"
.' - key: 10123123 '."\n"
.' value: 10 '."\n"
.' - key: 10123123 '."\n"
.' value: 10'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,限200字以内', 'type' => 'string', 'required' => false, 'example' => 'createPlugin'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PluginId' => ['description' => '生成的插件ID', 'type' => 'string', 'example' => '1f3bde29b43d4d53989248327ff737f2'],
'TagStatus' => ['description' => '是否成功标记插件', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
'description' => '',
],
],
],
'title' => '创建API网关插件',
'summary' => '新建API网关插件。',
'description' => '- 此接口面向开放API的用户'."\n"
.'- 限制每个用户同一类型的插件可以创建的数量,不同类型,上限不同'."\n"
.'- 高级功能的插件定义限制使用'."\n"
.'- 插件创建后未绑定API前是无意义的,绑定API后,对绑定的API即时生效。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreatePlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PluginId\\": \\"1f3bde29b43d4d53989248327ff737f2\\",\\n \\"TagStatus\\": true,\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]',
],
'CreatePrivateDNS' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'IntranetDomain',
'in' => 'query',
'schema' => ['description' => '内网域名', 'type' => 'string', 'required' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '内网域名解析的类型'."\n"
.'- VPC:针对VPC授权解析,仅支持绑定传统类型专享实例;'."\n"
.'- A:支持创建A记录,仅支持绑定VPC融合类型专享实例',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'],
'example' => 'A',
],
],
[
'name' => 'Records',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '解析记录列表,仅Type取值为A时支持配置',
'type' => 'array',
'items' => [
'description' => '解析记录',
'type' => 'object',
'properties' => [
'Record' => ['description' => '解析记录值', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1'],
'Weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
'required' => false,
],
'required' => false,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建内网域名解析',
'summary' => '创建内网域名解析,添加解析记录',
'description' => '内网域名解析的取值为VPC时,仅支持绑定传统类型专享实例;'."\n"
.'内网域名解析的取值为A时,仅支持绑定VPC融合类型专享实例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreatePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]',
],
'CreateSignature' => [
'summary' => '创建后端签名密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94280',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureName',
'in' => 'query',
'schema' => ['description' => '密钥显示名称。支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符', 'type' => 'string', 'required' => true, 'example' => 'backendsignature'],
],
[
'name' => 'SignatureKey',
'in' => 'query',
'schema' => ['description' => '设置密钥的Key值。支持英文字母、数字、英文格式的下划线,必须以英文字母开头,6~20个字符', 'type' => 'string', 'required' => true, 'example' => 'qwertyuiop'],
],
[
'name' => 'SignatureSecret',
'in' => 'query',
'schema' => ['description' => '设置密钥的secret值。支持英文字母、数字、英文格式的下划线、及特殊字符(@、#、!、*),必须以英文字母开头,6~30个字符', 'type' => 'string', 'required' => true, 'example' => 'asdfghjkl'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'SignatureId' => ['description' => '后端签名密钥ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'SignatureName' => ['description' => '后端签名密钥名称', 'type' => 'string', 'example' => 'backendsignature'],
],
'description' => '',
],
],
],
'title' => '创建签名密钥',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 此功能效果仅是创建密钥策略,需要再调用绑定接口才能绑定到API上'."\n"
.'- 此密钥绑定到API后,网关到您后端服务的请求会带有签名字符串,您的后端服务可以自定义是否验证该签名字符串'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateSignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n dd05f1c54d6749eda95f9fa6d491449a\\r\\n backendsignature\\r\\n","errorExample":""}]',
],
'CreateStageModel' => [
'summary' => '创建环境模型',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'],
],
'parameters' => [
[
'name' => 'StageAlias',
'in' => 'query',
'schema' => ['description' => '环境别名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '生产环境'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '环境描述', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Model Description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'StageModelId' => ['description' => '环境配置ID', 'type' => 'string', 'example' => '39sdfjsd8fudsfxxx'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708xxxx'],
],
'description' => '',
],
],
],
'title' => '创建环境配置',
'description' => '- 模型定义参考[JSON架构草案4](https://tools.ietf.org/html/draft-zyp-json-schema-04?spm=a2c4g.11186623.2.10.2e977ff7p4BpQd)的规范'."\n"
.'- Json Schema只支持Object类型的元素属性。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StageModelId\\": \\"39sdfjsd8fudsfxxx\\",\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708xxxx\\"\\n}","type":"json"}]',
],
'CreateTrafficControl' => [
'summary' => '创建用户自定义的流控策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94281',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlName',
'in' => 'query',
'schema' => ['description' => '流控策略名称,支持大小写英文字母,中文,数字,下划线,长度4~50,且不能以下划线开头。', 'type' => 'string', 'required' => true, 'example' => 'Throttling test'],
],
[
'name' => 'TrafficControlUnit',
'in' => 'query',
'schema' => ['description' => '流控策略单位,可选值:'."\n"
."\n"
.'- **SECOND**:秒'."\n"
.'- **MINUTE**:分钟'."\n"
.'- **HOUR**:小时'."\n"
.'- **DAY**:天', 'type' => 'string', 'required' => true, 'example' => 'MINUTE'],
],
[
'name' => 'ApiDefault',
'in' => 'query',
'schema' => ['description' => '每个API默认流控值', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10000'],
],
[
'name' => 'UserDefault',
'in' => 'query',
'schema' => ['description' => '每个用户默认的流控值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'AppDefault',
'in' => 'query',
'schema' => ['description' => '每个app默认的流控值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '流控描述信息', 'type' => 'string', 'required' => false, 'example' => 'Throttling test description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TrafficControlId' => ['description' => '流控策略唯一ID', 'type' => 'string', 'example' => 'tf123456'],
'RequestId' => ['description' => '本次请求编号', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TrafficControlId\\": \\"tf123456\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n tf123456\\r\\n","errorExample":""}]',
'title' => '创建流控策略',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 策略创建后,未绑定API前是无意义的,绑定API后,对绑定的API即时生效'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrafficControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/*'],
],
],
],
],
],
'DeleteAccessControlList' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'删除访问控制策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-uf6fpfdg3b5muska7uqem'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
'description' => '',
],
],
],
'title' => '删除访问控制策略',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessControlList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAccessControlList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]',
],
'DeleteAllTrafficSpecialControl' => [
'summary' => '删除指定流控策略下用户所有自定义的特殊流控策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'tf123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'staticInfo' => [],
'title' => '删除所有特殊流控',
'description' => '- 此功能面向开放API的用户'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAllTrafficSpecialControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAllTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'DeleteApi' => [
'summary' => '删除指定的API定义。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 '],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ017'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ017\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ017 \\r\\n","errorExample":""}]',
'title' => '删除 API 定义',
'description' => '- 此功能面向开放API的用户,此操作不可逆'."\n"
.'- API在运行环境中运行,则不允许删除,需要先调用**AbolishApi**操作下线'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DeleteApiGroup' => [
'summary' => '删除指定的API分组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94285',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的键', 'type' => 'string', 'required' => true, 'example' => 'key'],
'Value' => ['description' => '标签的值', 'type' => 'string', 'required' => true, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99'],
],
'description' => '',
],
],
],
'title' => '删除 API 分组',
'description' => '- 此功能面向API提供者'."\n"
.'- 分组下存在API时,分组不可删除,须先删除分组下的API'."\n"
.'- 删除分组后,系统分配给此分组的二级域名自动生效'."\n"
.'- 删除不存在的分组时,会返回删除成功'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99\\"\\n}","type":"json"}]',
],
'DeleteApiProduct' => [
'summary' => '删除API产品,会自动删除API与API产品的绑定关系(如果存在API产品与APP的授权关系,将删除失败)',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\"\\n}","type":"json"}]',
'title' => '删除API产品',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiProduct'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteApiStageVariable' => [
'summary' => '删除指定环境的指定变量。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94286',
'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'StageId',
'in' => 'query',
'schema' => ['description' => '环境 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
],
[
'name' => 'VariableName',
'in' => 'query',
'schema' => ['description' => '变量名,区分大小写', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serverName'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB969B529'],
],
'description' => '',
],
],
],
'title' => '删除环境的指定变量',
'description' => '- 此功能面向API提供者'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiStageVariable'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiStageVariable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB969B529\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 03442A3D-3B7D-434C-8A95-A5FEB969B529\\r\\n","errorExample":""}]',
],
'DeleteApp' => [
'summary' => '删除指定APP。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP唯一编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110840611'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。最多20个元素。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'appname'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'testapp'],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'test2',
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
],
'description' => '',
],
],
],
'title' => '删除应用',
'description' => '- 此功能面向调用API的用户'."\n"
.'- 注意删除之后不可恢复,与API的授权关系也不可恢复'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n","errorExample":""}]',
],
'DeleteAppCode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '207739',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111265074'],
],
[
'name' => 'AppCode',
'in' => 'query',
'schema' => ['description' => '应用的APPCode编码', 'type' => 'string', 'required' => true, 'example' => '0d13f021c5cd4997831a9717e75b0663'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99'],
],
'description' => '',
],
],
],
'title' => '删除App的AppCode',
'summary' => '删除指定App的AppCode。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppCode'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99\\"\\n}","type":"json"}]',
],
'DeleteAppKey' => [
'summary' => '删除指定App的AppKey和AppSecret。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '207740',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110840611'],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'App的Key,用于调用API时使用', 'type' => 'string', 'required' => true, 'example' => '203708622'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '79EF055D-AC00-5161-8F35-6A36AAED7422'],
],
'description' => '',
],
],
],
'title' => '删除App的AppKey和AppSecret',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppKey'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAppKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EF055D-AC00-5161-8F35-6A36AAED7422\\"\\n}","type":"json"}]',
],
'DeleteBackend' => [
'summary' => '删除后端服务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '27be0dd9ebbc467b9e86c0d250d0b92e'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA'],
],
'description' => '',
],
],
],
'title' => '删除后端服务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackend'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\"\\n}","type":"json"}]',
],
'DeleteBackendModel' => [
'summary' => '删除后端服务在某个环境上的定义,删除后,使用该后端服务并发布在此环境上的API都会下线。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'BackendModelId',
'in' => 'query',
'schema' => ['description' => '后端模型 ID', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86'],
],
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端 ID', 'type' => 'string', 'required' => false, 'example' => '20bcdc9453524b78a8beb1f6de21edb7'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD'],
'OperationId' => ['description' => '操作ID。', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33'],
],
'description' => '',
],
],
],
'title' => '删除后端模型',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackendModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\",\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\"\\n}","type":"json"}]',
],
'DeleteDataset' => [
'summary' => '删除用户自定义数据集。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '048C8EFB-528F-5E97-8A3D-D17B********'],
],
'description' => '',
],
],
],
'title' => '删除数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"048C8EFB-528F-5E97-8A3D-D17B********\\"\\n}","type":"json"}]',
],
'DeleteDatasetItem' => [
'summary' => '删除用户自定义数据集的数据条目。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'."\n"],
],
[
'name' => 'DatasetItemId',
'in' => 'query',
'schema' => ['description' => '数据集条目ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5045****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'FF433E09-663A-5F5D-9DBA-A611********'],
],
'description' => '',
],
],
],
'title' => '删除数据集条目',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF433E09-663A-5F5D-9DBA-A611********\\"\\n}","type":"json"}]',
],
'DeleteDomain' => [
'summary' => '解除绑定在分组的自定义域名。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94289',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
],
'description' => '',
],
],
],
'title' => '删除域名',
'description' => '- 此功能面向API提供者。'."\n"
.'- 删除不存在的域名,会返回成功。'."\n"
.'- 删除域名将会影响API的访问,删除前请确认影响,谨慎操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomain'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\r\\n","errorExample":""}]',
],
'DeleteDomainCertificate' => [
'summary' => '删除指定域名的SSL证书。'."\n"
."\n"
.'此功能面向API提供者。'."\n"
.'删除不存在的SSL证书,会返回成功。'."\n"
.'指定的分组不存在,会报错:InvalidGroupId.NotFound。'."\n"
.'删除SSL证书后,将不能支持HTTPS访问,请谨慎操作。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94290',
'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'CertificateId',
'in' => 'query',
'schema' => ['description' => 'SSL证书ID,系统自动生成的SSL证书的唯一标识', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c621720d1eb34843822b7fb5148e6926'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
],
'description' => '',
],
],
],
'title' => '删除域名的SSL证书',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomainCertificate'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDomainCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]',
],
'DeleteInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94291',
'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-sh-ae502ee79ef8'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => true, 'example' => 'key'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => true, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4'],
],
'description' => '',
],
],
],
'title' => '删除实例',
'summary' => '删除API网关实例。本API仅能够删除后付费实例,预付费实例请通过控制台删除。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA4B3261-F14A-5E33-8608-F75A1DF27AD4\\"\\n}","type":"json"}]',
],
'DeleteIpControl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94292',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '删除IP访问控制',
'summary' => '删除某个已存在的IP访问控制。',
'description' => '- 此功能面向API提供者'."\n"
.'- 若该访问控制已经绑定了API,则需要先解除绑定才能操作删除,否则会报错'."\n"
.'- 删除一个不存在的IP访问控制,会直接返回成功',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIpControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'DeleteLogConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94293',
'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'],
],
'parameters' => [
[
'name' => 'LogType',
'in' => 'query',
'schema' => [
'description' => '日志类型,可选值:-**log**:日志-**survey**:质检日志',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'log',
'default' => 'PROVIDER',
'enum' => ['PROVIDER'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
],
'description' => '',
],
],
],
'title' => '删除日志配置',
'summary' => '删除指定的日志配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogConfig'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/{#LogType}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]',
],
'DeleteModel' => [
'summary' => '删除API分组的模型管理中的模型。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94294',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['description' => '模型的名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '模型所属的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411'],
],
'description' => '',
],
],
],
'title' => '删除已有模型',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4173F95B-360C-460C-9F6C-4A960B904411\\r\\n","errorExample":""}]',
],
'DeleteMonitorGroup' => [
'summary' => '删除API分组对应的云监控的应用分组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42925e7f5209438186d5560239af5286'],
],
[
'name' => 'RawMonitorGroupId',
'in' => 'query',
'schema' => ['description' => '监控组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '166636221'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C7E2CBAA-47FF-569F-AF12-B14B80E25422'],
],
'description' => '',
],
],
],
'title' => '删除监控分组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteMonitorGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7E2CBAA-47FF-569F-AF12-B14B80E25422\\"\\n}","type":"json"}]',
],
'DeletePlugin' => [
'summary' => '删除某个插件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94295',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => '指定要删除的API网关插件的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9a3f1a5279434f2ba74ccd91c295af9f'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'],
],
'description' => '',
],
],
],
'title' => '删除插件',
'description' => '- 此接口面向开放API的用户。'."\n"
.'- 必须先解除API和插件的绑定关系,否则删除报错。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeletePlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 46373DC4-19F1-4DC8-8C31-1107289BB5E0\\r\\n","errorExample":""}]',
],
'DeletePrivateDNS' => [
'summary' => '删除内网域名解析',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'IntranetDomain',
'in' => 'query',
'schema' => ['description' => '内网域名', 'type' => 'string', 'required' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '内网域名解析的类型'."\n"
.'- VPC:针对VPC授权解析,仅支持绑定传统类型专享实例;'."\n"
.'- A:支持创建A记录,仅支持绑定VPC融合类型专享实例',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'],
'example' => 'A',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制删除:'."\n"
.'- true:如果内网域名解析已经被实例关联,强制删除内网域名解析;'."\n"
.'- false:如果内网域名解析已经被实例关联,无法删除。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除内网域名解析',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeletePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]',
],
'DeleteSignature' => [
'summary' => '删除API网关后端签名密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94298',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定要删除的密钥ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]',
'title' => '删除后端签名密钥',
'changeSet' => [
['createdAt' => '2022-07-21T09:28:18.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteSignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteStageModel' => [
'summary' => '删除环境',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'StageModelId',
'in' => 'query',
'schema' => ['description' => '环境配置 ID', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '3294sdufo3nenexxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724xxx'],
],
'description' => '',
],
],
],
'title' => '删除环境配置',
'description' => '- 此功能面向API提供者'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724xxx\\"\\n}","type":"json"}]',
],
'DeleteTrafficControl' => [
'summary' => '删除指定的用户自定义流控策略,以及该策略包含的特殊流控策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94299',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'tf123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
'title' => '删除指定的用户自定义流控策略',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 若该策略已经绑定了API,则需要先解除绑定才能操作删除,否则会报错'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-21T09:28:18.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
],
],
'DeleteTrafficSpecialControl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94300',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'tf123456'],
],
[
'name' => 'SpecialType',
'in' => 'query',
'schema' => ['description' => '特殊流控类型,可选值:'."\n"
."\n"
.'- **APP**:应用'."\n"
.'- **USER**:用户', 'type' => 'string', 'required' => true, 'example' => 'APP'],
],
[
'name' => 'SpecialKey',
'in' => 'query',
'schema' => ['description' => '根据类型填写对应的AppId或者阿里云账号ID(账号ID请到[账号管理](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.343130a8sDi8cO#/secure)页面查看)', 'type' => 'string', 'required' => true, 'example' => '3382463'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '删除特殊流控',
'summary' => '删除指定的用户自定义特殊流控策略。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 接口需要用到的入参可以调用其他接口获取'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficSpecialControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'DeployApi' => [
'summary' => '发布API到指定的运行环境。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94302',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63be9002440b4778a61122f14c2b2bbb'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '运行环境名称,取值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '本次发布备注说明', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'for_test1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
],
'description' => '',
],
],
],
'title' => '发布 API',
'description' => '- 此功能面向开放API的用户,定义的API只有发布到运行环境,才能被调用'."\n"
.'- API发布到集群里需要一定的时间,最长5秒后生效'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DeployApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015 \\r\\n","errorExample":""}]',
],
'DescribeAbolishApiTask' => [
'summary' => '查询API下线任务的进度。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94303',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'OperationUid',
'in' => 'query',
'schema' => ['description' => '下线操作ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fc54****dd4c4***ad7edd7****39401'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99'],
'ApiAbolishResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiAbolishResult' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'StageId' => ['description' => '运行环境编号', 'type' => 'string', 'example' => '0919f2854a88484c91dc9253347c78f9'],
'AbolishStatus' => ['description' => '下线状态', 'type' => 'string', 'example' => 'OVER'],
'GroupId' => ['description' => 'API分组ID', 'type' => 'string', 'example' => '160cb6505e1c43a6b84346856d74eb47'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'wb2022021401619286'],
'ApiUid' => ['description' => 'API 唯一标识', 'type' => 'string', 'example' => '4e26cdbbb113416dba1f0285bed29979'],
'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Success. Request Success.'],
'StageName' => ['description' => '环境名称,枚举为:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'v2_page_consent'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API下线任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAbolishApiTask'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAbolishApiTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99\\",\\n \\"ApiAbolishResults\\": {\\n \\"ApiAbolishResult\\": [\\n {\\n \\"StageId\\": \\"0919f2854a88484c91dc9253347c78f9\\",\\n \\"AbolishStatus\\": \\"OVER\\",\\n \\"GroupId\\": \\"160cb6505e1c43a6b84346856d74eb47\\",\\n \\"GroupName\\": \\"wb2022021401619286\\",\\n \\"ApiUid\\": \\"4e26cdbbb113416dba1f0285bed29979\\",\\n \\"ErrorMsg\\": \\"Success. Request Success.\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"v2_page_consent\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeAccessControlListAttribute' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '142235',
'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'],
],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acl-3nsohdozz0ru8fi5onwz1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AclId' => ['description' => '访问控制策略ID。', 'type' => 'string', 'example' => 'acl-uf6fpfdg3b5muska7uqem'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'AclName' => ['description' => '访问控制策略名称。', 'type' => 'string', 'example' => 'testAcl'],
'AclEntrys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AclEntry' => [
'description' => '访问控制策略的信息列表。',
'type' => 'array',
'items' => [
'description' => '访问控制策略的信息列表。',
'type' => 'object',
'properties' => [
'AclEntryIp' => ['description' => '访问控制策略条目。', 'type' => 'string', 'example' => '192.168.1.0/24'],
'AclEntryComment' => ['description' => '访问控制条目备注。', 'type' => 'string', 'example' => 'default'],
],
],
],
],
'description' => '',
],
'AddressIPVersion' => ['description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', 'type' => 'string', 'example' => 'ipv4'],
],
'description' => '',
],
],
],
'title' => '查看访问控制策略详情',
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'查看访问控制策略详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlListAttribute'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAccessControlListAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AclId\\": \\"acl-uf6fpfdg3b5muska7uqem\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"AclName\\": \\"testAcl\\",\\n \\"AclEntrys\\": {\\n \\"AclEntry\\": [\\n {\\n \\"AclEntryIp\\": \\"192.168.1.0/24\\",\\n \\"AclEntryComment\\": \\"default\\"\\n }\\n ]\\n },\\n \\"AddressIPVersion\\": \\"ipv4\\"\\n}","type":"json"}]',
],
'DescribeAccessControlLists' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'查看访问控制策略列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '142234',
'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'],
],
'parameters' => [
[
'name' => 'AclName',
'in' => 'query',
'schema' => ['description' => '访问控制策略名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testAcl'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'AddressIPVersion',
'in' => 'query',
'schema' => ['description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', 'type' => 'string', 'required' => false, 'example' => 'ipv6'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'PageSize' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Acls' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Acl' => [
'description' => '访问控制策略组列表。',
'type' => 'array',
'items' => [
'description' => '访问控制策略组列表。',
'type' => 'object',
'properties' => [
'AclName' => ['description' => '访问控制策略名称。', 'type' => 'string', 'example' => 'testAcl'],
'AclId' => ['description' => '访问控制策略ID。', 'type' => 'string', 'example' => 'acl-3nsohdozz0ru8fi5onwz1'],
'AddressIPVersion' => ['description' => '访问控制策略组的IP版本。'."\n"
.'- **IPv4**。'."\n"
.'- **IPv6**。', 'type' => 'string', 'example' => 'ipv4'],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"Acls\\": {\\n \\"Acl\\": [\\n {\\n \\"AclName\\": \\"testAcl\\",\\n \\"AclId\\": \\"acl-3nsohdozz0ru8fi5onwz1\\",\\n \\"AddressIPVersion\\": \\"ipv4\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询访问控制策略列表',
'changeSet' => [
['createdAt' => '2022-11-28T06:29:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-09-21T09:16:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-21T09:13:37.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlLists'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAccessControlLists',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeApi' => [
'summary' => '查询指定API的定义。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94305',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API所在的分组编号', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API的ID标识', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8afff6c8c4c6447abb035812e4d66b65'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID标识', 'type' => 'string', 'example' => '8afff6c8c4c6447abb035812e4d66b65'],
'ResultType' => ['description' => '后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。', 'type' => 'string', 'example' => 'JSON'],
'WebSocketApiType' => ['description' => '双向通信API类型:'."\n"
."\n"
.'- **COMMON**:普通API'."\n"
.'- **REGISTER**:注册API'."\n"
.'- **UNREGISTER**:注销API'."\n"
.'- **NOTIFY**:下行通知', 'type' => 'string', 'example' => 'COMMON'],
'DisableInternet' => ['description' => 'API是否仅支持内网调用, 取值:'."\n"
."\n"
.'- **true**:仅支持内网调用API'."\n"
.'- **false**:不限制调用', 'type' => 'boolean', 'example' => 'false'],
'ResultBodyModel' => ['description' => 'api的返回结果', 'type' => 'string', 'example' => '{}'],
'ResultSample' => ['description' => '后端服务返回应答的示例', 'type' => 'string', 'example' => '200'],
'AppCodeAuthType' => ['description' => '当**AuthType**为**APP**认证时,可选值如下:'."\n"
."\n"
.'- **DEFAULT**: 不传默认是DEFAULT(随分组设置)'."\n"
.'- **DISABLE**: 不允许'."\n"
.'- **HEADER**: 允许AppCode的Header认证'."\n"
.'- **HEADER_QUERY**: 允许AppCode的Header及Query认证', 'type' => 'string', 'example' => 'HEADER'],
'AllowSignatureMethod' => ['description' => '当**AuthType**为**APP**认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256'],
'RegionId' => ['description' => 'API所处的Region的ID', 'type' => 'string', 'example' => 'cn-qingdao'],
'ForceNonceCheck' => ['description' => '调用API时是否必须携带header : X-Ca-Nonce, 这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后通过校验这个参数的有效性可以有效防止API的重放攻击,同样的值,15分内只能被使用一次。 取值:'."\n"
."\n"
.'- **true**: 请求API时强制检查这个字段,防止API的重放攻击'."\n"
.'- **false**: 不检查这个字段', 'type' => 'boolean', 'example' => 'true'],
'Visibility' => ['description' => 'API是否公开,目前可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境,会在所有用户的控制台“发现API”页面展示'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架', 'type' => 'string', 'example' => 'PUBLIC'],
'FailResultSample' => ['description' => '后端服务失败返回应答的示例', 'type' => 'string', 'example' => '400'],
'AuthType' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。'."\n"
.' - “ANONYMOUS”API不建议上架云市场,网关无法对调用者区分计量,也无法限制调用次数,若所在分组要上架云市场,建议将该API转移至其他分组,或将类型设置为“私有”,或选择“阿里云APP”认证方式。'."\n"
.'- **APPOPENID**:支持第三方账号认证OpenID Connect,而且只允许已授权的APP调用;当设置此项时,参数OpenIdConnectConfig为必传。', 'type' => 'string', 'example' => 'APP'],
'ModifiedTime' => ['description' => 'API最后一次修改的时间', 'type' => 'string', 'example' => '2016-07-28T13:13:12Z'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D0FF585F-7966-40CF-BC60-75DB070B23D5<'],
'Description' => ['description' => 'API描述信息', 'type' => 'string', 'example' => 'Api description'],
'GroupName' => ['description' => 'API所在的分组名称', 'type' => 'string', 'example' => 'ApiTest'],
'GroupId' => ['description' => 'API所在的分组编号', 'type' => 'string', 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
'Mock' => ['description' => '是否启用MOCK模式,目前可以取值:'."\n"
."\n"
.'- OPEN:启用Mock模式 '."\n"
."\n"
.'- CLOSED:不启用Mock模式', 'type' => 'string', 'example' => 'CLOSED'],
'MockResult' => ['description' => 'Mock返回结果', 'type' => 'string', 'example' => 'test result'],
'CreatedTime' => ['description' => 'API创建的时间', 'type' => 'string', 'example' => '2016-07-28T09:50:43Z'],
'ApiName' => ['description' => 'API的名称,组内不允许重复', 'type' => 'string', 'example' => 'ApiName'],
'BackendEnable' => ['description' => '是否启用后端服务', 'type' => 'boolean', 'example' => 'true'],
'BackendConfig' => [
'description' => '后端配置',
'type' => 'object',
'properties' => [
'BackendId' => ['description' => '后端服务ID', 'type' => 'string', 'example' => '0038e00c3dca44fcba3a94015d8f5bbf'],
'BackendType' => ['description' => '后端服务类型', 'type' => 'string', 'example' => 'HTTP'],
'BackendName' => ['description' => '后端服务名称', 'type' => 'string', 'example' => 'testoss'],
],
],
'RequestConfig' => [
'description' => 'Consumer向网关发送API请求的相关配置项',
'type' => 'object',
'properties' => [
'BodyModel' => ['description' => 'body模型', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab'],
'RequestPath' => ['description' => 'API path,比如API的完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,path是指`/object/add`这一部分。', 'type' => 'string', 'example' => '/api/billing/test/[type]'],
'RequestHttpMethod' => ['description' => 'HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'example' => 'POST'],
'BodyFormat' => ['description' => '当**RequestMode**值为**MAPPING**时有效。'."\n"
."\n"
.'POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:**FORM**、**STREAM**,分别表示表单形式(k-v对应)、字节流形式。', 'type' => 'string', 'example' => 'STREAM'],
'RequestMode' => ['description' => '请求的模式,取值为:**MAPPING**、**PASSTHROUGH**,分别表示入参映射、入参透传', 'type' => 'string', 'example' => 'MAPPING'],
'PostBodyDescription' => ['description' => 'Body描述', 'type' => 'string', 'example' => 'fwefwef'],
'RequestProtocol' => ['description' => 'API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS。', 'type' => 'string', 'example' => 'HTTP'],
'EscapePathParam' => ['description' => '是否转义Path参数,如果为true,则Path上的[param]将被视为普通字符。', 'type' => 'boolean', 'example' => 'true'],
],
],
'ServiceConfig' => [
'description' => '网关向后端服务发送API请求的相关配置项',
'type' => 'object',
'properties' => [
'AoneAppName' => ['description' => 'aone应用名称', 'type' => 'string', 'example' => 'ib-blank'],
'MockStatusCode' => ['description' => 'Mock返回状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ContentTypeValue' => ['description' => '调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'],
'ServiceProtocol' => ['description' => '后端服务协议类型,目前只支持HTTP/HTTPS', 'type' => 'string', 'example' => 'HTTP'],
'ServicePath' => ['description' => '调用后端服务path,比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,**ServicePath**是指`/object/add`这一部分。', 'type' => 'string', 'example' => '/object/add'],
'ContentTypeCatagory' => ['description' => '调用后端服务HTTP服务时,ContentType头的取值策略:'."\n"
."\n"
.'- **DEFAULT**:使用API网关默认的值'."\n"
.'- **CUSTOM**:自定义'."\n"
.'- **CLIENT**:使用客户端上行的ContentType的头', 'type' => 'string', 'example' => 'CUSTOM'],
'ServiceAddress' => ['description' => '调用后端服务地址,比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,**ServiceAddress**是指`http://api.a.com:8080`这一部分。', 'type' => 'string', 'example' => 'http://api.a.com:8080'],
'Mock' => ['description' => '是否采取Mock模式,目前可以取值:'."\n"
."\n"
.'- **TRUE**:启用Mock模式'."\n"
.'- **FALSE**:不启用Mock模式', 'type' => 'string', 'example' => 'TRUE'],
'ServiceVpcEnable' => ['description' => '是否启用VPC通道,目前可以取值:'."\n"
."\n"
.'- **TRUE**:启用VPC通道,必须先添加VPC授权成功后才能启用'."\n"
.'- **FALSE**:不启用VPC通', 'type' => 'string', 'example' => 'TRUE'],
'MockResult' => ['description' => '如果启用Mock模式,返回的结果', 'type' => 'string', 'example' => 'test result'],
'ServiceHttpMethod' => ['description' => '调用后端服务HTTP协议时的Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'example' => 'POST'],
'ServiceTimeout' => ['description' => '后端服务超时时间,单位:毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'MockHeaders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MockHeader' => [
'description' => '模拟 Headers',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HeaderValue' => ['description' => 'HTTP头参数的取值。', 'type' => 'string', 'example' => '86400'],
'HeaderName' => ['description' => 'HTTP头参数的名字。', 'type' => 'string', 'example' => 'Content-Length'],
],
'description' => '',
],
],
],
'description' => '',
],
'VpcConfig' => [
'description' => 'VPC通道相关配置项',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***'],
'VpcScheme' => ['description' => 'VPC协议', 'type' => 'string', 'example' => 'HTTP'],
'InstanceId' => ['description' => '专用网络中的实例ID(Ecs/负载均衡)', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***'],
'Port' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'],
'Name' => ['description' => 'VPC授权名称', 'type' => 'string', 'example' => 'glmall-app-test'],
],
],
'FunctionComputeConfig' => [
'description' => '后端为函数计算时的后端配置项',
'type' => 'object',
'properties' => [
'FcType' => ['description' => '函数计算服务类型', 'type' => 'string', 'example' => 'HttpTrigger'],
'RoleArn' => ['description' => 'Ram授权给API网关访问函数计算的arn', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas'],
'Method' => ['description' => '请求方法。', 'type' => 'string', 'example' => 'GET'],
'FcBaseUrl' => ['description' => '函数计算服务根路径', 'type' => 'string', 'example' => 'https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/'],
'ContentTypeValue' => ['description' => '调用后端服务函数计算服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'],
'RegionId' => ['description' => '函数计算所在Region', 'type' => 'string', 'example' => 'cn-qingdao'],
'OnlyBusinessPath' => ['description' => '后端只接收业务path', 'type' => 'boolean', 'example' => 'false'],
'FunctionName' => ['description' => '函数计算定义的FunctionName', 'type' => 'string', 'example' => 'edge_function'],
'ContentTypeCatagory' => ['description' => '调用后端服务函数计算服务时,ContentType头的取值策略:'."\n"
."\n"
.'- **DEFAULT**:使用API网关默认的值'."\n"
.'- **CUSTOM**:自定义'."\n"
.'- **CLIENT**:使用客户端上行的ContentType的头', 'type' => 'string', 'example' => 'DEFAULT'],
'Path' => ['description' => 'API请求路径', 'type' => 'string', 'example' => '/api/offline/cacheData'],
'ServiceName' => ['description' => '函数计算定义的ServiceName', 'type' => 'string', 'example' => 'fcservicename'],
'Qualifier' => ['description' => '函数别名', 'type' => 'string', 'example' => '2'],
'TriggerName' => ['type' => 'string', 'description' => ''],
'FcVersion' => ['type' => 'string', 'description' => ''],
],
],
'OssConfig' => [
'description' => '后端为OSS的信息',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'OSS内存储对象或文件夹路径', 'type' => 'string', 'example' => '/folder/test.json'],
'Action' => ['description' => 'OSS的操作,目前可以取值'."\n"
.' - GetObject'."\n"
.' - PostObject'."\n"
.' - DeleteObject'."\n"
.' - PutObject'."\n"
.' - HeadObject'."\n"
.' - GetObjectMeta'."\n"
.' - AppendObject', 'type' => 'string', 'example' => 'GetObject'],
'OssRegionId' => ['description' => 'OSS服务所在地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'BucketName' => ['description' => 'OSS存储Bucket。', 'type' => 'string', 'example' => 'cbg-db'],
],
],
'EventBridgeConfig' => [
'description' => '事件总线设置',
'type' => 'object',
'properties' => [
'EventBus' => ['description' => '事件总线', 'type' => 'string', 'example' => 'testBus'],
'EventSource' => ['description' => '事件来源。'."\n", 'type' => 'string', 'example' => 'baas_driver'],
'EventBridgeRegionId' => ['description' => '事件总线服务所在区域ID', 'type' => 'string', 'example' => 'cn-beijing'],
'RoleArn' => ['description' => 'Ram授权给EventBridge的arn', 'type' => 'string', 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun'],
],
],
],
],
'OpenIdConnectConfig' => [
'description' => '第三方账号认证OpenID Connect相关配置项',
'type' => 'object',
'properties' => [
'OpenIdApiType' => ['description' => 'OpenID Connect模式,目前可以取值:'."\n"
."\n"
.'- **IDTOKEN**:获取授权API,颁发Token,当设置此项时,参数PublicKeyId和PublicKey为必传。'."\n"
.'- **BUSINESS**:业务API,Token验证,当设置此项时,参数IdTokenParamName为必传。', 'type' => 'string', 'example' => 'IDTOKEN'],
'IdTokenParamName' => ['description' => 'Token对应的参数名称', 'type' => 'string', 'example' => 'xxx'],
'PublicKeyId' => ['description' => '公钥ID', 'type' => 'string', 'example' => '88483727556929326703309904351185815489'],
'PublicKey' => ['description' => '公钥', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92'],
],
],
'ErrorCodeSamples' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ErrorCodeSample' => [
'description' => '后端服务返回的错误码示例',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码', 'type' => 'string', 'example' => '400'],
'Model' => ['description' => '模型', 'type' => 'string', 'example' => '[\\"*\\"]'],
'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Missing the parameter UserId'],
'Description' => ['description' => '描述', 'type' => 'string', 'example' => 'Missing parameter UserId'],
],
'description' => '',
],
],
],
'description' => '',
],
'SystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SystemParameter' => [
'description' => '网关发送给后端服务的系统参数',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'Client IP'],
'ParameterName' => ['description' => '系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。', 'type' => 'string', 'example' => 'CaClientIp'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'CustomSystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomSystemParameter' => [
'description' => '自定义系统参数列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => '客户端IP'],
'ParameterName' => ['description' => '系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy', 'type' => 'string', 'example' => 'CaClientIp'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ConstantParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConstantParameter' => [
'description' => '网关发送给后端服务的常量参数',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'constance'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'constance'],
'ConstantValue' => ['description' => '参数值', 'type' => 'string', 'example' => 'constance'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestParameter' => [
'description' => 'Consumer向网关发送API请求的参数描述',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JsonScheme' => ['description' => '当**ParameterType**=String,JSON验证(Json Scheme)', 'type' => 'string', 'example' => 'JSON'],
'MaxValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最大值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'ArrayItemsType' => ['description' => '数组元素的类型', 'type' => 'string', 'example' => 'String'],
'MinValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最小值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocShow' => ['description' => '文档可见,取值为:**PUBLIC**、**PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC'],
'MaxLength' => ['description' => '当**ParameterType**=String,参数的最大长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DefaultValue' => ['description' => '默认值', 'type' => 'string', 'example' => '20'],
'ApiParameterName' => ['description' => '参数名', 'type' => 'string', 'example' => 'age'],
'EnumValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。', 'type' => 'string', 'example' => 'boy,girl'],
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '20'],
'Required' => ['description' => '是否必填,取值为:**REQUIRED**、**OPTIONAL**,分别表示必填、不必填', 'type' => 'string', 'example' => 'OPTIONAL'],
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'age'],
'ParameterType' => ['description' => '参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。', 'type' => 'string', 'example' => 'String'],
'RegularExpression' => ['description' => '当**ParameterType**=String,参数验证(正则表达式)', 'type' => 'string', 'example' => 'xxx'],
'MinLength' => ['description' => '当**ParameterType**=String,参数的最小长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocOrder' => ['description' => '文档中顺序', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameter' => [
'description' => '网关向后端服务发送API请求的参数描述',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ParameterType' => ['description' => '后端参数数据类型,取值为:STRING、NUMBER、BOOLEAN,分别表示字符、数值、布尔。', 'type' => 'string', 'example' => 'String'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParametersMap' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameterMap' => [
'description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RequestParameterName' => ['description' => '对应前端入参名称,这个值必须存在于RequestParametersObject中,匹配于RequestParam.ApiParameterName。', 'type' => 'string', 'example' => 'name'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'name'],
],
'description' => '',
],
],
],
'description' => '',
],
'DeployedInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeployedInfo' => [
'description' => 'API发布状态',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StageName' => ['description' => '环境名称,取值为:RELEASE、TEST', 'type' => 'string', 'example' => 'RELEASE'],
'EffectiveVersion' => ['description' => '有效的版本', 'type' => 'string', 'example' => 'xxx'],
'DeployedStatus' => ['description' => '部署状态,取值为:DEPLOYED、NONDEPLOYED,分别表示已部署、未部署', 'type' => 'string', 'example' => 'DEPLOYED'],
],
'description' => '',
],
],
],
'description' => '',
],
'TagList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'APP'],
'TagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'value3'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"8afff6c8c4c6447abb035812e4d66b65\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"WebSocketApiType\\": \\"COMMON\\",\\n \\"DisableInternet\\": false,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"200\\",\\n \\"AppCodeAuthType\\": \\"HEADER\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"400\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"ModifiedTime\\": \\"2016-07-28T13:13:12Z\\",\\n \\"RequestId\\": \\"D0FF585F-7966-40CF-BC60-75DB070B23D5<\\",\\n \\"Description\\": \\"Api description\\",\\n \\"GroupName\\": \\"ApiTest\\",\\n \\"GroupId\\": \\"08ae4aa0f95e4321849ee57f4e0b3077\\",\\n \\"Mock\\": \\"CLOSED\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"CreatedTime\\": \\"2016-07-28T09:50:43Z\\",\\n \\"ApiName\\": \\"ApiName\\",\\n \\"BackendEnable\\": true,\\n \\"BackendConfig\\": {\\n \\"BackendId\\": \\"0038e00c3dca44fcba3a94015d8f5bbf\\",\\n \\"BackendType\\": \\"HTTP\\",\\n \\"BackendName\\": \\"testoss\\"\\n },\\n \\"RequestConfig\\": {\\n \\"BodyModel\\": \\"https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab\\",\\n \\"RequestPath\\": \\"/api/billing/test/[type]\\",\\n \\"RequestHttpMethod\\": \\"POST\\",\\n \\"BodyFormat\\": \\"STREAM\\",\\n \\"RequestMode\\": \\"MAPPING\\",\\n \\"PostBodyDescription\\": \\"fwefwef\\",\\n \\"RequestProtocol\\": \\"HTTP\\",\\n \\"EscapePathParam\\": true\\n },\\n \\"ServiceConfig\\": {\\n \\"AoneAppName\\": \\"ib-blank\\",\\n \\"MockStatusCode\\": 200,\\n \\"ContentTypeValue\\": \\"application/x-www-form-urlencoded; charset=UTF-8\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePath\\": \\"/object/add\\",\\n \\"ContentTypeCatagory\\": \\"CUSTOM\\",\\n \\"ServiceAddress\\": \\"http://api.a.com:8080\\",\\n \\"Mock\\": \\"TRUE\\",\\n \\"ServiceVpcEnable\\": \\"TRUE\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"ServiceHttpMethod\\": \\"POST\\",\\n \\"ServiceTimeout\\": 1000,\\n \\"MockHeaders\\": {\\n \\"MockHeader\\": [\\n {\\n \\"HeaderValue\\": \\"86400\\",\\n \\"HeaderName\\": \\"Content-Length\\"\\n }\\n ]\\n },\\n \\"VpcConfig\\": {\\n \\"VpcId\\": \\"vpc-2zeafsc3fygk1***\\",\\n \\"VpcScheme\\": \\"HTTP\\",\\n \\"InstanceId\\": \\"i-bp1h497hkijewv2***\\",\\n \\"Port\\": 8080,\\n \\"Name\\": \\"glmall-app-test\\"\\n },\\n \\"FunctionComputeConfig\\": {\\n \\"FcType\\": \\"HttpTrigger\\",\\n \\"RoleArn\\": \\"acs:ram::111***:role/aliyunserviceroleforsas\\",\\n \\"Method\\": \\"GET\\",\\n \\"FcBaseUrl\\": \\"https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/\\",\\n \\"ContentTypeValue\\": \\"application/x-www-form-urlencoded; charset=UTF-8\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"OnlyBusinessPath\\": false,\\n \\"FunctionName\\": \\"edge_function\\",\\n \\"ContentTypeCatagory\\": \\"DEFAULT\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"ServiceName\\": \\"fcservicename\\",\\n \\"Qualifier\\": \\"2\\",\\n \\"TriggerName\\": \\"\\",\\n \\"FcVersion\\": \\"\\"\\n },\\n \\"OssConfig\\": {\\n \\"Key\\": \\"/folder/test.json\\",\\n \\"Action\\": \\"GetObject\\",\\n \\"OssRegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"cbg-db\\"\\n },\\n \\"EventBridgeConfig\\": {\\n \\"EventBus\\": \\"testBus\\",\\n \\"EventSource\\": \\"baas_driver\\",\\n \\"EventBridgeRegionId\\": \\"cn-beijing\\",\\n \\"RoleArn\\": \\"acs:ram::1933122015759***:role/adminoidcaliyun\\"\\n }\\n },\\n \\"OpenIdConnectConfig\\": {\\n \\"OpenIdApiType\\": \\"IDTOKEN\\",\\n \\"IdTokenParamName\\": \\"xxx\\",\\n \\"PublicKeyId\\": \\"88483727556929326703309904351185815489\\",\\n \\"PublicKey\\": \\"EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92\\"\\n },\\n \\"ErrorCodeSamples\\": {\\n \\"ErrorCodeSample\\": [\\n {\\n \\"Code\\": \\"400\\",\\n \\"Model\\": \\"[\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\"]\\",\\n \\"Message\\": \\"Missing the parameter UserId\\",\\n \\"Description\\": \\"Missing parameter UserId\\"\\n }\\n ]\\n },\\n \\"SystemParameters\\": {\\n \\"SystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"Client IP\\",\\n \\"ParameterName\\": \\"CaClientIp\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"CustomSystemParameters\\": {\\n \\"CustomSystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"客户端IP\\",\\n \\"ParameterName\\": \\"CaClientIp\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ConstantParameters\\": {\\n \\"ConstantParameter\\": [\\n {\\n \\"Description\\": \\"constance\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"constance\\",\\n \\"ConstantValue\\": \\"constance\\"\\n }\\n ]\\n },\\n \\"RequestParameters\\": {\\n \\"RequestParameter\\": [\\n {\\n \\"JsonScheme\\": \\"JSON\\",\\n \\"MaxValue\\": 123456,\\n \\"ArrayItemsType\\": \\"String\\",\\n \\"MinValue\\": 123456,\\n \\"DocShow\\": \\"PUBLIC\\",\\n \\"MaxLength\\": 123456,\\n \\"DefaultValue\\": \\"20\\",\\n \\"ApiParameterName\\": \\"age\\",\\n \\"EnumValue\\": \\"boy,girl\\",\\n \\"DemoValue\\": \\"20\\",\\n \\"Required\\": \\"OPTIONAL\\",\\n \\"Description\\": \\"age\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"RegularExpression\\": \\"xxx\\",\\n \\"MinLength\\": 123456,\\n \\"DocOrder\\": 0,\\n \\"Location\\": \\"HEAD\\"\\n }\\n ]\\n },\\n \\"ServiceParameters\\": {\\n \\"ServiceParameter\\": [\\n {\\n \\"Location\\": \\"HEAD\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ServiceParametersMap\\": {\\n \\"ServiceParameterMap\\": [\\n {\\n \\"RequestParameterName\\": \\"name\\",\\n \\"ServiceParameterName\\": \\"name\\"\\n }\\n ]\\n },\\n \\"DeployedInfos\\": {\\n \\"DeployedInfo\\": [\\n {\\n \\"StageName\\": \\"RELEASE\\",\\n \\"EffectiveVersion\\": \\"xxx\\",\\n \\"DeployedStatus\\": \\"DEPLOYED\\"\\n }\\n ]\\n },\\n \\"TagList\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"APP\\",\\n \\"TagValue\\": \\"value3\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询 API 定义',
'description' => '- 此接口面向开放API的用户'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApiDoc' => [
'summary' => '查询指定API的服务说明文档。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94306',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试'."\n"
."\n"
.'若不传入,则默认为release。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RELEASE', 'default' => 'release'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => 'b24be7e59a104e52bffbf432cc9272af'],
'ResultType' => ['description' => '返回类型', 'type' => 'string', 'example' => 'JSON'],
'DisableInternet' => ['description' => '- 设置**DisableInternet**为**true**, 仅支持内网调用API。'."\n"
.'- 设置**DisableInternet**为**false**, 则不限制调用。创建API时默认为false。', 'type' => 'boolean', 'example' => 'true'],
'ResultSample' => ['description' => '返回示例', 'type' => 'string', 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}'],
'RegionId' => ['description' => 'API分组所在的地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ForceNonceCheck' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
."\n"
.'- 设置**ForceNonceCheck**为**false**,则不检查。创建API时默认为false。', 'type' => 'boolean', 'example' => 'true'],
'Visibility' => ['description' => '可见性,取值为:**PUBLIC**、**PRIVATE**,分别表示公开、私有', 'type' => 'string', 'example' => 'PUBLIC'],
'FailResultSample' => ['description' => '后端服务失败返回应答的示例', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}'],
'AuthType' => ['description' => '安全认证方式,取值为:APP、ANONYMOUS,分别表示阿里云APP、匿名', 'type' => 'string', 'example' => 'APP'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F253FB5F-9AE1-5DDA-99B5-46BE00A3719E'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => 'f51d08c5b7c84342905544ebaec26d35'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'Membership era trading service'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Lynk&Co Digital Mall OMS-UAT'],
'DeployedTime' => ['description' => '发布时间', 'type' => 'string', 'example' => '2022-07-13T16:00:33Z'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'Get keyword QR code URL'],
'RequestConfig' => [
'description' => '由 RequestConfig 组成的格式,返回API前端定义信息',
'type' => 'object',
'properties' => [
'RequestPath' => ['description' => 'API path,比如API的完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,path是指`/object/add`这一部分。', 'type' => 'string', 'example' => '/api/billing/test/[type]'],
'RequestHttpMethod' => ['description' => 'HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'example' => 'POST'],
'BodyFormat' => ['description' => '当**RequestMode**值为**MAPPING**时有效。'."\n"
."\n"
.'POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:**FORM**、**STREAM**,分别表示表单形式(k-v对应)、字节流形式。', 'type' => 'string', 'example' => 'STREAM'],
'RequestMode' => ['description' => '入参请求的模式,取值为:'."\n"
."\n"
.'- MAPPING:入参映射(过滤未知参数)'."\n"
."\n"
.'- PASSTHROUGH:入参透传'."\n"
."\n"
.'- MAPPING_PASSTHROUGH:入参映射(透传未知参数)', 'type' => 'string', 'example' => 'MAPPING'],
'PostBodyDescription' => ['description' => 'Body描述', 'type' => 'string', 'example' => 'fwefwef'],
'RequestProtocol' => ['description' => 'API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS。', 'type' => 'string', 'example' => 'HTTP'],
'EscapePathParam' => ['description' => '是否转义Path参数,如果为true,则Path上的[param]将被视为普通字符。', 'type' => 'boolean', 'example' => 'true'],
],
],
'ErrorCodeSamples' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ErrorCodeSample' => [
'description' => '后端服务返回的错误码示例',
'type' => 'array',
'items' => [
'description' => '后端服务返回的错误码示例',
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码', 'type' => 'string', 'example' => 'Error'],
'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'error message'],
'Description' => ['description' => '错误码描述', 'type' => 'string', 'example' => 'Unauthorized'],
],
],
],
],
'description' => '',
],
'RequestParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestParameter' => [
'description' => '由 RequestParameter 组成的数组格式,返回API中前端入参信息项',
'type' => 'array',
'items' => [
'description' => '由 RequestParameter 组成的数组格式,返回API中前端入参信息项',
'type' => 'object',
'properties' => [
'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}'],
'MaxValue' => ['description' => '最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'ArrayItemsType' => ['description' => '数组元素的类型', 'type' => 'string', 'example' => 'String'],
'MinValue' => ['description' => '最小值', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocShow' => ['description' => '文档可见,取值为:**PUBLIC**、**PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC'],
'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DefaultValue' => ['description' => '默认值', 'type' => 'string', 'example' => '20'],
'ApiParameterName' => ['description' => 'API 参数名称', 'type' => 'string', 'example' => 'Length'],
'EnumValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。', 'type' => 'string', 'example' => 'boy,girl'],
'DemoValue' => ['description' => '示例值', 'type' => 'string', 'example' => '20'],
'Required' => ['description' => '是否必填', 'type' => 'string', 'example' => 'OPTIONAL'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Parameter description'],
'ParameterType' => ['description' => '参数类型', 'type' => 'string', 'example' => 'String'],
'RegularExpression' => ['description' => '当**ParameterType**=String,参数验证(正则表达式)', 'type' => 'string', 'example' => 'xxx'],
'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'DocOrder' => ['description' => '文档中顺序', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"b24be7e59a104e52bffbf432cc9272af\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"DisableInternet\\": true,\\n \\"ResultSample\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"status\\\\\\\\\\\\\\": 0,\\\\\\\\n \\\\\\\\\\\\\\"data\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 1,\\\\\\\\n \\\\\\\\\\\\\\"list\\\\\\\\\\\\\\": [\\\\\\\\n \\\\\\\\\\\\\\"352\\\\\\\\\\\\\\"\\\\\\\\n ]\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"success\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"F253FB5F-9AE1-5DDA-99B5-46BE00A3719E\\",\\n \\"GroupId\\": \\"f51d08c5b7c84342905544ebaec26d35\\",\\n \\"GroupName\\": \\"Membership era trading service\\",\\n \\"Description\\": \\"Lynk&Co Digital Mall OMS-UAT\\",\\n \\"DeployedTime\\": \\"2022-07-13T16:00:33Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"Get keyword QR code URL\\",\\n \\"RequestConfig\\": {\\n \\"RequestPath\\": \\"/api/billing/test/[type]\\",\\n \\"RequestHttpMethod\\": \\"POST\\",\\n \\"BodyFormat\\": \\"STREAM\\",\\n \\"RequestMode\\": \\"MAPPING\\",\\n \\"PostBodyDescription\\": \\"fwefwef\\",\\n \\"RequestProtocol\\": \\"HTTP\\",\\n \\"EscapePathParam\\": true\\n },\\n \\"ErrorCodeSamples\\": {\\n \\"ErrorCodeSample\\": [\\n {\\n \\"Code\\": \\"Error\\",\\n \\"Message\\": \\"error message\\",\\n \\"Description\\": \\"Unauthorized\\"\\n }\\n ]\\n },\\n \\"RequestParameters\\": {\\n \\"RequestParameter\\": [\\n {\\n \\"JsonScheme\\": \\"{}\\",\\n \\"MaxValue\\": 200,\\n \\"ArrayItemsType\\": \\"String\\",\\n \\"MinValue\\": 123456,\\n \\"DocShow\\": \\"PUBLIC\\",\\n \\"MaxLength\\": 123456,\\n \\"DefaultValue\\": \\"20\\",\\n \\"ApiParameterName\\": \\"Length\\",\\n \\"EnumValue\\": \\"boy,girl\\",\\n \\"DemoValue\\": \\"20\\",\\n \\"Required\\": \\"OPTIONAL\\",\\n \\"Description\\": \\"Parameter description\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"RegularExpression\\": \\"xxx\\",\\n \\"MinLength\\": 2,\\n \\"DocOrder\\": 0,\\n \\"Location\\": \\"HEAD\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询API说明文档',
'description' => '- 此功能面向调用API的用户,指定的API必须是发布到运行环境,且**Visibility**=**PUBLIC**的API或者被授权的**Visibility**=**PRIVATE**的API'."\n"
.'- 若您是调用API的用户,该接口返回您指定的API的服务信息及参数定义等详情信息。'."\n"
.'- 若您是开放API的用户,那么调用该接口可以查看当前指定API在指定环境中运行的定义,可能与您现在修改中的API定义不同,是真正在环境中生效的定义。'."\n"
.'- 若您是开放API的用户,由于该接口面向API调用者鉴权,所以您需要确认该API为PUBLIC类型或者您的相关APP已被授权。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiDoc'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiDoc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApiGroup' => [
'summary' => '查询API分组的详情信息,包含分组系统自动生成的二级域名、自定义域名及SSL证书信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94311',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'description' => '标签',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'appname'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'test_app'],
],
'required' => false,
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '分组状态'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **DELETE**:删除', 'type' => 'string', 'example' => 'NORMAL'],
'CompatibleFlags' => ['description' => '关联的标签列表,多个用逗号(,)分隔', 'type' => 'string', 'example' => 'depart:dep1'],
'BasePath' => ['description' => 'api根路径', 'type' => 'string', 'example' => '/qqq'],
'Ipv6Status' => ['description' => 'ipv6状态', 'type' => 'string', 'example' => 'UNBIND'],
'UserLogConfig' => ['description' => '用户日志设置', 'type' => 'string', 'example' => '{\\"requestBody\\":true,\\"responseBody\\":true,\\"queryString\\":\\"test\\",\\"requestHeaders\\":\\"test\\",\\"responseHeaders\\":\\"test\\",\\"jwtClaims\\":\\"test\\"}'],
'CustomerConfigs' => ['description' => '自定义配置项列表', 'type' => 'string', 'example' => 'removeResponseServerHeader'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519'],
'Description' => ['description' => 'API分组描述', 'type' => 'string', 'example' => 'New weather informations.'],
'HttpsPolicy' => ['description' => 'https策略', 'type' => 'string', 'example' => 'HTTPS2_TLS1_0'],
'SubDomain' => ['description' => '系统为分组分配的二级域名', 'type' => 'string', 'example' => '27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2016-08-01T06:53:02Z'],
'DefaultDomain' => ['description' => '默认域名', 'type' => 'string', 'example' => 'mkt.api.gaore.com'],
'CmsMonitorGroup' => ['description' => '云监控应用分组', 'type' => 'string', 'example' => '217008423'],
'BillingStatus' => ['description' => '计费状态'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **LOCKED**:欠费锁定', 'type' => 'string', 'example' => 'NORMAL'],
'TrafficLimit' => ['description' => '分组最高QPS限制,默认500,可申请提高', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
'PassthroughHeaders' => ['description' => '透传 Headers', 'type' => 'string', 'example' => 'eagleeye-rpcid,x-b3-traceid'],
'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'apigateway-cn-v6419k43xxxxx'],
'VpcDomain' => ['description' => 'vpc域名', 'type' => 'string', 'example' => 'e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com'],
'InstanceType' => ['description' => '实例类型'."\n"
.'- CLASSIC_SHARED:共享实例经典网络'."\n"
.'- VPC_SHARED:共享实例(VPC)'."\n"
.'- VPC_DEDICATED:专享实例(VPC)', 'type' => 'string', 'example' => 'VPC_SHARED'],
'CustomTraceConfig' => ['description' => '自定义trace配置', 'type' => 'string', 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}'],
'RegionId' => ['description' => '分组所在区域', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2016-08-01T06:54:32Z'],
'GroupId' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'NewWeather'],
'IllegalStatus' => ['description' => '违法锁定'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **LOCKED**:违法锁定', 'type' => 'string', 'example' => 'NORMAL'],
'VpcSlbIntranetDomain' => ['description' => '内网VPC SLB域名', 'type' => 'string', 'example' => '257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com'],
'CustomDomains' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainItem' => [
'description' => '自定义域名信息',
'type' => 'array',
'items' => [
'description' => '自定义域名信息',
'type' => 'object',
'properties' => [
'BindStageName' => ['description' => '绑定的运行环境名称'."\n", 'type' => 'string', 'example' => 'TEST'],
'DomainLegalStatus' => ['description' => '域名合法状态,取值:'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **ABNORMAL**:异常,该状态会影响API调用,需尽快解决', 'type' => 'string', 'example' => 'ABNORMAL'],
'CertificateName' => ['description' => 'SSL证书名称', 'type' => 'string', 'example' => 'myCertificate'],
'CustomDomainType' => ['description' => '自定义域名类型', 'type' => 'string', 'example' => 'intranet'],
'DomainCNAMEStatus' => ['description' => '域名解析情况,取值:'."\n"
."\n"
.'- **RESOLVED**:已解析'."\n"
.'- **UNRESOLVED**:未解析', 'type' => 'string', 'example' => 'RESOLVED'],
'WildcardDomainPatterns' => ['description' => '通配域名模式', 'type' => 'string', 'example' => '[\\"{test}.test.com\\"]'],
'DomainBindingStatus' => ['description' => '自定义域名绑定状态,取值:'."\n"
."\n"
.'- **BINDING**:正常'."\n"
.'- **BOUND**:未生效', 'type' => 'string', 'example' => 'BINDING'],
'DomainName' => ['description' => '域名名称', 'type' => 'string', 'example' => 'api.demo.com'],
'DomainRemark' => ['description' => '域名相关备注,如描述域名异常状态原因', 'type' => 'string', 'example' => 'The domain name is not registered.'],
'DomainWebSocketStatus' => ['description' => '使用WebSocket功能的域名状态', 'type' => 'string', 'example' => 'CLOSE'],
'CertificateId' => ['description' => 'SSL证书ID,系统自动生成唯一编号', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
'IsHttpRedirectToHttps' => ['description' => '是否将http重定向到https', 'type' => 'boolean', 'example' => 'false'],
'CertificateValidStart' => ['description' => '证书生效时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1689043476000'],
'CertificateValidEnd' => ['description' => '证书失效时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2635123476000'],
'BindStageAlias' => ['description' => '绑定的运行环境别名', 'type' => 'string', 'example' => 'TEST1'],
'SslVerifyDepth' => ['description' => '证书验证深度', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'SslOcspEnable' => ['description' => '是否支持OCSP验证', 'type' => 'boolean', 'example' => 'true'],
'SslOcspCacheEnable' => ['description' => '是否支持OCSP缓存', 'type' => 'boolean', 'example' => 'true'],
'ClientCertSDnPassThrough' => ['description' => '是否将证书中 ssl_client_s_dn 的值通过 Header \'X-Client-S-Dn\' 传输给后端服务', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
'StageItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'StageInfo' => [
'description' => '运行环境信息',
'type' => 'array',
'items' => [
'description' => '运行环境信息',
'type' => 'object',
'properties' => [
'StageId' => ['description' => '运行环境编号', 'type' => 'string', 'example' => '123e8dc7bbe01613b5b1d726c2a7888e'],
'StageName' => ['description' => '运行环境名称', 'type' => 'string', 'example' => 'TEST'],
'Description' => ['description' => '运行环境描述', 'type' => 'string', 'example' => 'MYTEST'],
],
],
],
],
'description' => '',
],
'CloudMarketCommodity' => ['description' => '云市场商品', 'type' => 'boolean', 'example' => 'false'],
'DedicatedInstanceType' => ['description' => '分组所在专享实例的类型'."\n"
.' - VPC融合类型专享实例:vpc_connect'."\n"
.' - 传统类型专享实例:normal', 'type' => 'string', 'example' => 'normal'],
'MigrationStatus' => ['description' => '分组迁移实例任务状态'."\n"
.' - 运行中:Running'."\n"
.' - 成功:Success'."\n"
.' - 失败:Fail', 'type' => 'string', 'example' => 'Fail'],
'MigrationError' => ['description' => '分组迁移实例任务失败时,失败的原因。'."\n"
.'当MigrationStatus参数值为Fail时,不为空。', 'type' => 'string', 'example' => 'The current instance conflicts with the target instance.'],
'DisableInnerDomain' => ['description' => '是否禁止公网二级域名的访问'."\n"
.'- true:禁止公网二级域名访问'."\n"
.'- false:允许公网二级域名访问', 'type' => 'boolean', 'example' => 'false'],
'CustomAppCodeConfig' => ['description' => '自定义AppCode配置', 'type' => 'string', 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"NORMAL\\",\\n \\"CompatibleFlags\\": \\"depart:dep1\\",\\n \\"BasePath\\": \\"/qqq\\",\\n \\"Ipv6Status\\": \\"UNBIND\\",\\n \\"UserLogConfig\\": \\"{\\\\\\\\\\\\\\"requestBody\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"responseBody\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"queryString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"requestHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"responseHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jwtClaims\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"CustomerConfigs\\": \\"removeResponseServerHeader\\",\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB989B519\\",\\n \\"Description\\": \\"New weather informations.\\",\\n \\"HttpsPolicy\\": \\"HTTPS2_TLS1_0\\",\\n \\"SubDomain\\": \\"27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com\\",\\n \\"CreatedTime\\": \\"2016-08-01T06:53:02Z\\",\\n \\"DefaultDomain\\": \\"mkt.api.gaore.com\\",\\n \\"CmsMonitorGroup\\": \\"217008423\\",\\n \\"BillingStatus\\": \\"NORMAL\\",\\n \\"TrafficLimit\\": 500,\\n \\"PassthroughHeaders\\": \\"eagleeye-rpcid,x-b3-traceid\\",\\n \\"InstanceId\\": \\"apigateway-cn-v6419k43xxxxx\\",\\n \\"VpcDomain\\": \\"e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com\\",\\n \\"InstanceType\\": \\"VPC_SHARED\\",\\n \\"CustomTraceConfig\\": \\"{\\\\\\\\\\\\\\"parameterLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HEADER\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parameterName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\"}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ModifiedTime\\": \\"2016-08-01T06:54:32Z\\",\\n \\"GroupId\\": \\"523e8dc7bbe04613b5b1d726c2a7889d\\",\\n \\"GroupName\\": \\"NewWeather\\",\\n \\"IllegalStatus\\": \\"NORMAL\\",\\n \\"VpcSlbIntranetDomain\\": \\"257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com\\",\\n \\"CustomDomains\\": {\\n \\"DomainItem\\": [\\n {\\n \\"BindStageName\\": \\"TEST\\",\\n \\"DomainLegalStatus\\": \\"ABNORMAL\\",\\n \\"CertificateName\\": \\"myCertificate\\",\\n \\"CustomDomainType\\": \\"intranet\\",\\n \\"DomainCNAMEStatus\\": \\"RESOLVED\\",\\n \\"WildcardDomainPatterns\\": \\"[\\\\\\\\\\\\\\"{test}.test.com\\\\\\\\\\\\\\"]\\",\\n \\"DomainBindingStatus\\": \\"BINDING\\",\\n \\"DomainName\\": \\"api.demo.com\\",\\n \\"DomainRemark\\": \\"The domain name is not registered.\\",\\n \\"DomainWebSocketStatus\\": \\"CLOSE\\",\\n \\"CertificateId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"IsHttpRedirectToHttps\\": false,\\n \\"CertificateValidStart\\": 1689043476000,\\n \\"CertificateValidEnd\\": 2635123476000,\\n \\"BindStageAlias\\": \\"TEST1\\",\\n \\"SslVerifyDepth\\": 2,\\n \\"SslOcspEnable\\": true,\\n \\"SslOcspCacheEnable\\": true,\\n \\"ClientCertSDnPassThrough\\": true\\n }\\n ]\\n },\\n \\"StageItems\\": {\\n \\"StageInfo\\": [\\n {\\n \\"StageId\\": \\"123e8dc7bbe01613b5b1d726c2a7888e\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"Description\\": \\"MYTEST\\"\\n }\\n ]\\n },\\n \\"CloudMarketCommodity\\": false,\\n \\"DedicatedInstanceType\\": \\"normal\\",\\n \\"MigrationStatus\\": \\"Fail\\",\\n \\"MigrationError\\": \\"The current instance conflicts with the target instance.\\",\\n \\"DisableInnerDomain\\": false,\\n \\"CustomAppCodeConfig\\": \\"{\\\\\\"location\\\\\\":\\\\\\"HEADER\\\\\\",\\\\\\"name\\\\\\":\\\\\\"myAppCodeHeader\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 03442A3D-3B7D-434C-8A95-A5FEB989B519\\r\\n 523e8dc7bbe04613b5b1d726c2a7889d\\r\\n NewWeather\\r\\n 927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com\\r\\n New weather informations.\\r\\n 2016-08-01T06:53:02Z\\r\\n 2016-08-01T06:54:32Z\\r\\n cn-hangzhou\\r\\n NORMAL\\r\\n NORMAL\\r\\n NORMAL\\r\\n 500\\r\\n \\r\\n \\r\\n api.demo.com\\r\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\r\\n myCertificate\\r\\n RESOLVED\\r\\n BINDING\\r\\n ABNORMAL\\r\\n 该域名未备案\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n 123e8dc7bbe01613b5b1d726c2a7887e\\r\\n RELEASE\\r\\n MYRELEASE\\r\\n \\r\\n \\r\\n 123e8dc7bbe01613b5b1d726c2a7888e\\r\\n TEST\\r\\n MYTEST\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询 API 分组详情',
'description' => '- 此功能面向API提供者',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApiGroupVpcWhitelist' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94314',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f6c64214dc27400196eef954575d60d3'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VpcIds' => ['description' => '专用网络id', 'type' => 'string', 'example' => 'vpc-bp11w979o2s9rcr962w25'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
],
'description' => '',
],
],
],
'title' => '查询分组VPC白名单',
'summary' => '查询API分组允许访问的VPC白名单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroupVpcWhitelist'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroupVpcWhitelist',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcIds\\": \\"vpc-bp11w979o2s9rcr962w25\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]',
],
'DescribeApiGroups' => [
'summary' => '查询当前存在的API分组列表及基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94313',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'API组名称中,可指定的关键字', 'type' => 'string', 'required' => false, 'example' => 'Traffic'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值50,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'EnableTagAuth',
'in' => 'query',
'schema' => ['description' => '是否启用标签验证', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'apigateway-cn-v6419k43245xx'],
],
[
'name' => 'Sort',
'in' => 'query',
'schema' => ['description' => '排序,默认值是desc,可选asc,desc'."\n"
.'- asc:按修改时间升序排列;'."\n"
.'- desc:按修改时间降序排列', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的value'."\n", 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'BasePath',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'ApiGroupAttributes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiGroupAttribute' => [
'description' => '返回分组集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BasePath' => ['description' => '基准路径', 'type' => 'string', 'example' => '/v2/'],
'BillingStatus' => ['description' => '计费状态,取值:'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **LOCKED**:欠费锁定', 'type' => 'string', 'example' => 'NORMAL'],
'TrafficLimit' => ['description' => '分组最高QPS限制,默认500,可申请提高', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'apigateway-cn-v6419k43245xx'],
'InstanceType' => ['description' => '实例类型', 'type' => 'string', 'example' => 'VPC_SHARED'],
'RegionId' => ['description' => '分组所在区域', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2016-08-01T08:45:15Z'],
'GroupId' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164'],
'GroupName' => ['description' => 'API组名称', 'type' => 'string', 'example' => 'Traffic'],
'Description' => ['description' => '分组描述', 'type' => 'string', 'example' => 'TrafficInformations.'],
'IllegalStatus' => ['description' => '违法锁定,取值:'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **LOCKED**:违法锁定', 'type' => 'string', 'example' => 'NORMAL'],
'HttpsPolicy' => ['description' => 'HTTPS安全策略', 'type' => 'string', 'example' => 'HTTPS2_TLS1_0'],
'SubDomain' => ['description' => 'API组对应的二级域名,自定义域名cname所用', 'type' => 'string', 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2016-08-01T08:45:15Z'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'example' => 'key'],
'Value' => ['description' => '标签的value', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"ApiGroupAttributes\\": {\\n \\"ApiGroupAttribute\\": [\\n {\\n \\"BasePath\\": \\"/v2/\\",\\n \\"BillingStatus\\": \\"NORMAL\\",\\n \\"TrafficLimit\\": 500,\\n \\"InstanceId\\": \\"apigateway-cn-v6419k43245xx\\",\\n \\"InstanceType\\": \\"VPC_SHARED\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ModifiedTime\\": \\"2016-08-01T08:45:15Z\\",\\n \\"GroupId\\": \\"be6d2abcc0dd4f749fc2d2edd6567164\\",\\n \\"GroupName\\": \\"Traffic\\",\\n \\"Description\\": \\"TrafficInformations.\\",\\n \\"IllegalStatus\\": \\"NORMAL\\",\\n \\"HttpsPolicy\\": \\"HTTPS2_TLS1_0\\",\\n \\"SubDomain\\": \\"be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com\\",\\n \\"CreatedTime\\": \\"2016-08-01T08:45:15Z\\",\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n 2\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n be6d2abcc0dd4f749fc2d2edd6567164\\r\\n Traffic\\r\\n be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com\\r\\n TrafficInformations.\\r\\n 2016-08-01T08:45:15Z\\r\\n 2016-08-01T08:45:15Z\\r\\n cn-hangzhou\\r\\n 500\\r\\n NORMAL\\r\\n NORMAL\\r\\n \\r\\n \\r\\n 927d50c0f2e54b359919923d908bb015\\r\\n NewWeather\\r\\n 927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com\\r\\n NewWeatherInformations.\\r\\n 2016-08-01T06:54:32Z\\r\\n 2016-08-01T06:54:32Z\\r\\n cn-hangzhou\\r\\n 500\\r\\n NORMAL\\r\\n NORMAL\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询 API 分组列表',
'description' => '- 此功能面向API提供者'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
],
],
'DescribeApiHistories' => [
'summary' => '查询指定API历次历史发布的版本列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94315',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'example' => '1084f9034c744137901057206b39d2b6'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE '],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号', 'type' => 'string', 'required' => false, 'example' => 'c076144d7878437b8f82fb85890ce6a0'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称(模糊匹配)', 'type' => 'string', 'required' => false, 'example' => 'weather'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'required' => false, 'example' => '10', 'format' => 'int32'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'required' => false, 'example' => '1', 'format' => 'int32'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ003'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
'ApiHisItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiHisItem' => [
'description' => '由 ApiHisItem 组成的数组格式,返回API的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '对应版本的API是否生效,取值为:**ONLINE**、**OFFLINE**,分别表示有效、无效。', 'type' => 'string', 'example' => 'ONLINE'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Create object API'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'myGroup2'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6'],
'DeployedTime' => ['description' => '发布时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-20T08:28:48Z'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'HistoryVersion' => ['description' => 'API定义的历史版本', 'type' => 'string', 'example' => '20160705104552393'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'Create object'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 3,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ003\\",\\n \\"PageSize\\": 15,\\n \\"TotalCount\\": 32,\\n \\"ApiHisItems\\": {\\n \\"ApiHisItem\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"Description\\": \\"Create object API\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"DeployedTime\\": \\"2016-07-20T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"HistoryVersion\\": \\"20160705104552393\\",\\n \\"ApiName\\": \\"Create object\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 63be9002440b4778a61122f14c2b2bbb\\r\\n myGroup3\\r\\n c076144d7878437b8f82fb85890ce6a0\\r\\n 获取对象列表\\r\\n release\\r\\n 20160705104552292\\r\\n DISABLE\\r\\n 分页显示对象列表\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 1084f9034c744137901057206b39d2b6\\r\\n myGroup2\\r\\n 5af418828f0344a3b588c0cc1331a3bc\\r\\n 创建对象\\r\\n release\\r\\n 20160705104552393\\r\\n DISABLE\\r\\n 创建对象接口\\r\\n 2016-07-20T08:28:48Z\\r\\n \\r\\n \\r\\n 3\\r\\n 15\\r\\n 32\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ003 \\r\\n","errorExample":""}]',
'title' => '查询API历史发布的版本列表',
'description' => '- 此功能面向开放API的用户,有过发布的API才有历史版本记录'."\n"
.'- 调用该接口能获取API历史版本号数据,用于其他接口的调用'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistories'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiHistories',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApiHistory' => [
'summary' => '查询指定API的某一次历史发布版本的定义详情,即某一次历史发布时发布的API定义。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94316',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3013a55c0c44483f984d26df27120513'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc6e17ee3120404c839bbcd7622ab6ed'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,取值为:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试'."\n"
.'- **PRE**:预发', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'HistoryVersion',
'in' => 'query',
'schema' => ['description' => '指定要查询的历史版本号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20211122155403834'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'api调用状态', 'type' => 'string', 'example' => '200'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => 'bebf996e4b3d445d83078094b72b0d91'],
'ResultType' => ['description' => '返回数据类型。', 'type' => 'string', 'example' => 'JSON'],
'WebSocketApiType' => ['description' => '双向通信API类型:'."\n"
."\n"
.'- **COMMON**:普通API'."\n"
.'- **REGISTER**:注册API'."\n"
.'- **UNREGISTER**:注销API'."\n"
.'- **NOTIFY**:下行通知', 'type' => 'string', 'example' => 'COMMON'],
'DisableInternet' => ['description' => '- 设置**DisableInternet**为**true**, 仅支持内网调用API。'."\n"
.'- 设置**DisableInternet**为**false**, 则不限制调用。创建API时默认为false。', 'type' => 'boolean', 'example' => 'true'],
'ResultBodyModel' => ['description' => 'api的返回结果', 'type' => 'string', 'example' => '{}'],
'ResultSample' => ['description' => '返回示例', 'type' => 'string', 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}'],
'AppCodeAuthType' => ['description' => '支持AppCode的认证类型。可选值:'."\n"
."\n"
.'- DEFAULT:默认值:上架云市场后支持'."\n"
.'- DISABLE: 不支持AppCode调用方式'."\n"
.'- HEADER :仅在Header中支持'."\n"
.'- HEADER_QUERY :可以在Header或者Query中支持', 'type' => 'string', 'example' => 'HEADER'],
'AllowSignatureMethod' => ['description' => '当**AuthType**为**APP**认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ForceNonceCheck' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
."\n"
.'- 设置**ForceNonceCheck**为**false**,则不检查。创建API时默认为false。', 'type' => 'boolean', 'example' => 'true'],
'Visibility' => ['description' => 'API是否公开,可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。', 'type' => 'string', 'example' => 'PUBLIC'],
'FailResultSample' => ['description' => '后端服务失败返回应答的示例', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}'],
'AuthType' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。', 'type' => 'string', 'example' => 'APP'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
'Description' => ['description' => 'api描述', 'type' => 'string', 'example' => 'Query weather by region name'],
'GroupName' => ['description' => 'api分组名称', 'type' => 'string', 'example' => 'dev_api'],
'GroupId' => ['description' => 'api分组编号', 'type' => 'string', 'example' => 'cfb6ef799bf54fffabb0f02019ad2581'],
'DeployedTime' => ['description' => '发布时间(格林威治时间)', 'type' => 'string', 'example' => '2021-06-1113:57:38'],
'StageName' => ['description' => 'API发布的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'HistoryVersion' => ['description' => '历史版本号', 'type' => 'string', 'example' => '20211022134156663'],
'ApiName' => ['description' => 'Api名称', 'type' => 'string', 'example' => 'Test API'],
'BackendEnable' => ['description' => '是否启用后端服务', 'type' => 'boolean', 'example' => 'true'],
'BackendConfig' => [
'description' => '后端配置',
'type' => 'object',
'properties' => [
'BackendId' => ['description' => '后端服务ID', 'type' => 'string', 'example' => 'a0305308908c4740aba9cbfd63ba99b7'],
'BackendType' => ['description' => '后端服务类型', 'type' => 'string', 'example' => 'HTTP'],
'BackendName' => ['description' => '后端服务名称', 'type' => 'string', 'example' => 'zmapi'],
],
],
'RequestConfig' => [
'description' => 'Consumer向网关发送API请求的相关配置项。'."\n"
."\n"
.'更多信息,请参见[RequestConfig](~~43985~~)。',
'type' => 'object',
'properties' => [
'BodyModel' => ['description' => 'body模型'."\n"
."\n", 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/340a127dcc4afd9ab1bf7e947b4095/9e2df550e85b412179ec33e2619eaab'],
'RequestPath' => ['description' => 'API path', 'type' => 'string', 'example' => '/api/billing/test/[type]'],
'RequestHttpMethod' => ['description' => 'HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS', 'type' => 'string', 'example' => 'POST'],
'BodyFormat' => ['description' => 'POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:FORM、STREAM,分别表示表单形式(k-v对应)、字节流形式。当RequestMode值为MAPPING时有效。', 'type' => 'string', 'example' => 'STREAM'],
'RequestMode' => ['description' => '入参请求的模式,取值为:'."\n"
."\n"
.'- MAPPING:入参映射(过滤未知参数)'."\n"
."\n"
.'- PASSTHROUGH:入参透传'."\n"
."\n"
.'- MAPPING_PASSTHROUGH:入参映射(透传未知参数)', 'type' => 'string', 'example' => 'MAPPING'],
'PostBodyDescription' => ['description' => '请求body描述', 'type' => 'string', 'example' => 'fwefwef'],
'RequestProtocol' => ['description' => 'API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:"HTTP,HTTPS",取值为:HTTP、HTTPS', 'type' => 'string', 'example' => 'HTTP'],
'EscapePathParam' => ['description' => '是否转义Path中的中括号[]', 'type' => 'boolean', 'example' => 'false'],
],
],
'ServiceConfig' => [
'description' => '后端服务调用信息项',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-uf6kg9x8sx2tbxxxx'],
'MockStatusCode' => ['description' => 'Mock返回状态码'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ContentTypeValue' => ['description' => '调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值', 'type' => 'string', 'example' => 'application/json'],
'ServiceProtocol' => ['description' => '后端服务协议类型,目前只支持HTTP/HTTPS/FunctionCompute', 'type' => 'string', 'example' => 'HTTP'],
'ServicePath' => ['description' => '调用后端服务path', 'type' => 'string', 'example' => '/object/add'],
'ContentTypeCatagory' => ['description' => '调用后端服务HTTP服务时,ContentType头的取值策略:'."\n"
."\n"
.'- DEFAULT:使用API网关默认的值 '."\n"
."\n"
.'- CUSTOM:自定义 '."\n"
."\n"
.'- CLIENT:使用客户端上行的ContentType的头', 'type' => 'string', 'example' => 'CUSTOM'],
'ServiceAddress' => ['description' => '调用后端服务地址', 'type' => 'string', 'example' => 'http://api.a.com:8080'],
'Mock' => ['description' => '是否启用MOCK模式,目前可以取值:'."\n"
."\n"
.'- TRUE:启用Mock模式 '."\n"
."\n"
.'- FALSE:不启用Mock模式', 'type' => 'string', 'example' => 'TRUE'],
'ServiceVpcEnable' => ['description' => '是否启用VPC通道,目前可以取值: '."\n"
."\n"
.'- TRUE:启用VPC通道'."\n"
.' '."\n"
.'- FALSE:不启用VPC通道'."\n"
.'必须先添加VPC授权成功后才能启用', 'type' => 'string', 'example' => 'TRUE'],
'MockResult' => ['description' => '如果启用Mock模式,返回的结果', 'type' => 'string', 'example' => 'test result'],
'ServiceHttpMethod' => ['description' => '调用后端服务HTTP协议时的Method,取值为:PUT、GET、POST、DELETE、PATCH、HEAD、OPTIONS、ANY。', 'type' => 'string', 'example' => 'POST'],
'ServiceTimeout' => ['description' => '后端服务超时时间,单位:毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'MockHeaders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MockHeader' => [
'description' => '模拟 Headers',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HeaderValue' => ['description' => 'HTTP头参数值', 'type' => 'string', 'example' => '86400'],
'HeaderName' => ['description' => 'HTTP头参数名', 'type' => 'string', 'example' => 'Content-Type'],
],
'description' => '',
],
],
],
'description' => '',
],
'VpcConfig' => [
'description' => 'VPC通道相关配置项',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***'],
'VpcScheme' => ['description' => 'VPC协议', 'type' => 'string', 'example' => 'HTTP'],
'InstanceId' => ['description' => '专用网络中的实例ID(Ecs/负载均衡)', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***'],
'Port' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'],
'Name' => ['description' => 'VPC名称', 'type' => 'string', 'example' => 'glmall-app-test'],
],
],
'FunctionComputeConfig' => [
'description' => '后端为函数计算时的后端配置项',
'type' => 'object',
'properties' => [
'FcType' => ['description' => '函数计算服务类型', 'type' => 'string', 'example' => 'HttpTrigger'],
'RoleArn' => ['description' => 'Ram授权给API网关访问函数计算的arn', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas'],
'Method' => ['description' => '请求方法', 'type' => 'string', 'example' => 'GET'],
'FcBaseUrl' => ['description' => '函数计算服务根路径', 'type' => 'string', 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/'],
'ContentTypeValue' => ['description' => '调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。', 'type' => 'string', 'example' => 'application/json'],
'RegionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'OnlyBusinessPath' => ['description' => '后端只接收业务path', 'type' => 'boolean', 'example' => 'false'],
'FunctionName' => ['description' => '函数计算定义的FunctionName', 'type' => 'string', 'example' => 'domain_business_control'],
'ContentTypeCatagory' => ['description' => '调用后端服务HTTP服务时,ContentType头的取值策略:'."\n"
."\n"
.'- **DEFAULT**:使用API网关默认的值'."\n"
.'- **CUSTOM**:自定义'."\n"
.'- **CLIENT**:使用客户端上行的ContentType的头', 'type' => 'string', 'example' => 'DEFAULT'],
'Path' => ['description' => 'API请求路径', 'type' => 'string', 'example' => '/api/offline/cacheData'],
'ServiceName' => ['description' => '函数计算定义的ServiceName', 'type' => 'string', 'example' => 'fcservicename'],
'Qualifier' => ['description' => '函数别名', 'type' => 'string', 'example' => '2'],
],
],
'OssConfig' => [
'description' => '后端为OSS的信息',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'OSS内存储对象或文件夹路径', 'type' => 'string', 'example' => '/folder/test.json'],
'Action' => ['description' => 'OSS的操作,目前可以取值'."\n"
.' - GetObject'."\n"
.' - PostObject'."\n"
.' - DeleteObject'."\n"
.' - PutObject'."\n"
.' - HeadObject'."\n"
.' - GetObjectMeta'."\n"
.' - AppendObject', 'type' => 'string', 'example' => 'GetObject'],
'OssRegionId' => ['description' => 'OSS服务所在地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'BucketName' => ['description' => 'OSS存储Bucket。', 'type' => 'string', 'example' => 'phototest02'],
],
],
'EventBridgeConfig' => [
'description' => '事件总线设置',
'type' => 'object',
'properties' => [
'EventBridgeRegionId' => ['description' => '事件总线服务所在区域ID', 'type' => 'string', 'example' => 'cn-beijing'],
'EventBus' => ['description' => '事件总线', 'type' => 'string', 'example' => 'testBus'],
'EventSource' => ['description' => '事件来源。'."\n", 'type' => 'string', 'example' => 'baas_driver'],
'RoleArn' => ['description' => 'Ram授权给EventBridge的arn', 'type' => 'string', 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun'],
],
],
],
],
'OpenIdConnectConfig' => [
'description' => '第三方账号认证OpenID Connect相关配置项',
'type' => 'object',
'properties' => [
'OpenIdApiType' => ['description' => 'OpenID Connect模式,目前可以取值:'."\n"
."\n"
.'- **IDTOKEN**:获取授权API,颁发Token,当设置此项时,参数PublicKeyId和PublicKey为必传。'."\n"
.'- **BUSINESS**:业务API,Token验证,当设置此项时,参数IdTokenParamName为必传。', 'type' => 'string', 'example' => 'IDTOKEN'],
'IdTokenParamName' => ['description' => 'Token对应的参数名称', 'type' => 'string', 'example' => 'xxx'],
'PublicKeyId' => ['description' => '公钥id', 'type' => 'string', 'example' => '88483727556929326703309904351185815489'],
'PublicKey' => ['description' => 'api公钥', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92'],
],
],
'ErrorCodeSamples' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ErrorCodeSample' => [
'description' => '后端服务返回的错误码示例。'."\n"
."\n"
.'更多信息,请参见[ErrorCodeSample](~~44392~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码', 'type' => 'string', 'example' => '400'],
'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'MissingParameter'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Missing the parameter UserId'],
],
'description' => '',
],
],
],
'description' => '',
],
'ResultDescriptions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResultDescription' => [
'description' => 'api的返回说明',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => '结果类型。', 'type' => 'string', 'example' => 'String'],
'Key' => ['description' => '结果主键。', 'type' => 'string', 'example' => 'groupName'],
'HasChild' => ['description' => '是否有子节点。', 'type' => 'boolean', 'example' => 'true'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'for_test1'],
'Pid' => ['description' => '父节点 ID。', 'type' => 'string', 'example' => 'pid'],
'Mandatory' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'true'],
'Name' => ['description' => '结果名。', 'type' => 'string', 'example' => 'fwqf'],
'Id' => ['description' => '结果 ID。', 'type' => 'string', 'example' => 'id'],
],
'description' => '',
],
],
],
'description' => '',
],
'SystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SystemParameter' => [
'description' => 'api的公共参数,json格式',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例值。', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'system parameters description'],
'ParameterName' => ['description' => '系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。', 'type' => 'string', 'example' => 'CaClientIp'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'CustomSystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomSystemParameter' => [
'description' => '自定义系统参数列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例值', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '自定义系统参数描述', 'type' => 'string', 'example' => 'balabala'],
'ParameterName' => ['description' => '自定义系统参数名', 'type' => 'string', 'example' => 'CaClientIp'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ConstantParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConstantParameter' => [
'description' => '常量参数列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'for_test1'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'constance'],
'ConstantValue' => ['description' => '常量值', 'type' => 'string', 'example' => 'constance'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestParameter' => [
'description' => 'Consumer向网关发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[RequestParameter](~~43986~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}'],
'MaxValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最大值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'ArrayItemsType' => ['description' => '数组元素的类型', 'type' => 'string', 'example' => 'String'],
'MinValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最小值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocShow' => ['description' => '文档可见,取值为:**PUBLIC**、**PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC'],
'MaxLength' => ['description' => '当**ParameterType**=String,参数的最大长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DefaultValue' => ['description' => '默认值', 'type' => 'string', 'example' => '20'],
'ApiParameterName' => ['description' => 'API 参数名称', 'type' => 'string', 'example' => 'age'],
'EnumValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。', 'type' => 'string', 'example' => 'boy,girl'],
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '20'],
'Required' => ['description' => '是否必填,取值为:**REQUIRED**、**OPTIONAL**,分别表示必填、不必填', 'type' => 'string', 'example' => 'OPTIONAL'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'modidyTest'],
'ParameterType' => ['description' => '参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。', 'type' => 'string', 'example' => 'String'],
'RegularExpression' => ['description' => '当**ParameterType**=String,参数验证(正则表达式)', 'type' => 'string', 'example' => 'xxx'],
'MinLength' => ['description' => '当**ParameterType**=String,参数的最小长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocOrder' => ['description' => '文档中顺序', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameter' => [
'description' => '网关向后端服务发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[ServiceParameter](~~43988~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ParameterType' => ['description' => '后端参数数据类型,取值为:STRING、NUMBER、BOOLEAN,分别表示字符、数值、布尔。', 'type' => 'string', 'example' => 'String'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParametersMap' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameterMap' => [
'description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。'."\n"
."\n"
.'更多信息,请参见[ServiceParameterMap](~~43989~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RequestParameterName' => ['description' => '对应前端入参名称,这个值必须存在于RequestParametersObject中,匹配于RequestParam.ApiParameterName。', 'type' => 'string', 'example' => 'sex'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'sex'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"200\\",\\n \\"ApiId\\": \\"bebf996e4b3d445d83078094b72b0d91\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"WebSocketApiType\\": \\"COMMON\\",\\n \\"DisableInternet\\": true,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"status\\\\\\\\\\\\\\": 0,\\\\\\\\n \\\\\\\\\\\\\\"data\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 1,\\\\\\\\n \\\\\\\\\\\\\\"list\\\\\\\\\\\\\\": [\\\\\\\\n \\\\\\\\\\\\\\"352\\\\\\\\\\\\\\"\\\\\\\\n ]\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"success\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"AppCodeAuthType\\": \\"HEADER\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\",\\n \\"Description\\": \\"Query weather by region name\\",\\n \\"GroupName\\": \\"dev_api\\",\\n \\"GroupId\\": \\"cfb6ef799bf54fffabb0f02019ad2581\\",\\n \\"DeployedTime\\": \\"2021-06-1113:57:38\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"HistoryVersion\\": \\"20211022134156663\\",\\n \\"ApiName\\": \\"Test API\\",\\n \\"BackendEnable\\": true,\\n \\"BackendConfig\\": {\\n \\"BackendId\\": \\"a0305308908c4740aba9cbfd63ba99b7\\",\\n \\"BackendType\\": \\"HTTP\\",\\n \\"BackendName\\": \\"zmapi\\"\\n },\\n \\"RequestConfig\\": {\\n \\"BodyModel\\": \\"https://apigateway.aliyun.com/models/340a127dcc4afd9ab1bf7e947b4095/9e2df550e85b412179ec33e2619eaab\\",\\n \\"RequestPath\\": \\"/api/billing/test/[type]\\",\\n \\"RequestHttpMethod\\": \\"POST\\",\\n \\"BodyFormat\\": \\"STREAM\\",\\n \\"RequestMode\\": \\"MAPPING\\",\\n \\"PostBodyDescription\\": \\"fwefwef\\",\\n \\"RequestProtocol\\": \\"HTTP\\",\\n \\"EscapePathParam\\": false\\n },\\n \\"ServiceConfig\\": {\\n \\"VpcId\\": \\"vpc-uf6kg9x8sx2tbxxxx\\",\\n \\"MockStatusCode\\": 200,\\n \\"ContentTypeValue\\": \\"application/json\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePath\\": \\"/object/add\\",\\n \\"ContentTypeCatagory\\": \\"CUSTOM\\",\\n \\"ServiceAddress\\": \\"http://api.a.com:8080\\",\\n \\"Mock\\": \\"TRUE\\",\\n \\"ServiceVpcEnable\\": \\"TRUE\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"ServiceHttpMethod\\": \\"POST\\",\\n \\"ServiceTimeout\\": 1000,\\n \\"MockHeaders\\": {\\n \\"MockHeader\\": [\\n {\\n \\"HeaderValue\\": \\"86400\\",\\n \\"HeaderName\\": \\"Content-Type\\"\\n }\\n ]\\n },\\n \\"VpcConfig\\": {\\n \\"VpcId\\": \\"vpc-2zeafsc3fygk1***\\",\\n \\"VpcScheme\\": \\"HTTP\\",\\n \\"InstanceId\\": \\"i-bp1h497hkijewv2***\\",\\n \\"Port\\": 8080,\\n \\"Name\\": \\"glmall-app-test\\"\\n },\\n \\"FunctionComputeConfig\\": {\\n \\"FcType\\": \\"HttpTrigger\\",\\n \\"RoleArn\\": \\"acs:ram::111***:role/aliyunserviceroleforsas\\",\\n \\"Method\\": \\"GET\\",\\n \\"FcBaseUrl\\": \\"https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/\\",\\n \\"ContentTypeValue\\": \\"application/json\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OnlyBusinessPath\\": false,\\n \\"FunctionName\\": \\"domain_business_control\\",\\n \\"ContentTypeCatagory\\": \\"DEFAULT\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"ServiceName\\": \\"fcservicename\\",\\n \\"Qualifier\\": \\"2\\"\\n },\\n \\"OssConfig\\": {\\n \\"Key\\": \\"/folder/test.json\\",\\n \\"Action\\": \\"GetObject\\",\\n \\"OssRegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"phototest02\\"\\n },\\n \\"EventBridgeConfig\\": {\\n \\"EventBridgeRegionId\\": \\"cn-beijing\\",\\n \\"EventBus\\": \\"testBus\\",\\n \\"EventSource\\": \\"baas_driver\\",\\n \\"RoleArn\\": \\"acs:ram::1933122015759***:role/adminoidcaliyun\\"\\n }\\n },\\n \\"OpenIdConnectConfig\\": {\\n \\"OpenIdApiType\\": \\"IDTOKEN\\",\\n \\"IdTokenParamName\\": \\"xxx\\",\\n \\"PublicKeyId\\": \\"88483727556929326703309904351185815489\\",\\n \\"PublicKey\\": \\"EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92\\"\\n },\\n \\"ErrorCodeSamples\\": {\\n \\"ErrorCodeSample\\": [\\n {\\n \\"Code\\": \\"400\\",\\n \\"Message\\": \\"MissingParameter\\",\\n \\"Description\\": \\"Missing the parameter UserId\\"\\n }\\n ]\\n },\\n \\"ResultDescriptions\\": {\\n \\"ResultDescription\\": [\\n {\\n \\"Type\\": \\"String\\",\\n \\"Key\\": \\"groupName\\",\\n \\"HasChild\\": true,\\n \\"Description\\": \\"for_test1\\",\\n \\"Pid\\": \\"pid\\",\\n \\"Mandatory\\": true,\\n \\"Name\\": \\"fwqf\\",\\n \\"Id\\": \\"id\\"\\n }\\n ]\\n },\\n \\"SystemParameters\\": {\\n \\"SystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"system parameters description\\",\\n \\"ParameterName\\": \\"CaClientIp\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"CustomSystemParameters\\": {\\n \\"CustomSystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"balabala\\",\\n \\"ParameterName\\": \\"CaClientIp\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ConstantParameters\\": {\\n \\"ConstantParameter\\": [\\n {\\n \\"Description\\": \\"for_test1\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"constance\\",\\n \\"ConstantValue\\": \\"constance\\"\\n }\\n ]\\n },\\n \\"RequestParameters\\": {\\n \\"RequestParameter\\": [\\n {\\n \\"JsonScheme\\": \\"{}\\",\\n \\"MaxValue\\": 123456,\\n \\"ArrayItemsType\\": \\"String\\",\\n \\"MinValue\\": 123456,\\n \\"DocShow\\": \\"PUBLIC\\",\\n \\"MaxLength\\": 123456,\\n \\"DefaultValue\\": \\"20\\",\\n \\"ApiParameterName\\": \\"age\\",\\n \\"EnumValue\\": \\"boy,girl\\",\\n \\"DemoValue\\": \\"20\\",\\n \\"Required\\": \\"OPTIONAL\\",\\n \\"Description\\": \\"modidyTest\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"RegularExpression\\": \\"xxx\\",\\n \\"MinLength\\": 123456,\\n \\"DocOrder\\": 0,\\n \\"Location\\": \\"HEAD\\"\\n }\\n ]\\n },\\n \\"ServiceParameters\\": {\\n \\"ServiceParameter\\": [\\n {\\n \\"Location\\": \\"HEAD\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ServiceParametersMap\\": {\\n \\"ServiceParameterMap\\": [\\n {\\n \\"RequestParameterName\\": \\"sex\\",\\n \\"ServiceParameterName\\": \\"sex\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询历史版本详情',
'description' => '查询指定API的某一次历史发布版本的定义详情,即某一次历史发布时发布的API定义。'."\n"
."\n"
.'- 此功能面向开放API的用户。'."\n"
.'- 网关会记录下每个API每一次发布的时间、定义等等,您可以通过其他的接口获取版本号来指定查询某一次发布的定义详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistory'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApiIpControls' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94317',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的分组', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号,支持输入多个,半角逗号(,)分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '123,234'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ApiIpControls' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiIpControlItem' => [
'description' => '由 ApiIpControlItem组成的数组格式,返回IP访问控制的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90'],
'IpControlId' => ['description' => 'IP访问控制ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'IpControlName' => ['description' => 'IP访问控制名称', 'type' => 'string', 'example' => 'testControlName'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API的IP访问控制绑定情况',
'summary' => '查询指定分组指定环境下,所有API的IP访问控制绑定情况。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 非必填的参数,不传入则默认返回所有,分页返回'."\n"
.'·',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiIpControls'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiIpControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ApiIpControls\\": {\\n \\"ApiIpControlItem\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"ApiId\\": \\"46fbb52840d146f186e38e8e70fc8c90\\",\\n \\"IpControlId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"IpControlName\\": \\"testControlName\\",\\n \\"ApiName\\": \\"testapi\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 46fbb52840d146f186e38e8e70fc8c90\\r\\n testapi \\r\\n dd05f1c54d6749eda95f9fa6d491449a\\r\\n testControlName\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApiLatencyData' => [
'summary' => '查询指定API监控数据中对响应时间的统计数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94318',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 '],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001'],
'CallLatencys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '由 MonitorItem 组成的格式,返回API调用延迟监控信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '15'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API监控数据中对响应时间统计数据',
'description' => '查询指定API的监控信息:Latency(ms)'."\n"
.'- 此功能面向开放API的用户'."\n"
.'- 监控功能默认对线上环境的API做统计,不包括测试环境的API调用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiLatencyData'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiLatencyData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\",\\n \\"CallLatencys\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"15\\",\\n \\"ItemTime\\": \\"2016-07-28T08:20:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\r\\n \\r\\n \\r\\n 2016-07-28T08:20:00Z\\r\\n 15\\r\\n \\r\\n \\r\\n 2016-07-28T08:22:00Z\\r\\n 30\\r\\n \\r\\n \\r\\n 2016-07-28T08:24:00Z\\r\\n 24\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApiMarketAttributes' => [
'summary' => '查询API上云市场属性。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94319',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b693252f3f19445e9a01dac177c4454c'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1f9b5e9ba80943099cac52e040b7e160'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '6318cd8f6a304cac9318dea8d9a78f7a'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6'],
'MarketChargingMode' => ['description' => '云市场计费模式', 'type' => 'string', 'example' => 'PREPAID_BY_USAGE'],
'NeedCharging' => ['description' => '是否需要收费', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'title' => '获取API的属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMarketAttributes'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiMarketAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"6318cd8f6a304cac9318dea8d9a78f7a\\",\\n \\"RequestId\\": \\"545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6\\",\\n \\"MarketChargingMode\\": \\"PREPAID_BY_USAGE\\",\\n \\"NeedCharging\\": \\"true\\"\\n}","type":"json"}]',
],
'DescribeApiProductApis' => [
'summary' => '查询API产品绑定的API列表',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数,每页显示条数,默认值10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519'],
'PageNumber' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页参数:每页显示条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'ApiInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiInfo' => [
'description' => '返回的API列表信息',
'type' => 'array',
'items' => [
'description' => '返回的API列表信息',
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'example' => 'dd46297680014a7e8e318308f3345951'],
'Description' => ['description' => 'API的描述信息', 'type' => 'string', 'example' => 'test'],
'GroupName' => ['description' => 'api分组名称', 'type' => 'string', 'example' => 'testApiGroup'],
'GroupId' => ['description' => 'api分组ID', 'type' => 'string', 'example' => '1e377f18142345dfb700cd8911c2463a'],
'Path' => ['description' => 'API的请求路径', 'type' => 'string', 'example' => '/test'],
'Method' => ['description' => 'API的请求方法', 'type' => 'string', 'example' => 'POST'],
'StageName' => ['description' => 'API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testApi'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API产品绑定的API列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiProductApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB989B519\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 4,\\n \\"ApiInfoList\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"ApiId\\": \\"dd46297680014a7e8e318308f3345951\\",\\n \\"Description\\": \\"test\\",\\n \\"GroupName\\": \\"testApiGroup\\",\\n \\"GroupId\\": \\"1e377f18142345dfb700cd8911c2463a\\",\\n \\"Path\\": \\"/test\\",\\n \\"Method\\": \\"POST\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"testApi\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeApiProductsByApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110962435'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0B805201-AF4C-5788-AC9E-C3EEC83DC82A'],
'PageSize' => ['description' => '分页参数:每页显示条数,默认值10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '分页参数:当前页码,默认值1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'ApiProductInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiProductInfo' => [
'description' => 'API产品信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiProductId' => ['description' => 'API产品ID', 'type' => 'string', 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '根据APP查询有权限的API产品列表',
'summary' => '根据APP查询有权限的API产品列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductsByApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiProductsByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B805201-AF4C-5788-AC9E-C3EEC83DC82A\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 4,\\n \\"ApiProductInfoList\\": {\\n \\"ApiProductInfo\\": [\\n {\\n \\"ApiProductId\\": \\"117b7a64a8b3f064eaa4a47ac62aac5e\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeApiQpsData' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94320',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 '],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001'],
'CallSuccesses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '由 MonitorItem 组成的格式,返回API调用成功监控信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '650'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:24:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
'CallFails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '由 MonitorItem 组成的格式,返回API调用失败监控信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '0'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API监控数据中对QPS的统计数据',
'summary' => '查询指定API监控数据中对QPS的统计数据。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 监控功能默认对线上环境的API做统计,不包括测试环境的API调用'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiQpsData'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiQpsData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\",\\n \\"CallSuccesses\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"650\\",\\n \\"ItemTime\\": \\"2016-07-28T08:24:00Z\\"\\n }\\n ]\\n },\\n \\"CallFails\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"0\\",\\n \\"ItemTime\\": \\"2016-07-28T08:20:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\r\\n \\r\\n \\r\\n 2016-07-28T08:20:00Z\\r\\n 670\\r\\n \\r\\n \\r\\n 2016-07-28T08:22:00Z\\r\\n 770\\r\\n \\r\\n \\r\\n 2016-07-28T08:24:00Z\\r\\n 650\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n 2016-07-28T08:20:00Z\\r\\n 0\\r\\n \\r\\n \\r\\n 2016-07-28T08:22:00Z\\r\\n 0\\r\\n \\r\\n \\r\\n 2016-07-28T08:24:00Z\\r\\n 1\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApiSignatures' => [
'summary' => '查询指定分组指定环境下,所有API的签名密钥绑定情况。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94330',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiSignatures' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiSignatureItem' => [
'description' => '由 ApiSignatureItem 组成的数组格式,返回签名密钥的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '后端签名密钥绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90'],
'SignatureId' => ['description' => '后端签名密钥ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'SignatureName' => ['description' => '后端签名密钥名称', 'type' => 'string', 'example' => 'backendsignature'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API签名密钥绑定情况',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 非必填的参数,不传入则默认返回所有,分页返回'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiSignatures'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiSignatures',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiSignatures\\": {\\n \\"ApiSignatureItem\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"ApiId\\": \\"46fbb52840d146f186e38e8e70fc8c90\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\",\\n \\"ApiName\\": \\"testapi\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 46fbb52840d146f186e38e8e70fc8c90\\r\\n testapi \\r\\n dd05f1c54d6749eda95f9fa6d491449a\\r\\n backendsignature\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApiTrafficControls' => [
'summary' => '查询指定分组指定环境下所有API的流控策略绑定概况。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94333',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的分组', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '123,234'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiTrafficControls' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiTrafficControlItem' => [
'description' => '由 ApiTrafficControlItem 组成的数组格式,返回流控策略的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '流控策略绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90'],
'TrafficControlId' => ['description' => '流控策略ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'TrafficControlName' => ['description' => '流控策略名称', 'type' => 'string', 'example' => 'backendsignature'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API流控策略绑定概况',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 非必填的参数,不传入则默认返回所有,分页返回',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficControls'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiTrafficControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiTrafficControls\\": {\\n \\"ApiTrafficControlItem\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"ApiId\\": \\"46fbb52840d146f186e38e8e70fc8c90\\",\\n \\"TrafficControlId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"TrafficControlName\\": \\"backendsignature\\",\\n \\"ApiName\\": \\"testapi\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 46fbb52840d146f186e38e8e70fc8c90\\r\\n testapi \\r\\n dd05f1c54d6749eda95f9fa6d491449a\\r\\n backendsignature\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApiTrafficData' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94334',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,取值为:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试'."\n"
."\n"
.'- PRE:预发', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001'],
'CallUploads' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '由 MonitorItem 组成的格式,返回API调用上行数据流量监控信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '670'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
'CallDownloads' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '由 MonitorItem 组成的格式,返回API调用下行数据流量监控信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '0'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API监控数据中流量统计数据',
'summary' => '查询指定API监控数据中对流量的统计数据。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 监控功能默认对线上环境的API做统计,不包括测试环境的API调用'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficData'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiTrafficData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\",\\n \\"CallUploads\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"670\\",\\n \\"ItemTime\\": \\"2016-07-28T08:20:00Z\\"\\n }\\n ]\\n },\\n \\"CallDownloads\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"0\\",\\n \\"ItemTime\\": \\"2016-07-28T08:20:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\r\\n \\r\\n \\r\\n 2016-07-28T08:20:00Z\\r\\n 670\\r\\n \\r\\n \\r\\n 2016-07-28T08:22:00Z\\r\\n 770\\r\\n \\r\\n \\r\\n 2016-07-28T08:24:00Z\\r\\n 650\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n 2016-07-28T08:20:00Z\\r\\n 0\\r\\n \\r\\n \\r\\n 2016-07-28T08:22:00Z\\r\\n 0\\r\\n \\r\\n \\r\\n 2016-07-28T08:24:00Z\\r\\n 1\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeApis' => [
'summary' => '查询定义中的API列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => false, 'example' => 'c4a4d2de657548a2bd485d5d4df42b4a'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号', 'type' => 'string', 'required' => false, 'example' => 'f68c19ee3bd1478fb58aa05ce8ae9b5a'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称(模糊匹配)', 'type' => 'string', 'required' => false, 'example' => 'weather'],
],
[
'name' => 'CatalogId',
'in' => 'query',
'schema' => ['description' => '分类 ID', 'type' => 'string', 'required' => false, 'example' => '1553414085247362'],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => ['description' => 'API是否公开,可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'EnableTagAuth',
'in' => 'query',
'schema' => ['description' => '是否启用标签验证', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 50,
],
],
[
'name' => 'ApiPath',
'in' => 'query',
'schema' => ['description' => 'API的请求Path', 'type' => 'string', 'required' => false, 'example' => '/illegal/query'],
],
[
'name' => 'ApiMethod',
'in' => 'query',
'schema' => ['description' => 'API的请求HTTP方法', 'type' => 'string', 'required' => false, 'example' => 'GET'],
],
[
'name' => 'UnDeployed',
'in' => 'query',
'schema' => ['description' => '是否过滤未发布的接口', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
'ApiSummarys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiSummary' => [
'description' => '由 ApiSummary 组成的数组格式,返回API的定义信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Visibility' => ['description' => '可见性,可选值:'."\n"
."\n"
.'- **PUBLIC**:公开'."\n"
.'- **PRIVATE**:私有', 'type' => 'string', 'example' => 'PUBLIC'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc'],
'ModifiedTime' => ['description' => '修改时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Create object API'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'myGroup2'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6'],
'CreatedTime' => ['description' => '创建时间(格林威治时间)', 'type' => 'string', 'example' => '2016-05-20T18:18:25Z'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'Create object'],
'RegionId' => ['description' => 'API所在地域ID', 'type' => 'string', 'example' => 'cn-qingdao'],
'ApiPath' => ['description' => 'api的路径', 'type' => 'string', 'example' => '/sqb/'],
'ApiMethod' => ['description' => 'api的请求方法', 'type' => 'string', 'example' => 'GET'],
'DeployedInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeployedInfo' => [
'description' => 'API发布状态',
'type' => 'array',
'items' => [
'description' => 'API发布状态',
'type' => 'object',
'properties' => [
'StageName' => ['description' => '环境名称:'."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'EffectiveVersion' => ['description' => '已部署的版本', 'type' => 'string', 'example' => '20220103170737313'],
'DeployedStatus' => ['description' => '部署状态,取值为:DEPLOYED、NONDEPLOYED,分别表示已部署、未部署', 'type' => 'string', 'example' => 'DEPLOYED'],
],
],
],
],
'description' => '',
],
'TagList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签信息',
'type' => 'array',
'items' => [
'description' => '标签信息',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'tagKey'],
'TagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'tagValue'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 3,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\",\\n \\"PageSize\\": 15,\\n \\"TotalCount\\": 32,\\n \\"ApiSummarys\\": {\\n \\"ApiSummary\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"ModifiedTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Description\\": \\"Create object API\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"CreatedTime\\": \\"2016-05-20T18:18:25Z\\",\\n \\"ApiName\\": \\"Create object\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ApiPath\\": \\"/sqb/\\",\\n \\"ApiMethod\\": \\"GET\\",\\n \\"DeployedInfos\\": {\\n \\"DeployedInfo\\": [\\n {\\n \\"StageName\\": \\"RELEASE\\",\\n \\"EffectiveVersion\\": \\"20220103170737313\\",\\n \\"DeployedStatus\\": \\"DEPLOYED\\"\\n }\\n ]\\n },\\n \\"TagList\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"tagKey\\",\\n \\"TagValue\\": \\"tagValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 63be9002440b4778a61122f14c2b2bbb\\r\\n myGroup3\\r\\n c076144d7878437b8f82fb85890ce6a0\\r\\n 获取对象列表 \\r\\n public\\r\\n 分页显示对象列表\\r\\n 2016-06-20T18:18:25Z\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 1084f9034c744137901057206b39d2b6\\r\\n myGroup2\\r\\n 5af418828f0344a3b588c0cc1331a3bc\\r\\n 创建对象 \\r\\n public\\r\\n 创建对象接口\\r\\n 2016-05-20T18:18:25Z\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n 3\\r\\n 15\\r\\n 32\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ002 \\r\\n","errorExample":""}]',
'title' => '查询定义中的 API 列表',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 接口返回所有定义中的API列表,以及概况信息'."\n"
.'- 请注意是返回所有编辑中的API定义信息,跟环境无关,也可能跟环境中正在运行的定义不同,是最新的编辑结果',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeApisByApp' => [
'summary' => '根据APP查询关联的API列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94323',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['title' => 'APP的ID', 'description' => 'APP的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '333486644'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页条目', 'description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'ApiUid',
'in' => 'query',
'schema' => ['title' => 'API的ID', 'description' => 'API的ID', 'type' => 'string', 'required' => false, 'example' => 'b19240592b1b4e74961fb8438ed7550c'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'required' => false, 'example' => 'getPersonInfo'],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['title' => 'API请求路径', 'description' => 'API请求路径', 'type' => 'string', 'required' => false, 'example' => '/tt'],
],
[
'name' => 'Method',
'in' => 'query',
'schema' => ['title' => 'API的请求HTTP Method', 'description' => 'API的请求HTTP Method', 'type' => 'string', 'required' => false, 'example' => 'POST'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API描述信息', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'PageSize' => ['title' => '每页条目', 'description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['title' => '总条目数', 'description' => '总条目数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AppApiRelationInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppApiRelationInfo' => [
'description' => 'API授权信息',
'type' => 'array',
'items' => [
'description' => 'API授权信息',
'type' => 'object',
'properties' => [
'ApiId' => ['title' => 'API的ID', 'description' => 'API的ID', 'type' => 'string', 'example' => 'c625795a1e664782a918eaa629e96ab5'],
'AuthorizationSource' => ['title' => '授权来源', 'description' => '授权来源', 'type' => 'string', 'example' => 'SELF'],
'AuthVaildTime' => ['title' => '授权有效时间', 'description' => '授权有效时间', 'type' => 'string', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'],
'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'b1008kz'],
'GroupName' => ['title' => '分组名称', 'description' => '分组名称', 'type' => 'string', 'example' => 'wb2022012101605749'],
'GroupId' => ['title' => '分组ID', 'description' => '分组ID', 'type' => 'string', 'example' => '38bed48d664149e4b9b5ea576319673f'],
'Operator' => ['description' => '授权的人,取值:'."\n"
."\n"
.'- **PROVIDER**:API所有者'."\n"
.'- **CONSUMER**:API调用者', 'type' => 'string', 'example' => 'PROVIDER'],
'StageName' => ['title' => '环境名称', 'description' => '环境名称', 'type' => 'string', 'example' => 'RELEASE'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => 'Production'],
'CreatedTime' => ['title' => '授权时间', 'description' => '授权时间', 'type' => 'string', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'],
'ApiName' => ['title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'sd2_h5_player_history_competition'],
'RegionId' => ['title' => '地区ID', 'description' => '地区ID', 'type' => 'string', 'example' => 'cn-shanghai'],
'Path' => ['title' => 'API的请求路径', 'description' => 'API的请求路径', 'type' => 'string', 'example' => '/api/offline/cacheData'],
'Method' => ['title' => 'API的请求HTTP Method', 'description' => 'API的请求HTTP Method', 'type' => 'string', 'example' => 'GET'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AppApiRelationInfos\\": {\\n \\"AppApiRelationInfo\\": [\\n {\\n \\"ApiId\\": \\"c625795a1e664782a918eaa629e96ab5\\",\\n \\"AuthorizationSource\\": \\"SELF\\",\\n \\"AuthVaildTime\\": \\"Sun, 02 Jan 2022 16:00:00 GMT\\",\\n \\"Description\\": \\"b1008kz\\",\\n \\"GroupName\\": \\"wb2022012101605749\\",\\n \\"GroupId\\": \\"38bed48d664149e4b9b5ea576319673f\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"Production\\",\\n \\"CreatedTime\\": \\"Sun, 02 Jan 2022 16:00:00 GMT\\",\\n \\"ApiName\\": \\"sd2_h5_player_history_competition\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"Method\\": \\"GET\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据应用查询API列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
],
'DescribeApisByBackend' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '118586',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => true, 'example' => '4ac69b7a17524781b275ed4c5eb25c54'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询API的环境'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试'."\n"
."\n"
.'不填写查询的是草稿态API', 'type' => 'string', 'required' => false, 'example' => 'PRE'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
'PageSize' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ApiInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiInfo' => [
'description' => '返回的API列表信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'example' => '20bcdc9453524b78a8beb1f6de21edb7'],
'Description' => ['description' => 'API的描述信息', 'type' => 'string', 'example' => 'test'],
'GroupName' => ['description' => 'api分组名称', 'type' => 'string', 'example' => 'testApiGroup'],
'GroupId' => ['description' => 'api分组ID', 'type' => 'string', 'example' => '15bcdc9453524b7gs8beb1f6de21edb7'],
'Path' => ['description' => 'API的请求路径', 'type' => 'string', 'example' => '/test'],
'Method' => ['description' => 'API的请求方法', 'type' => 'string', 'example' => 'GET'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testApi'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '根据后端查询 API 列表',
'summary' => '查询使用该后端服务创建的草稿态API,或已发布在某个环境上的API。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByBackend'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ApiInfoList\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"ApiId\\": \\"20bcdc9453524b78a8beb1f6de21edb7\\",\\n \\"Description\\": \\"test\\",\\n \\"GroupName\\": \\"testApiGroup\\",\\n \\"GroupId\\": \\"15bcdc9453524b7gs8beb1f6de21edb7\\",\\n \\"Path\\": \\"/test\\",\\n \\"Method\\": \\"GET\\",\\n \\"ApiName\\": \\"testApi\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeApisByIpControl' => [
'summary' => '查询指定IP访问控制所绑定的API列表信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94324',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => '指定查询要用的IP访问控制ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiInfo' => [
'description' => '由 ApiInfo 组成的数组格式,返回API的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'Visibility' => ['description' => '可见性,枚举为:'."\n"
."\n"
.'- **PUBLIC**: 公开'."\n"
.'- **PRIVATE**: 私有', 'type' => 'string', 'example' => 'PUBLIC'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Description'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'mygroup'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930'],
'StageName' => ['description' => '环境名称,枚举为:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'TEST'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiInfos\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"3b81fd160f5645e097cc8855d75a1cf6\\",\\n \\"Description\\": \\"Description\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 0009db9c828549768a200320714b8930 \\r\\n mygroup\\r\\n test\\r\\n 3b81fd160f5645e097cc8855d75a1cf6\\r\\n testapi\\r\\n 描述\\r\\n public\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询IP访问控制绑定的API',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 分页返回'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByIpControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeApisBySignature' => [
'summary' => '查询指定签名密钥所绑定的API列表信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定查询要用的签名密钥ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiInfo' => [
'description' => '由 ApiInfo 组成的数组格式,返回API的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'Visibility' => ['description' => '可见性,枚举为:'."\n"
."\n"
.'- **PUBLIC**: 公开'."\n"
.'- **PRIVATE**: 私有', 'type' => 'string', 'example' => 'PUBLIC'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Description'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'mygroup'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930'],
'StageName' => ['description' => '环境名称,枚举为:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'TEST'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiInfos\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"3b81fd160f5645e097cc8855d75a1cf6\\",\\n \\"Description\\": \\"Description\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 0009db9c828549768a200320714b8930 \\r\\n mygroup\\r\\n test\\r\\n 3b81fd160f5645e097cc8855d75a1cf6\\r\\n testapi\\r\\n 描述\\r\\n public\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询签名密钥绑定的API列表',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 分页返回'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisBySignature'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisBySignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeApisByTrafficControl' => [
'summary' => '查询指定流控策略下已绑定的API列表信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94327',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '指定查询要用的流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiInfo' => [
'description' => '由 ApiInfo 组成的数组格式,返回API的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'Visibility' => ['description' => '可见性,枚举为:'."\n"
."\n"
.'- **PUBLIC**: 公开'."\n"
.'- **PRIVATE**: 私有', 'type' => 'string', 'example' => 'PUBLIC'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Description'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'mygroup'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930'],
'StageName' => ['description' => '环境名称,枚举为:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'TEST'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'testapi'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiInfos\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"3b81fd160f5645e097cc8855d75a1cf6\\",\\n \\"Description\\": \\"Description\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 0009db9c828549768a200320714b8930 \\r\\n mygroup\\r\\n test\\r\\n 3b81fd160f5645e097cc8855d75a1cf6\\r\\n testapi\\r\\n 描述\\r\\n public\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询指定流控策略下已绑定API列表信息',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 分页返回',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByTrafficControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeApisByVpcAccess' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94328',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'VpcName',
'in' => 'query',
'schema' => ['description' => 'Vpc授权的名称', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'lynkco-iov-uat'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C'],
'PageSize' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条目数', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'ApiVpcAccessInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiVpcAccessInfo' => [
'description' => '由apiinfo组成的数组格式,返回api的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'example' => '09839002de484e76b5a213b040a6a3ca'],
'VpcId' => ['description' => 'vpc id', 'type' => 'string', 'example' => 'vpc-2ze7bj64wstznvftrskbk'],
'InstanceId' => ['description' => 'VPC授权中的实例ID或IP', 'type' => 'string', 'example' => 'Ib-04e41XXXXXd95e9c1'],
'Port' => ['description' => '端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '443'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-shanghai'],
'StageId' => ['description' => '运行环境编号', 'type' => 'string', 'example' => '57e17906a69b4424914fb1e05f67c78a'],
'VpcName' => ['description' => 'VPC授权的名称', 'type' => 'string', 'example' => 'aliYun_service_prod'],
'GroupId' => ['description' => '分组ID', 'type' => 'string', 'example' => '41c33748cbfb41f6b00870156203b72a'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'RT_PLU_IP_CTRL_group'],
'Description' => ['description' => '描述,不超过200个字符', 'type' => 'string', 'example' => '123'],
'StageName' => ['description' => 'API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'iwc'],
'Path' => ['description' => 'API请求路径', 'type' => 'string', 'example' => '/api/v1/friends/rc/status'],
'Method' => ['description' => 'API的请求HTTP Method', 'type' => 'string', 'example' => 'POST'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '通过Vpc授权信息查询绑定该VPC授权的API信息',
'summary' => '查询指定地域内指定api的访问控制绑定情况。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByVpcAccess'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:DescribeApisByVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"4E707B25-5119-5ACF-9D26-7D2A2762F05C\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"ApiVpcAccessInfos\\": {\\n \\"ApiVpcAccessInfo\\": [\\n {\\n \\"ApiId\\": \\"09839002de484e76b5a213b040a6a3ca\\",\\n \\"VpcId\\": \\"vpc-2ze7bj64wstznvftrskbk\\",\\n \\"InstanceId\\": \\"Ib-04e41XXXXXd95e9c1\\",\\n \\"Port\\": 443,\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"StageId\\": \\"57e17906a69b4424914fb1e05f67c78a\\",\\n \\"VpcName\\": \\"aliYun_service_prod\\",\\n \\"GroupId\\": \\"41c33748cbfb41f6b00870156203b72a\\",\\n \\"GroupName\\": \\"RT_PLU_IP_CTRL_group\\",\\n \\"Description\\": \\"123\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"iwc\\",\\n \\"Path\\": \\"/api/v1/friends/rc/status\\",\\n \\"Method\\": \\"POST\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeApisWithStageNameIntegratedByApp' => [
'summary' => '根据应用查询API列表,返回环境聚合的结果。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '191542',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['title' => 'APP的ID', 'description' => 'APP的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页条目', 'description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'ApiUid',
'in' => 'query',
'schema' => ['title' => 'API的ID', 'description' => 'API的ID', 'type' => 'string', 'required' => false, 'example' => 'b19240592b1b4e74961fb8438ed7550c'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'required' => false, 'example' => 'ApiName'],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['title' => 'API请求路径', 'description' => 'API请求路径', 'type' => 'string', 'required' => false, 'example' => '/tt'],
],
[
'name' => 'Method',
'in' => 'query',
'schema' => ['title' => 'API的请求HTTP Method', 'description' => 'API的请求HTTP Method', 'type' => 'string', 'required' => false, 'example' => 'POST'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,不超过200个字符', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
'PageSize' => ['title' => '每页条目', 'description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['title' => '总条目数', 'description' => '总条目数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AppApiRelationInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppApiRelationInfo' => [
'description' => 'API授权信息',
'type' => 'array',
'items' => [
'description' => 'API授权信息',
'type' => 'object',
'properties' => [
'ApiId' => ['title' => 'API的ID', 'description' => 'API的ID', 'type' => 'string', 'example' => 'c625795a1e664782a918eaa629e96ab5'],
'AuthorizationSource' => ['title' => '授权来源', 'description' => '授权来源', 'type' => 'string', 'example' => 'SELF'],
'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'b1008kz'],
'GroupName' => ['title' => '分组名称', 'description' => '分组名称', 'type' => 'string', 'example' => 'manager_vehicles'],
'GroupId' => ['title' => '分组ID', 'description' => '分组ID', 'type' => 'string', 'example' => '38bed48d664149e4b9b5ea576319673f'],
'Operator' => ['description' => '授权的人,取值:'."\n"
."\n"
.'- **PROVIDER**:API所有者'."\n"
.'- **CONSUMER**:API调用者', 'type' => 'string', 'example' => 'PROVIDER'],
'CreatedTime' => ['title' => '授权时间', 'description' => '授权时间', 'type' => 'string', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'],
'ApiName' => ['title' => 'API名称', 'description' => 'API名称', 'type' => 'string', 'example' => 'sd2_h5_player_history_competition'],
'RegionId' => ['title' => '地区ID', 'description' => '地区ID', 'type' => 'string', 'example' => 'cn-shanghai'],
'Path' => ['title' => 'API的请求路径', 'description' => 'API的请求路径', 'type' => 'string', 'example' => '/api/offline/cacheData'],
'Method' => ['title' => 'API的请求HTTP Method', 'description' => 'API的请求HTTP Method', 'type' => 'string', 'example' => 'POST'],
'StageNameAndAuth' => [
'description' => '环境名称与对应环境授权有效期的map集合',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT', 'description' => '授权有效期'],
],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '根据应用查询API列表,返回环境聚合的结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisWithStageNameIntegratedByApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisWithStageNameIntegratedByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AppApiRelationInfos\\": {\\n \\"AppApiRelationInfo\\": [\\n {\\n \\"ApiId\\": \\"c625795a1e664782a918eaa629e96ab5\\",\\n \\"AuthorizationSource\\": \\"SELF\\",\\n \\"Description\\": \\"b1008kz\\",\\n \\"GroupName\\": \\"manager_vehicles\\",\\n \\"GroupId\\": \\"38bed48d664149e4b9b5ea576319673f\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"CreatedTime\\": \\"Sun, 02 Jan 2022 16:00:00 GMT\\",\\n \\"ApiName\\": \\"sd2_h5_player_history_competition\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"Method\\": \\"POST\\",\\n \\"StageNameAndAuth\\": {\\n \\"key\\": \\"Sun, 02 Jan 2022 16:00:00 GMT\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeApp' => [
'summary' => '查询可授权的 APP 列表,为开发者在操作授权时提取 APP 信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94335',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用(app)编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '110843374'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => 'App名称', 'type' => 'string', 'example' => 'CreateApptest'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB'],
'ModifiedTime' => ['description' => 'app修改时间', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z'],
'Description' => ['description' => 'app描述信息', 'type' => 'string', 'example' => 'Estimated on October 15, 2021 at 10:20:27'],
'AppId' => ['description' => 'App的唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '110843374'],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z'],
'Extend' => ['description' => '扩展信息', 'type' => 'string', 'example' => '110243810311'],
'Disabled' => ['type' => 'boolean', 'description' => ''],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppName\\": \\"CreateApptest\\",\\n \\"RequestId\\": \\"DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB\\",\\n \\"ModifiedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"Description\\": \\"Estimated on October 15, 2021 at 10:20:27\\",\\n \\"AppId\\": 110843374,\\n \\"CreatedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"Extend\\": \\"110243810311\\",\\n \\"Disabled\\": true\\n}","type":"json"}]',
'title' => '查询可授权 APP 列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
],
'DescribeAppAttributes' => [
'summary' => '查询APP列表及基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94336',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的编号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'APP名称', 'type' => 'string', 'required' => false, 'example' => 'testApp'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'AppCode',
'in' => 'query',
'schema' => ['description' => '应用的APPCode编码', 'type' => 'string', 'required' => false, 'example' => '23552160'],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'App的Key,用于调用API时使用', 'type' => 'string', 'required' => false, 'example' => '203708622'],
],
[
'name' => 'Sort',
'in' => 'query',
'schema' => ['description' => '排序,默认值是desc,可选asc,desc'."\n"
.'- asc:按修改时间升序排列;'."\n"
.'- desc:按修改时间降序排列', 'type' => 'string', 'required' => false, 'example' => 'desc', 'default' => 'desc'],
],
[
'name' => 'EnableTagAuth',
'in' => 'query',
'schema' => ['description' => '是否启用标签验证', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => '\' \''],
],
'required' => false,
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 20,
],
],
[
'name' => 'Extend',
'in' => 'query',
'schema' => ['description' => '扩展信息', 'type' => 'string', 'required' => false, 'example' => '110243810311'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Apps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppAttribute' => [
'description' => '由 AppAttribute 组成的数组格式,返回app的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => 'APP名称', 'type' => 'string', 'example' => 'CreateApptest'],
'ModifiedTime' => ['description' => '修改时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z'],
'Description' => ['description' => 'APP描述信息', 'type' => 'string', 'example' => 'App test'],
'CreatedTime' => ['description' => '创建时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z'],
'AppId' => ['description' => 'APP编号', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278'],
'Extend' => ['description' => '扩展信息', 'type' => 'string', 'example' => '110461946884'],
'Disabled' => ['type' => 'boolean', 'description' => ''],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'example' => 'appid'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => '123'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询APP列表信息',
'description' => '- 此功能面向调用API的用户'."\n"
.'- AppId可选择性传入',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppAttributes'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"8883AC74-259D-4C0B-99FC-0B7F9A588B2F\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Apps\\": {\\n \\"AppAttribute\\": [\\n {\\n \\"AppName\\": \\"CreateApptest\\",\\n \\"ModifiedTime\\": \\"2016-07-31T04:10:19Z\\",\\n \\"Description\\": \\"App test\\",\\n \\"CreatedTime\\": \\"2016-07-31T04:10:19Z\\",\\n \\"AppId\\": 20112314518278,\\n \\"Extend\\": \\"110461946884\\",\\n \\"Disabled\\": true,\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"appid\\",\\n \\"Value\\": \\"123\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 20112314518278\\r\\n CreateApptest\\r\\n App test\\r\\n 2016-07-31T04:10:19Z\\r\\n 2016-07-31T04:10:19Z\\r\\n \\r\\n \\r\\n ","errorExample":""}]',
],
'DescribeAppSecurities' => [
'summary' => '查询App的密钥信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110862931'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
'AppSecuritys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppSecurity' => [
'description' => '关联的安全策略信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppSecret' => ['description' => '应用AppSecret', 'type' => 'string', 'example' => 'ea5291a7aff343769eb3139a2f6de8c9'],
'ModifiedTime' => ['description' => '修改时间(格林威治时间)', 'type' => 'string', 'example' => '2023-08-14T18:03:00+08:00'],
'AppKey' => ['description' => 'App的key', 'type' => 'string', 'example' => '34379343'],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2021-09-14T18:50:59'],
'AppCode' => ['description' => '应用的AppCode', 'type' => 'string', 'example' => 'd2350ecd62c44cbfbe35a7f182e35105'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询App的密钥信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppSecurities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppSecurities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"AppSecuritys\\": {\\n \\"AppSecurity\\": [\\n {\\n \\"AppSecret\\": \\"ea5291a7aff343769eb3139a2f6de8c9\\",\\n \\"ModifiedTime\\": \\"2023-08-14T18:03:00+08:00\\",\\n \\"AppKey\\": \\"34379343\\",\\n \\"CreatedTime\\": \\"2021-09-14T18:50:59\\",\\n \\"AppCode\\": \\"d2350ecd62c44cbfbe35a7f182e35105\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeAppSecurity' => [
'summary' => '该密钥在调用API时要用作身份认证。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94339',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20112314518278'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => true, 'example' => 'app'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AppSecret' => ['description' => 'App的密码', 'type' => 'string', 'example' => 'c1ae97aaa7e45f21d10824bc44678fee'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'AppKey' => ['description' => 'App的key', 'type' => 'string', 'example' => '60030986'],
'ModifiedTime' => ['description' => '密钥修改时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z'],
'AppCode' => ['description' => '应用的APPCode编码', 'type' => 'string', 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc'],
'CreatedTime' => ['description' => '密钥创建时间(格林威治时间),与app创建时间相同', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z'],
],
'description' => '',
],
],
],
'title' => '查询指定 APP 的密钥信息',
'description' => '- 此功能面向调用API的用户'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppSecurity'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppSecurity',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AppSecret\\": \\"c1ae97aaa7e45f21d10824bc44678fee\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"AppKey\\": \\"60030986\\",\\n \\"ModifiedTime\\": \\"2016-07-31T04:10:19Z\\",\\n \\"AppCode\\": \\"3aaf905a0a1f4f0eabc6d891dfa08afc\\",\\n \\"CreatedTime\\": \\"2016-07-31T04:10:19Z\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n 60030986\\r\\n c1ae97aaa7e45f21d10824bc44678fee\\r\\n 2016-07-31T04:10:19Z\\r\\n 2016-07-31T04:10:19Z\\r\\n","errorExample":""}]',
],
'DescribeApps' => [
'summary' => '查询应用列表,非APP拥有者会隐藏APP的信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94337',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278'],
],
[
'name' => 'AppOwner',
'in' => 'query',
'schema' => ['description' => 'App拥有者的阿里云账号ID(账号ID请到[账号管理](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3a8c196eVWxvQB#/secure)页面查看)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1546564'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Apps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppItem' => [
'description' => '由 AppItem 组成的数组格式,返回app的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => 'APP名称', 'type' => 'string', 'example' => 'CreateApptest'],
'Description' => ['description' => 'APP描述信息', 'type' => 'string', 'example' => 'App test'],
'AppId' => ['description' => 'APP编号', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询应用列表',
'description' => '- 此功能面向开放API的用户'."\n"
.'- API开放者可通过AppId或者阿里云登录账号查询app信息,进而操作授权'."\n"
.'- 每个用户在每个Region每天调用次数上限为200次'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApps'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Apps\\": {\\n \\"AppItem\\": [\\n {\\n \\"AppName\\": \\"CreateApptest\\",\\n \\"Description\\": \\"App test\\",\\n \\"AppId\\": 20112314518278\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 20112314518278\\r\\n CreateApptest\\r\\n App test\\r\\n \\r\\n \\r\\n ","errorExample":""}]',
],
'DescribeAppsByApiProduct' => [
'summary' => '根据API产品查询授权了的APP列表',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'App名称', 'type' => 'string', 'required' => false, 'example' => 'testApp'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'AC866798-62D3-52F4-8AB5-CA149A53984F'],
'PageSize' => ['description' => '分页参数:每页显示条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'AuthorizedApps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AuthorizedApp' => [
'description' => '授权的APP信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => 'App名称', 'type' => 'string', 'example' => 'APP_02580_DEV'],
'Description' => ['description' => '授权说明', 'type' => 'string', 'example' => 'Authorization description'],
'AuthValidTime' => ['description' => '授权有效时间的截止时间,格林尼治标准时间(GMT),如果为空,即为授权永久有效', 'type' => 'string', 'example' => '2023-06-17T03:41:53Z'],
'AppId' => ['description' => 'App的ID', 'type' => 'integer', 'format' => 'int64', 'example' => '110982419'],
'Extend' => ['description' => '扩展信息', 'type' => 'string', 'example' => 'extra info'],
'AuthorizedTime' => ['description' => '授权操作的时间,格林尼治标准时间(GMT)', 'type' => 'string', 'example' => '2016-07-21T06:17:20Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC866798-62D3-52F4-8AB5-CA149A53984F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 4,\\n \\"AuthorizedApps\\": {\\n \\"AuthorizedApp\\": [\\n {\\n \\"AppName\\": \\"APP_02580_DEV\\",\\n \\"Description\\": \\"Authorization description\\",\\n \\"AuthValidTime\\": \\"2023-06-17T03:41:53Z\\",\\n \\"AppId\\": 110982419,\\n \\"Extend\\": \\"extra info\\",\\n \\"AuthorizedTime\\": \\"2016-07-21T06:17:20Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据API产品查询授权了的APP列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppsByApiProduct'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppsByApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeAuthorizedApis' => [
'summary' => '查询指定 APP 已授权的API列表,即指定 APP 的API列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94342',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AuthorizedApis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AuthorizedApi' => [
'description' => '已授权的API集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => '系统自动生成API唯一标识符', 'type' => 'string', 'example' => 'baacc592e63a4cb6a41920d9d3f91f38'],
'AuthorizationSource' => ['description' => '授权来源,取值:'."\n"
."\n"
.'- **CONSOLE**:控制台'."\n"
.'- **API**:API', 'type' => 'string', 'example' => 'CONSOLE'],
'AuthVaildTime' => ['description' => '授权有效时间的截止时间,格林威治时间', 'type' => 'string', 'example' => '2018-10-05T16:00:00Z'],
'Description' => ['description' => '授权说明', 'type' => 'string', 'example' => 'Query weather by region name'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'Weather'],
'GroupId' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
'AuthorizedTime' => ['description' => '授权操作的时间,格林威治时间', 'type' => 'string', 'example' => '2016-07-21T06:17:20'],
'Operator' => ['description' => '授权的人,取值:'."\n"
."\n"
.'- **PROVIDER**:API所有者'."\n"
.'- **CONSUMER**:API调用者', 'type' => 'string', 'example' => 'PROVIDER'],
'StageName' => ['description' => 'API环境,取值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'AreaWeather'],
'RegionId' => ['description' => 'API所在区域', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AuthorizedApis\\": {\\n \\"AuthorizedApi\\": [\\n {\\n \\"ApiId\\": \\"baacc592e63a4cb6a41920d9d3f91f38\\",\\n \\"AuthorizationSource\\": \\"CONSOLE\\",\\n \\"AuthVaildTime\\": \\"2018-10-05T16:00:00Z\\",\\n \\"Description\\": \\"Query weather by region name\\",\\n \\"GroupName\\": \\"Weather\\",\\n \\"GroupId\\": \\"523e8dc7bbe04613b5b1d726c2a7889d\\",\\n \\"AuthorizedTime\\": \\"2016-07-21T06:17:20\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"AreaWeather\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n 2\\r\\n 10\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n \\r\\n \\r\\n cn-hangzhou\\r\\n 523e8dc7bbe04613b5b1d726c2a7889d\\r\\n Weather\\r\\n RELEASE\\r\\n PROVIDER\\r\\n baacc592e63a4cb6a41920d9d3f91f38\\r\\n AreaWeather\\r\\n CONSOLE\\r\\n 根据地区名称查询天气情况\\r\\n 2016-07-21T06:17:20Z\\r\\n 2018-10-05T16:00:00Z\\r\\n \\r\\n \\r\\n cn-hangzhou\\r\\n 523e8dc7bbe04613b5b1d726c2a7889d\\r\\n Weather\\r\\n RELEASE\\r\\n CONSUMER\\r\\n baacc592e63a4cb6a41920d9d3f89g76\\r\\n Area\\r\\n API\\r\\n 查询区域\\r\\n 2016-07-21T06:17:20Z\\r\\n \\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询已授权的API列表',
'description' => '- 此功能面向API使用者'."\n"
.'- App可以调用查询结果返回的所有API ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuthorizedApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAuthorizedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
],
'DescribeAuthorizedApps' => [
'summary' => '查询当前的应用(APP)列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94343',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => [
'description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RELEASE' => 'RELEASE'],
'example' => 'RELEASE',
],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App编号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => 'App名称', 'type' => 'string', 'required' => false, 'example' => 'CreateApptest'],
],
[
'name' => 'AppOwnerId',
'in' => 'query',
'schema' => ['description' => 'App拥有者的阿里云账号ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1546564'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AuthorizedApps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AuthorizedApp' => [
'description' => '返回分组集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppName' => ['description' => '应用名称', 'type' => 'string', 'example' => 'Weather'],
'AuthorizationSource' => ['description' => '授权来源,取值:'."\n"
."\n"
.'- **CONSOLE**:控制台'."\n"
.'- **API**:API', 'type' => 'string', 'example' => 'CONSOLE'],
'AuthVaildTime' => ['description' => '应用名称', 'type' => 'string', 'example' => '2018-10-05T16:00:00Z'],
'Description' => ['description' => '授权说明', 'type' => 'string', 'example' => 'Query weather by region name'],
'AuthorizedTime' => ['description' => '授权操作的时间,格林威治时间', 'type' => 'string', 'example' => '2016-07-21T06:17:20Z'],
'AppId' => ['description' => '编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'example' => '2386789'],
'StageName' => ['description' => 'API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => 'Production'],
'Operator' => ['description' => '授权的人,取值:'."\n"
."\n"
.'- **PROVIDER**:API所有者'."\n"
.'- **CONSUMER**:API调用者', 'type' => 'string', 'example' => 'PROVIDER'],
'AppDescription' => ['description' => '应用描述信息', 'type' => 'string', 'example' => 'Production application'],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签键',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'example' => 'DEV'],
'Value' => ['description' => '标签的value'."\n", 'type' => 'string', 'example' => '240'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AuthorizedApps\\": {\\n \\"AuthorizedApp\\": [\\n {\\n \\"AppName\\": \\"Weather\\",\\n \\"AuthorizationSource\\": \\"CONSOLE\\",\\n \\"AuthVaildTime\\": \\"2018-10-05T16:00:00Z\\",\\n \\"Description\\": \\"Query weather by region name\\",\\n \\"AuthorizedTime\\": \\"2016-07-21T06:17:20Z\\",\\n \\"AppId\\": 2386789,\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"Production\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"AppDescription\\": \\"Production application\\",\\n \\"Tag\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"DEV\\",\\n \\"Value\\": \\"240\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 2\\r\\n 1\\r\\n 10\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n \\r\\n \\r\\n RELEASE\\r\\n 2386789\\r\\n 天气app\\r\\n PROVIDER\\r\\n CONSOLE\\r\\n 根据地区名称查询天气情况\\r\\n 2016-07-21T06:17:20Z\\r\\n 2018-10-05T16:00:00Z \\r\\n \\r\\n \\r\\n TEST\\r\\n 2386789\\r\\n 天气app\\r\\n CONSUMER\\r\\n API\\r\\n 根据地区名称查询天气情况\\r\\n 2016-07-21T06:17:20Z\\r\\n \\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询可访问APP列表',
'description' => '- 此功能面向API提供者'."\n"
.'- 查询结果返回的所有应用(app)均可访问指定的API',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuthorizedApps'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAuthorizedApps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeBackendInfo' => [
'summary' => '查询后端服务的信息以及在各个环境上配置的后端地址。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '115431',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '739b68751c0b4e899e04d0c92b6d0be7'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231'],
'BackendInfo' => [
'description' => '后端服务信息',
'type' => 'object',
'properties' => [
'BackendName' => ['description' => '后端服务名称', 'type' => 'string', 'example' => 'testoss2'],
'BackendType' => ['description' => '后端服务类型', 'type' => 'string', 'example' => 'HTTP'],
'ModifiedTime' => ['description' => '后端服务修改时间', 'type' => 'string', 'example' => '2017-12-11T15:18:09+08:00'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'add'],
'CreatedTime' => ['description' => '后端服务创建时间', 'type' => 'string', 'example' => '2021-11-22T11:10:46+08:00'],
'BackendId' => ['description' => '后端服务ID', 'type' => 'string', 'example' => '6fc978bb63574146b766863dd7bdf661'],
'BackendModels' => [
'description' => '后端服务在环境上的配置信息',
'type' => 'array',
'items' => [
'description' => '后端服务在环境上的配置信息',
'type' => 'object',
'properties' => [
'BackendModelId' => ['description' => '后端服务在环境上的配置ID', 'type' => 'string', 'example' => '5c4995d08e8b4954b0f326e8e4f2b97d'],
'StageModeId' => ['description' => '环境ID', 'type' => 'string', 'example' => '6fc978bb63574146b766863dd7bdf661'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'testDvs 1'],
'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2021-12-20T03:22:03.000+0000'],
'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2021-12-20T03:22:03.000+0000'],
'StageName' => ['description' => '环境名称', 'type' => 'string', 'example' => 'RELEASE'],
'BackendConfig' => [
'description' => '后端配置',
'type' => 'object',
'properties' => [
'ServiceAddress' => ['description' => '后端服务地址', 'type' => 'string', 'example' => '10.0.0.1'],
'HttpTargetHostName' => ['description' => 'HTTP类型后端服务的host', 'type' => 'string', 'example' => 'test.com'],
'Type' => ['description' => '后端服务类型。', 'type' => 'string', 'example' => 'VPC'],
'VpcConfig' => [
'description' => '后端为VPC的信息',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-wz9v96hqi6d14744sxqmx'],
'InstanceId' => ['description' => '专用网络中的实例ID(ECS/SLB)', 'type' => 'string', 'example' => 'i-uf6iaale3gfef9t9cb41'],
'Port' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int64', 'example' => '8080'],
'VpcAccessId' => ['description' => 'vpc授权ID', 'type' => 'string', 'example' => '2zej3ehuzg9m77kvwnfpn'],
'Name' => ['description' => 'VPC 配置名称', 'type' => 'string', 'example' => 'dypls-cn-beijing-slb-pre'],
'VpcScheme' => ['description' => 'http/https协议', 'type' => 'string', 'example' => 'http'],
'VpcTargetHostName' => ['description' => 'vpc类型后端服务的host', 'type' => 'string', 'example' => 'openapi.alipan.com'],
],
],
'FunctionComputeConfig' => [
'description' => '后端为函数计算的信息',
'type' => 'object',
'properties' => [
'FcType' => ['description' => '函数计算服务类型', 'type' => 'string', 'example' => 'HttpTrigger'],
'FcRegionId' => ['description' => '函数计算服务的区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ServiceName' => ['description' => '函数计算定义的ServiceName', 'type' => 'string', 'example' => 'myservice'],
'FunctionName' => ['description' => '函数计算定义的FunctionName', 'type' => 'string', 'example' => 'edge_function'],
'RoleArn' => ['description' => 'Ram授权给API网关访问函数计算的arn', 'type' => 'string', 'example' => 'acs:ram::31985*:role/aliyunserviceroleforbastionhostpam'],
'Qualifier' => ['description' => '函数别名', 'type' => 'string', 'example' => 'testQualifier'],
'FcBaseUrl' => ['description' => '函数计算服务根路径', 'type' => 'string', 'example' => 'https://t*******.ap-*****.fcapp.run/'],
'OnlyBusinessPath' => ['description' => '后端只接收业务path', 'type' => 'boolean', 'example' => 'false'],
'TriggerName' => ['type' => 'string', 'description' => ''],
],
],
'OssConfig' => [
'description' => '后端为OSS的信息',
'type' => 'object',
'properties' => [
'OssRegionId' => ['description' => 'OSS 服务地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'BucketName' => ['description' => 'OSS 桶名', 'type' => 'string', 'example' => 'my_bucket'],
],
],
'EventBridgeConfig' => [
'description' => '后端为 EventBridge 的配置',
'type' => 'object',
'properties' => [
'EventBridgeRegionId' => ['description' => '事件总线服务所在区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'EventSource' => ['description' => '事件来源。'."\n", 'type' => 'string', 'example' => 'dds_driver'],
'EventBus' => ['description' => '事件总线', 'type' => 'string', 'example' => 'testBus'],
'RoleArn' => ['description' => 'Ram授权给EventBridge的arn', 'type' => 'string', 'example' => 'acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport'],
],
],
'MockConfig' => [
'description' => 'Mock配置信息',
'type' => 'object',
'properties' => [
'MockResult' => ['description' => 'Mock返回结果', 'type' => 'string', 'example' => 'test'."\n"],
'MockStatusCode' => ['description' => 'Mock返回状态码', 'type' => 'string', 'example' => '200'],
'MockHeaders' => [
'description' => 'Mock返回的Header',
'type' => 'array',
'items' => [
'description' => 'Mock信息',
'type' => 'object',
'properties' => [
'HeaderName' => ['description' => 'Header参数名。', 'type' => 'string', 'example' => 'test'."\n"],
'HeaderValue' => ['description' => '参数对应的值。', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
'DiscoveryConfig' => [
'description' => '服务发现类型后端的配置信息',
'type' => 'object',
'properties' => [
'RcType' => ['description' => '注册中心类型', 'type' => 'string', 'example' => 'NACOS'],
'NacosConfig' => [
'description' => 'Nacos配置信息',
'type' => 'object',
'properties' => [
'ServerAddress' => ['description' => 'Nacos服务地址', 'type' => 'string', 'example' => 'http://1xx.2xx.3xx.4xx:8848'],
'Namespace' => ['description' => '注册在Nacos上的微服务所在的命名空间ID', 'type' => 'string', 'example' => 'public'],
'GroupName' => ['description' => '注册在Nacos上的微服务所在的分组名称', 'type' => 'string', 'example' => 'DEFAULT_GROUP'],
'ServiceName' => ['description' => '微服务名称', 'type' => 'string', 'example' => 'service-provider'],
'Clusters' => ['description' => '微服务所在的集群名称', 'type' => 'string', 'example' => 'cluster1'],
'AuthType' => ['description' => '鉴权方式', 'type' => 'string', 'example' => 'PASSWORD'],
'UserName' => ['description' => '用户名', 'type' => 'string', 'example' => 'username'],
'Password' => ['description' => '密码', 'type' => 'string', 'example' => 'password'],
'AccessKey' => ['description' => '具有mse资源管理权限的子账号的accessKey', 'type' => 'string', 'example' => 'A5FIDxxxxxx'],
'SecretKey' => ['description' => '具有mse资源管理权限的子账号的secretKey', 'type' => 'string', 'example' => 'dl5loxxxxxx'],
],
],
'ZookeeperConfig' => [
'description' => 'Zookeeper配置信息',
'type' => 'object',
'properties' => [
'ConnectString' => ['description' => 'Zookeeper服务器连接地址', 'type' => 'string', 'example' => 'http://192.168.1.xxx:2181'],
'Namespace' => ['description' => '命名空间', 'type' => 'string', 'example' => 'provider'],
'ServiceName' => ['description' => '服务名称', 'type' => 'string', 'example' => 'service'],
],
],
],
],
'ServiceTimeout' => ['description' => '后端服务超时时间,单位:毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
'EdasConfig' => [
'description' => 'Edas配置信息',
'type' => 'object',
'properties' => [
'MicroserviceNamespaceName' => ['description' => 'Edas微服务命名空间名称', 'type' => 'string', 'example' => 'Edas-Nacos'],
'MicroserviceNamespaceId' => ['description' => 'Edas微服务命名空间ID', 'type' => 'string', 'example' => 'cn-hangzhou:edasNacos'],
'MicroserviceNamespace' => ['description' => 'Edas微服务命名空间ID', 'type' => 'string', 'example' => 'cn-hangzhou:edasNacos'."\n"],
'ServiceName' => ['description' => '服务名称', 'type' => 'string', 'example' => 'service'],
'EdasAppId' => ['description' => 'Edas应用ID', 'type' => 'string', 'example' => '6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx'],
'RegistryType' => ['description' => '注册类型', 'type' => 'string', 'example' => 'EDAS'],
'MseInstanceId' => ['description' => 'MSE注册中心实例ID', 'type' => 'string', 'example' => 'mse-cn-jia3n1rxxxx'],
],
],
],
],
],
],
],
],
],
],
],
],
],
'title' => '查询后端服务的信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendInfo'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeBackendInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AA90E87-3506-5AA6-AFFB-A4D53B4F6231\\",\\n \\"BackendInfo\\": {\\n \\"BackendName\\": \\"testoss2\\",\\n \\"BackendType\\": \\"HTTP\\",\\n \\"ModifiedTime\\": \\"2017-12-11T15:18:09+08:00\\",\\n \\"Description\\": \\"add\\",\\n \\"CreatedTime\\": \\"2021-11-22T11:10:46+08:00\\",\\n \\"BackendId\\": \\"6fc978bb63574146b766863dd7bdf661\\",\\n \\"BackendModels\\": [\\n {\\n \\"BackendModelId\\": \\"5c4995d08e8b4954b0f326e8e4f2b97d\\",\\n \\"StageModeId\\": \\"6fc978bb63574146b766863dd7bdf661\\",\\n \\"Description\\": \\"testDvs 1\\",\\n \\"GmtCreate\\": \\"2021-12-20T03:22:03.000+0000\\",\\n \\"GmtModified\\": \\"2021-12-20T03:22:03.000+0000\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"BackendConfig\\": {\\n \\"ServiceAddress\\": \\"10.0.0.1\\",\\n \\"HttpTargetHostName\\": \\"test.com\\",\\n \\"Type\\": \\"VPC\\",\\n \\"VpcConfig\\": {\\n \\"VpcId\\": \\"vpc-wz9v96hqi6d14744sxqmx\\",\\n \\"InstanceId\\": \\"i-uf6iaale3gfef9t9cb41\\",\\n \\"Port\\": 8080,\\n \\"VpcAccessId\\": \\"2zej3ehuzg9m77kvwnfpn\\",\\n \\"Name\\": \\"dypls-cn-beijing-slb-pre\\",\\n \\"VpcScheme\\": \\"http\\",\\n \\"VpcTargetHostName\\": \\"openapi.alipan.com\\"\\n },\\n \\"FunctionComputeConfig\\": {\\n \\"FcType\\": \\"HttpTrigger\\",\\n \\"FcRegionId\\": \\"cn-hangzhou\\",\\n \\"ServiceName\\": \\"myservice\\",\\n \\"FunctionName\\": \\"edge_function\\",\\n \\"RoleArn\\": \\"acs:ram::31985*:role/aliyunserviceroleforbastionhostpam\\",\\n \\"Qualifier\\": \\"testQualifier\\",\\n \\"FcBaseUrl\\": \\"https://t*******.ap-*****.fcapp.run/\\",\\n \\"OnlyBusinessPath\\": false,\\n \\"TriggerName\\": \\"\\"\\n },\\n \\"OssConfig\\": {\\n \\"OssRegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"my_bucket\\"\\n },\\n \\"EventBridgeConfig\\": {\\n \\"EventBridgeRegionId\\": \\"cn-hangzhou\\",\\n \\"EventSource\\": \\"dds_driver\\",\\n \\"EventBus\\": \\"testBus\\",\\n \\"RoleArn\\": \\"acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport\\"\\n },\\n \\"MockConfig\\": {\\n \\"MockResult\\": \\"test\\\\n\\",\\n \\"MockStatusCode\\": \\"200\\",\\n \\"MockHeaders\\": [\\n {\\n \\"HeaderName\\": \\"test\\\\n\\",\\n \\"HeaderValue\\": \\"123\\"\\n }\\n ]\\n },\\n \\"DiscoveryConfig\\": {\\n \\"RcType\\": \\"NACOS\\",\\n \\"NacosConfig\\": {\\n \\"ServerAddress\\": \\"http://1xx.2xx.3xx.4xx:8848\\",\\n \\"Namespace\\": \\"public\\",\\n \\"GroupName\\": \\"DEFAULT_GROUP\\",\\n \\"ServiceName\\": \\"service-provider\\",\\n \\"Clusters\\": \\"cluster1\\",\\n \\"AuthType\\": \\"PASSWORD\\",\\n \\"UserName\\": \\"username\\",\\n \\"Password\\": \\"password\\",\\n \\"AccessKey\\": \\"A5FIDxxxxxx\\",\\n \\"SecretKey\\": \\"dl5loxxxxxx\\"\\n },\\n \\"ZookeeperConfig\\": {\\n \\"ConnectString\\": \\"http://192.168.1.xxx:2181\\",\\n \\"Namespace\\": \\"provider\\",\\n \\"ServiceName\\": \\"service\\"\\n }\\n },\\n \\"ServiceTimeout\\": 10000,\\n \\"EdasConfig\\": {\\n \\"MicroserviceNamespaceName\\": \\"Edas-Nacos\\",\\n \\"MicroserviceNamespaceId\\": \\"cn-hangzhou:edasNacos\\",\\n \\"MicroserviceNamespace\\": \\"cn-hangzhou:edasNacos\\\\n\\",\\n \\"ServiceName\\": \\"service\\",\\n \\"EdasAppId\\": \\"6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx\\",\\n \\"RegistryType\\": \\"EDAS\\",\\n \\"MseInstanceId\\": \\"mse-cn-jia3n1rxxxx\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeBackendList' => [
'summary' => '查询后端服务列表,可以根据后端服务名称和后端服务类型进行过滤。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '114857',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'BackendName',
'in' => 'query',
'schema' => ['description' => '后端服务名称,支持使用*进行模糊查询。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'],
],
[
'name' => 'BackendType',
'in' => 'query',
'schema' => ['description' => '后端服务类型', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HTTP'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'test1'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页参数:当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '090A0DF9-9144-5236-8CBA-E18DE317722D'],
'PageSize' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BackendInfoList' => [
'description' => '后端服务列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BackendName' => ['description' => '后端服务名称', 'type' => 'string', 'example' => 'test'],
'BackendType' => ['description' => '后端服务类型', 'type' => 'string', 'example' => 'HTTP'],
'ModifiedTime' => ['description' => '后端服务修改时间', 'type' => 'string', 'example' => '2022-01-25T11:22:29Z'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'test'],
'CreatedTime' => ['description' => '后端服务创建时间', 'type' => 'string', 'example' => '2022-01-25T11:22:29Z'],
'BackendId' => ['description' => '后端服务id', 'type' => 'string', 'example' => '35bd31d32c9c425ebbe9330db9f8c375'],
'Tags' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'example' => 'groupName'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'example' => 'e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'title' => '查询后端服务列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeBackendList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"090A0DF9-9144-5236-8CBA-E18DE317722D\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"BackendInfoList\\": [\\n {\\n \\"BackendName\\": \\"test\\",\\n \\"BackendType\\": \\"HTTP\\",\\n \\"ModifiedTime\\": \\"2022-01-25T11:22:29Z\\",\\n \\"Description\\": \\"test\\",\\n \\"CreatedTime\\": \\"2022-01-25T11:22:29Z\\",\\n \\"BackendId\\": \\"35bd31d32c9c425ebbe9330db9f8c375\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"groupName\\",\\n \\"Value\\": \\"e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDatasetInfo' => [
'summary' => '查询单个数据集信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '155066',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A2C8F75E-EE84-5C64-960F-45C8********'],
'DatasetInfo' => [
'description' => '数据集信息',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => '62b91a790a693238********'],
'DatasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'DatasetName'],
'DatasetType' => ['description' => '数据集类型,可选值:'."\n"
.'- JWT_BLOCKING : JWT黑名单'."\n"
.'- IP\\_WHITELIST\\_CIDR : IP白名单'."\n"
.'- PARAMETER_ACCESS : 参数访问控制', 'type' => 'string', 'example' => 'JWT_BLOCKING'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'],
'Description' => ['type' => 'string', 'description' => ''],
],
],
],
'description' => '',
],
],
],
'title' => '查询数据集信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetInfo'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A2C8F75E-EE84-5C64-960F-45C8********\\",\\n \\"DatasetInfo\\": {\\n \\"DatasetId\\": \\"62b91a790a693238********\\",\\n \\"DatasetName\\": \\"DatasetName\\",\\n \\"DatasetType\\": \\"JWT_BLOCKING\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"Description\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'DescribeDatasetItemInfo' => [
'summary' => '查询用户自定义数据集的数据集条目信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '155080',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '62b91a790a693238********'],
],
[
'name' => 'DatasetItemId',
'in' => 'query',
'schema' => ['description' => '数据集条目ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5045****'],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '数据值', 'type' => 'string', 'required' => false, 'example' => '106.43.XXX.XXX'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5BAFA85F-38E3-5D9E-9E32-4B09********'],
'DatasetItemInfo' => [
'description' => '数据集信息',
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => '626238665db4a5140eea3e40********'],
'DatasetItemId' => ['description' => '数据集条目ID', 'type' => 'string', 'example' => '5045****'],
'Value' => ['description' => '数据值', 'type' => 'string', 'example' => '106.43.XXX.XXX'],
'ExpiredTime' => ['description' => '数据条目超时时间,格式为**yyyy-MM-ddTHH:mm:ssZ(UTC时间)**'."\n"
.'为空时表示永不过期', 'type' => 'string', 'example' => '2022-09-22T12:00:00Z'."\n"],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n"],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n"],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Description'],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BAFA85F-38E3-5D9E-9E32-4B09********\\",\\n \\"DatasetItemInfo\\": {\\n \\"DatasetId\\": \\"626238665db4a5140eea3e40********\\",\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"Value\\": \\"106.43.XXX.XXX\\",\\n \\"ExpiredTime\\": \\"2022-09-22T12:00:00Z\\\\n\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"Description\\": \\"Description\\"\\n }\\n}","type":"json"}]',
'title' => '查询数据集条目信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemInfo'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetItemInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
],
'DescribeDatasetItemList' => [
'summary' => '查询用户自定义数据集的数据条目列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '155090',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'example' => '602e1f6b3543200eaab0a89e********'],
],
[
'name' => 'DatasetItemIds',
'in' => 'query',
'schema' => ['description' => '数据集条目ID,支持填写多个ID,用","分隔', 'type' => 'string', 'required' => false, 'example' => '5045****'."\n"],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数,每页显示条数,默认值10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C6E9C6E4-608B-5C0F-9783-E288********'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回数据总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'DatasetItemInfoList' => [
'description' => '数据集条目信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => ' '."\n"
.'4add6a61804e47858266883e********'."\n"],
'DatasetItemId' => ['description' => '数据集条目ID', 'type' => 'string', 'example' => '5045****'],
'Value' => ['description' => '数据值', 'type' => 'string', 'example' => '106.43.XXX.XXX'],
'ExpiredTime' => ['description' => '数据条目超时时间,格式为**yyyy-MM-ddTHH:mm:ssZ(UTC时间)**'."\n"
.'为空时表示永不过期', 'type' => 'string', 'example' => '2022-09-22T12:00:00Z'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Description'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"C6E9C6E4-608B-5C0F-9783-E288********\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DatasetItemInfoList\\": [\\n {\\n \\"DatasetId\\": \\"\\\\t\\\\n4add6a61804e47858266883e********\\\\n\\",\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"Value\\": \\"106.43.XXX.XXX\\",\\n \\"ExpiredTime\\": \\"2022-09-22T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"Description\\": \\"Description\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询数据集条目列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetItemList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
],
'DescribeDatasetList' => [
'summary' => '查询用户自定义数据集列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '155070',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'DatasetIds',
'in' => 'query',
'schema' => ['description' => '数据集ID(支持输入多个数据集ID,用","分隔)', 'type' => 'string', 'required' => false, 'example' => '4add6a61804e47858266883e********'],
],
[
'name' => 'DatasetName',
'in' => 'query',
'schema' => ['description' => '插件数据集名称', 'type' => 'string', 'required' => false, 'example' => 'IPwhitelist'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数,每页显示条数,默认值10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D403C6E6-21B3-5B78-82DA-E3B6********'],
'PageSize' => ['description' => '返回指定的每页条数'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'DatasetInfoList' => [
'description' => '由datasetinfo组成的数组格式,返回数据集信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DatasetId' => ['description' => '数据集ID', 'type' => 'string', 'example' => '6304ce6b4ae6453f********'],
'DatasetName' => ['description' => '数据集名称', 'type' => 'string', 'example' => 'DatasetName'],
'DatasetType' => ['description' => '数据集类型,可选值:'."\n"
.'- JWT_BLOCKING : JWT黑名单'."\n"
.'- IP\\_WHITELIST\\_CIDR : IP白名单'."\n"
.'- PARAMETER_ACCESS : 参数访问控制', 'type' => 'string', 'example' => 'IP_WHITELIST_CIDR'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n"],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n"],
'Tags' => [
'description' => '标签',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的键', 'type' => 'string', 'example' => 'ENV'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => '123'],
],
'description' => '',
],
],
'Description' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'title' => '查询数据集列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D403C6E6-21B3-5B78-82DA-E3B6********\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DatasetInfoList\\": [\\n {\\n \\"DatasetId\\": \\"6304ce6b4ae6453f********\\",\\n \\"DatasetName\\": \\"DatasetName\\",\\n \\"DatasetType\\": \\"IP_WHITELIST_CIDR\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"ENV\\",\\n \\"Value\\": \\"123\\"\\n }\\n ],\\n \\"Description\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDeployApiTask' => [
'summary' => '查询发布API的异步任务的进度。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94350',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'OperationUid',
'in' => 'query',
'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51524fb8f12846d694d0a1de9a0cf274'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4'],
'DeployedResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeployedResult' => [
'description' => '返回结果',
'type' => 'array',
'items' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Success. Request Success.'],
'StageName' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'example' => 'RELEASE'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b'],
'ApiUid' => ['description' => 'API 唯一标识', 'type' => 'string', 'example' => '0433c1cd84724923b7a4f9ca1cfc249c'],
'DeployedStatus' => ['description' => '部署状态', 'type' => 'string', 'example' => 'OVER'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询发布API任务进度',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployApiTask'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployApiTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA4B3261-F14A-5E33-8608-F75A1DF27AD4\\",\\n \\"DeployedResults\\": {\\n \\"DeployedResult\\": [\\n {\\n \\"ErrorMsg\\": \\"Success. Request Success.\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"GroupId\\": \\"e8da6f6346184da9a30d0dc1888b1f3b\\",\\n \\"ApiUid\\": \\"0433c1cd84724923b7a4f9ca1cfc249c\\",\\n \\"DeployedStatus\\": \\"OVER\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeDeployedApi' => [
'summary' => '查询指定API在指定环境中正在运行的定义,是真正在指定环境中生效的定义,可能跟正在编辑中的定义不同。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94351',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '81750604ccff48c48f34d6c0165e09db'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ab7c95a01a7e42f28718f34497bbf47c'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => '4eed13a57d4e42fbb51316be8a5329ff'],
'ResultType' => ['description' => '后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。默认为JSON。', 'type' => 'string', 'example' => 'HTML'],
'DisableInternet' => ['description' => '- 设置DisableInternet为**true**, 仅支持内网调用API。'."\n"
.'- 设置DisableInternet为**false**, 则不限制调用。'."\n"
."\n"
.'> 修改API时,不设置则不修改原来的取值。', 'type' => 'boolean', 'example' => 'true'],
'ResultBodyModel' => ['description' => 'api的返回结果', 'type' => 'string', 'example' => '{}'],
'ResultSample' => ['description' => '后端服务返回应答的示例', 'type' => 'string', 'example' => '{code: 200, message:\'success\', data: \'\'}'],
'AllowSignatureMethod' => ['description' => 'API的客户端请求签名方法,可选值:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256'],
'RegionId' => ['description' => '分组所在区域', 'type' => 'string', 'example' => 'cn-beijing'],
'ForceNonceCheck' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
."\n"
.'- 设置**ForceNonceCheck**为**false**,则不检查。创建API时默认为false。', 'type' => 'boolean', 'example' => 'true'],
'Visibility' => ['description' => 'API是否公开,可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。', 'type' => 'string', 'example' => 'PUBLIC'],
'FailResultSample' => ['description' => '后端服务失败返回应答的示例', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}'],
'AuthType' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。', 'type' => 'string', 'example' => 'APP'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Error description'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'Weather'],
'GroupId' => ['description' => '分组编号', 'type' => 'string', 'example' => 'bc77f5b49c974437a9912ea3755cd834'],
'DeployedTime' => ['description' => '部署时间,格式为yyyy-mm-ddhh:mm:ss', 'type' => 'string', 'example' => '2022-07-25T17:47:51Z'],
'StageName' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'weather'],
'RequestConfig' => [
'description' => 'Consumer向网关发送API请求的相关配置项。'."\n"
."\n"
.'更多信息,请参见[RequestConfig](~~43985~~)。',
'type' => 'object',
'properties' => [
'BodyModel' => ['description' => 'body模型'."\n"
."\n", 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab'],
'RequestPath' => ['description' => 'API path,比如API的完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,path是指`/object/add`这一部分。', 'type' => 'string', 'example' => '/api/billing/test/[type]'],
'RequestHttpMethod' => ['description' => 'HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'example' => 'POST'],
'BodyFormat' => ['description' => '当**RequestMode**值为**MAPPING**时有效。'."\n"
."\n"
.'POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:**FORM**、**STREAM**,分别表示表单形式(k-v对应)、字节流形式。', 'type' => 'string', 'example' => 'STREAM'],
'RequestMode' => ['description' => '入参请求的模式,取值为:'."\n"
."\n"
.'- MAPPING:入参映射(过滤未知参数)'."\n"
."\n"
.'- PASSTHROUGH:入参透传'."\n"
."\n"
.'- MAPPING_PASSTHROUGH:入参映射(透传未知参数)', 'type' => 'string', 'example' => 'MAPPING'],
'PostBodyDescription' => ['description' => '请求body描述', 'type' => 'string', 'example' => 'fwefwef'],
'RequestProtocol' => ['description' => 'API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:"HTTP,HTTPS",取值为:HTTP、HTTPS、WebSocket', 'type' => 'string', 'example' => 'HTTP'],
],
],
'ServiceConfig' => [
'description' => '网关向后端服务发送API请求的相关配置项。'."\n"
."\n"
.'更多信息,请参见[ServiceConfig](~~43987~~)。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-uf6kg9x8sx2tbxxxx'],
'MockStatusCode' => ['description' => 'Mock返回状态码'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ServicePath' => ['description' => '调用后端服务path,比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,**ServicePath**是指`/object/add`这一部分。', 'type' => 'string', 'example' => '/object/add'],
'Mock' => ['description' => '是否采取Mock模式,目前可以取值:'."\n"
."\n"
.'- **TRUE**:启用Mock模式'."\n"
.'- **FALSE**:不启用Mock模式', 'type' => 'string', 'example' => 'TRUE'],
'ServiceAddress' => ['description' => '调用后端服务地址,比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,**ServiceAddress**是指`http://api.a.com:8080`这一部分。', 'type' => 'string', 'example' => 'http://api.a.com:8080'],
'ServiceVpcEnable' => ['description' => '是否启用VPC通道,目前可以取值:'."\n"
."\n"
.'- **TRUE**:启用VPC通道,必须先添加VPC授权成功后才能启用'."\n"
.'- **FALSE**:不启用VPC通', 'type' => 'string', 'example' => 'TRUE'],
'MockResult' => ['description' => '如果启用Mock模式,返回的结果', 'type' => 'string', 'example' => 'test result'],
'ServiceHttpMethod' => ['description' => '调用后端服务HTTP协议时的Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'example' => 'POST'],
'ServiceProtocol' => ['description' => '后端服务协议类型,目前只支持HTTP/HTTPS/FunctionCompute', 'type' => 'string', 'example' => 'HTTP'],
'ServiceTimeout' => ['description' => '后端服务超时时间,单位:毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'MockHeaders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MockHeader' => [
'description' => '模拟 Headers',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HeaderValue' => ['description' => 'HTTP头参数值', 'type' => 'string', 'example' => '86400'],
'HeaderName' => ['description' => 'HTTP头参数名', 'type' => 'string', 'example' => 'Content-Type'],
],
'description' => '',
],
],
],
'description' => '',
],
'VpcConfig' => [
'description' => 'VPC通道相关配置项',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***'],
'InstanceId' => ['description' => '专用网络中的实例ID(Ecs/负载均衡)', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***'],
'Port' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '8080'],
'Name' => ['description' => 'VPC授权名称', 'type' => 'string', 'example' => 'glmall-app-test'],
],
],
'FunctionComputeConfig' => [
'description' => '后端为函数计算时的后端配置项',
'type' => 'object',
'properties' => [
'FcType' => ['description' => '函数计算服务类型', 'type' => 'string', 'example' => 'HttpTrigger'],
'RoleArn' => ['description' => 'Ram授权给API网关访问函数计算的arn', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas'],
'Method' => ['description' => '请求方法', 'type' => 'string', 'example' => 'GET'],
'FcBaseUrl' => ['description' => '函数计算服务根路径', 'type' => 'string', 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/'],
'ContentTypeValue' => ['description' => '调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'."\n"],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-beijing'],
'OnlyBusinessPath' => ['description' => '后端只接收业务path', 'type' => 'boolean', 'example' => 'false'],
'FunctionName' => ['description' => '函数计算定义的FunctionName', 'type' => 'string', 'example' => 'domain_business_control'],
'ContentTypeCatagory' => ['description' => '调用后端服务HTTP服务时,ContentType头的取值策略:'."\n"
."\n"
.'- **DEFAULT**:使用API网关默认的值'."\n"
.'- **CUSTOM**:自定义'."\n"
.'- **CLIENT**:使用客户端上行的ContentType的头', 'type' => 'string', 'example' => 'DEFAULT'],
'Path' => ['description' => 'API请求路径', 'type' => 'string', 'example' => '/api/offline/cacheData'],
'ServiceName' => ['description' => '函数计算定义的ServiceName', 'type' => 'string', 'example' => 'fcservicename'],
'Qualifier' => ['description' => '函数别名', 'type' => 'string', 'example' => '2'],
],
],
],
],
'OpenIdConnectConfig' => [
'description' => '第三方账号认证OpenID Connect相关配置项',
'type' => 'object',
'properties' => [
'OpenIdApiType' => ['description' => 'OpenID Connect模式,目前可以取值:'."\n"
."\n"
.'- **IDTOKEN**:获取授权API,颁发Token,当设置此项时,参数PublicKeyId和PublicKey为必传。'."\n"
.'- **BUSINESS**:业务API,Token验证,当设置此项时,参数IdTokenParamName为必传。', 'type' => 'string', 'example' => 'IDTOKEN'],
'IdTokenParamName' => ['description' => 'Token对应的参数名称', 'type' => 'string', 'example' => 'xxx'],
'PublicKeyId' => ['description' => '公钥ID', 'type' => 'string', 'example' => '88483727556929326703309904351185815489'],
'PublicKey' => ['description' => 'api公钥', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92'],
],
],
'ErrorCodeSamples' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ErrorCodeSample' => [
'description' => '后端服务返回的错误码示例。'."\n"
."\n"
.'更多信息,请参见[ErrorCodeSample](~~44392~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '错误码', 'type' => 'string', 'example' => 'Error'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'error message'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => '错误描述'],
],
'description' => '',
],
],
],
'description' => '',
],
'ResultDescriptions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResultDescription' => [
'description' => 'api的返回说明',
'type' => 'array',
'items' => [
'description' => 'api的返回说明',
'type' => 'object',
'properties' => [
'Type' => ['description' => '类型', 'type' => 'string', 'example' => 'string'],
'Key' => ['description' => '返回参数', 'type' => 'string', 'example' => 'key'],
'HasChild' => ['description' => '是否含有子节点', 'type' => 'boolean', 'example' => 'false'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'result description'],
'Pid' => ['description' => '父节点ID', 'type' => 'string', 'example' => '11'],
'Mandatory' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'true'],
'Name' => ['description' => '返回参数名称', 'type' => 'string', 'example' => 'name'],
'Id' => ['description' => '节点ID', 'type' => 'string', 'example' => '1'],
],
],
],
],
'description' => '',
],
'SystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SystemParameter' => [
'description' => '系统参数列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'QueryParamDTO'],
'ParameterName' => ['description' => '系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。', 'type' => 'string', 'example' => 'CaClientIp'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'CustomSystemParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomSystemParameter' => [
'description' => '自定义系统参数列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例值', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => '123'],
'ParameterName' => ['description' => '自定义系统参数名', 'type' => 'string', 'example' => 'appid'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '对应后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ConstantParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConstantParameter' => [
'description' => '常量参数列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => '123'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'constance'],
'ConstantValue' => ['description' => '常量值', 'type' => 'string', 'example' => 'constance'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestParameter' => [
'description' => 'Consumer向网关发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[RequestParameter](~~43986~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}'],
'MaxValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最大值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'ArrayItemsType' => ['description' => '数组元素的类型', 'type' => 'string', 'example' => 'String'],
'MinValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double,参数的最小值限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocShow' => ['description' => '文档可见,取值为:**PUBLIC**、**PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC'],
'MaxLength' => ['description' => '当**ParameterType**=String,参数的最大长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DefaultValue' => ['description' => '默认值', 'type' => 'string', 'example' => '20'],
'ApiParameterName' => ['description' => 'API 参数名称', 'type' => 'string', 'example' => 'age'],
'EnumValue' => ['description' => '当**ParameterType**=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。', 'type' => 'string', 'example' => 'boy,girl'],
'DemoValue' => ['description' => '示例值', 'type' => 'string', 'example' => '20'],
'Required' => ['description' => '是否必填,取值为:**REQUIRED**、**OPTIONAL**,分别表示必填、不必填', 'type' => 'string', 'example' => 'OPTIONAL'],
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'parameter description'],
'ParameterType' => ['description' => '参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。', 'type' => 'string', 'example' => 'String'],
'RegularExpression' => ['description' => '当**ParameterType**=String,参数验证(正则表达式)', 'type' => 'string', 'example' => 'xxx'],
'MinLength' => ['description' => '当**ParameterType**=String,参数的最小长度限定', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'DocOrder' => ['description' => '文档中顺序', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParameters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameter' => [
'description' => '网关向后端服务发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[ServiceParameter](~~43988~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Location' => ['description' => '参数位置,取值为:BODY、HEAD、QUERY、PATH', 'type' => 'string', 'example' => 'HEAD'],
'ParameterType' => ['description' => '后端参数数据类型,取值为:STRING、NUMBER、BOOLEAN,分别表示字符、数值、布尔。', 'type' => 'string', 'example' => 'String'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'clientIp'],
],
'description' => '',
],
],
],
'description' => '',
],
'ServiceParametersMap' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceParameterMap' => [
'description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。'."\n"
."\n"
.'更多信息,请参见[ServiceParameterMap](~~43989~~)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RequestParameterName' => ['description' => '前端入参名称', 'type' => 'string', 'example' => 'sex'],
'ServiceParameterName' => ['description' => '后端参数名称', 'type' => 'string', 'example' => 'sex'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"4eed13a57d4e42fbb51316be8a5329ff\\",\\n \\"ResultType\\": \\"HTML\\",\\n \\"DisableInternet\\": true,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"{code: 200, message:\'success\', data: \'\'}\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"Description\\": \\"Error description\\",\\n \\"GroupName\\": \\"Weather\\",\\n \\"GroupId\\": \\"bc77f5b49c974437a9912ea3755cd834\\",\\n \\"DeployedTime\\": \\"2022-07-25T17:47:51Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"weather\\",\\n \\"RequestConfig\\": {\\n \\"BodyModel\\": \\"https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab\\",\\n \\"RequestPath\\": \\"/api/billing/test/[type]\\",\\n \\"RequestHttpMethod\\": \\"POST\\",\\n \\"BodyFormat\\": \\"STREAM\\",\\n \\"RequestMode\\": \\"MAPPING\\",\\n \\"PostBodyDescription\\": \\"fwefwef\\",\\n \\"RequestProtocol\\": \\"HTTP\\"\\n },\\n \\"ServiceConfig\\": {\\n \\"VpcId\\": \\"vpc-uf6kg9x8sx2tbxxxx\\",\\n \\"MockStatusCode\\": 200,\\n \\"ServicePath\\": \\"/object/add\\",\\n \\"Mock\\": \\"TRUE\\",\\n \\"ServiceAddress\\": \\"http://api.a.com:8080\\",\\n \\"ServiceVpcEnable\\": \\"TRUE\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"ServiceHttpMethod\\": \\"POST\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServiceTimeout\\": 1000,\\n \\"MockHeaders\\": {\\n \\"MockHeader\\": [\\n {\\n \\"HeaderValue\\": \\"86400\\",\\n \\"HeaderName\\": \\"Content-Type\\"\\n }\\n ]\\n },\\n \\"VpcConfig\\": {\\n \\"VpcId\\": \\"vpc-2zeafsc3fygk1***\\",\\n \\"InstanceId\\": \\"i-bp1h497hkijewv2***\\",\\n \\"Port\\": 8080,\\n \\"Name\\": \\"glmall-app-test\\"\\n },\\n \\"FunctionComputeConfig\\": {\\n \\"FcType\\": \\"HttpTrigger\\",\\n \\"RoleArn\\": \\"acs:ram::111***:role/aliyunserviceroleforsas\\",\\n \\"Method\\": \\"GET\\",\\n \\"FcBaseUrl\\": \\"https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/\\",\\n \\"ContentTypeValue\\": \\"application/x-www-form-urlencoded; charset=UTF-8\\\\n\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"OnlyBusinessPath\\": false,\\n \\"FunctionName\\": \\"domain_business_control\\",\\n \\"ContentTypeCatagory\\": \\"DEFAULT\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"ServiceName\\": \\"fcservicename\\",\\n \\"Qualifier\\": \\"2\\"\\n }\\n },\\n \\"OpenIdConnectConfig\\": {\\n \\"OpenIdApiType\\": \\"IDTOKEN\\",\\n \\"IdTokenParamName\\": \\"xxx\\",\\n \\"PublicKeyId\\": \\"88483727556929326703309904351185815489\\",\\n \\"PublicKey\\": \\"EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92\\"\\n },\\n \\"ErrorCodeSamples\\": {\\n \\"ErrorCodeSample\\": [\\n {\\n \\"Code\\": \\"Error\\",\\n \\"Message\\": \\"error message\\",\\n \\"Description\\": \\"错误描述\\"\\n }\\n ]\\n },\\n \\"ResultDescriptions\\": {\\n \\"ResultDescription\\": [\\n {\\n \\"Type\\": \\"string\\",\\n \\"Key\\": \\"key\\",\\n \\"HasChild\\": false,\\n \\"Description\\": \\"result description\\",\\n \\"Pid\\": \\"11\\",\\n \\"Mandatory\\": true,\\n \\"Name\\": \\"name\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n },\\n \\"SystemParameters\\": {\\n \\"SystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"QueryParamDTO\\",\\n \\"ParameterName\\": \\"CaClientIp\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"CustomSystemParameters\\": {\\n \\"CustomSystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"123\\",\\n \\"ParameterName\\": \\"appid\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ConstantParameters\\": {\\n \\"ConstantParameter\\": [\\n {\\n \\"Description\\": \\"123\\",\\n \\"Location\\": \\"HEAD\\",\\n \\"ServiceParameterName\\": \\"constance\\",\\n \\"ConstantValue\\": \\"constance\\"\\n }\\n ]\\n },\\n \\"RequestParameters\\": {\\n \\"RequestParameter\\": [\\n {\\n \\"JsonScheme\\": \\"{}\\",\\n \\"MaxValue\\": 123456,\\n \\"ArrayItemsType\\": \\"String\\",\\n \\"MinValue\\": 123456,\\n \\"DocShow\\": \\"PUBLIC\\",\\n \\"MaxLength\\": 123456,\\n \\"DefaultValue\\": \\"20\\",\\n \\"ApiParameterName\\": \\"age\\",\\n \\"EnumValue\\": \\"boy,girl\\",\\n \\"DemoValue\\": \\"20\\",\\n \\"Required\\": \\"OPTIONAL\\",\\n \\"Description\\": \\"parameter description\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"RegularExpression\\": \\"xxx\\",\\n \\"MinLength\\": 123456,\\n \\"DocOrder\\": 0,\\n \\"Location\\": \\"HEAD\\"\\n }\\n ]\\n },\\n \\"ServiceParameters\\": {\\n \\"ServiceParameter\\": [\\n {\\n \\"Location\\": \\"HEAD\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"ServiceParameterName\\": \\"clientIp\\"\\n }\\n ]\\n },\\n \\"ServiceParametersMap\\": {\\n \\"ServiceParameterMap\\": [\\n {\\n \\"RequestParameterName\\": \\"sex\\",\\n \\"ServiceParameterName\\": \\"sex\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询API在指定环境中的定义',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployedApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeDeployedApis' => [
'summary' => '查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94352',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号', 'type' => 'string', 'required' => false, 'example' => 'c076144d7878437b8f82fb85890ce6a0'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称(模糊匹配)', 'type' => 'string', 'required' => false, 'example' => 'weather'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'EnableTagAuth',
'in' => 'query',
'schema' => ['description' => '是否启用标签验证', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'appname'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'testapp'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'ApiPath',
'in' => 'query',
'schema' => ['description' => 'API的请求Path', 'type' => 'string', 'required' => false, 'example' => '/st4'],
],
[
'name' => 'ApiMethod',
'in' => 'query',
'schema' => ['description' => 'API的请求HTTP方法', 'type' => 'string', 'required' => false, 'example' => 'POST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'DeployedApis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeployedApiItem' => [
'description' => '由 DeployedApiItem 组成的数组格式,返回API的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Visibility' => ['description' => '可见性,可选值:'."\n"
."\n"
.'- **PUBLIC**: 公开'."\n"
.'- **PRIVATE**: 私有', 'type' => 'string', 'example' => 'PUBLIC'],
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => 'c076144d7878437b8f82fb85890ce6a0'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => '分页显示对象列表'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'myGroup3'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '63be9002440b4778a61122f14c2b2bbb'],
'DeployedTime' => ['description' => '发布时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'Get object list'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
'ApiPath' => ['description' => 'API的请求Path', 'type' => 'string', 'example' => '/trademark/search'],
'ApiMethod' => ['description' => 'API的请求HTTP方法', 'type' => 'string', 'example' => 'POST'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"DeployedApis\\": {\\n \\"DeployedApiItem\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"c076144d7878437b8f82fb85890ce6a0\\",\\n \\"Description\\": \\"分页显示对象列表\\",\\n \\"GroupName\\": \\"myGroup3\\",\\n \\"GroupId\\": \\"63be9002440b4778a61122f14c2b2bbb\\",\\n \\"DeployedTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"Get object list\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ApiPath\\": \\"/trademark/search\\",\\n \\"ApiMethod\\": \\"POST\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询已发布 API 列表',
'description' => '- 此功能面向开放API的用户',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeDomain' => [
'summary' => '查询绑定的自定义域名详情信息,包含系统自动分配的二级域名、自定义域名和SSL证书信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94353',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'CertificatePrivateKey' => ['description' => '证书私钥', 'type' => 'string', 'example' => 'xxx'],
'DomainName' => ['description' => '自定义域名', 'type' => 'string', 'example' => 'api.demo.com'],
'DomainBindingStatus' => ['description' => '自定义域名绑定状态,取值:'."\n"
."\n"
.'- BINDING:正常'."\n"
.'- BOUND:未生效', 'type' => 'string', 'example' => 'BINDING'],
'DomainRemark' => ['description' => '域名相关备注,如描述域名异常状态原因', 'type' => 'string', 'example' => 'The domain name is not registered.'],
'CertificateId' => ['description' => 'SSL证书ID,系统自动生成唯一编号', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
'DomainWebSocketStatus' => ['description' => '使用WebSocket的域名的状态', 'type' => 'string', 'example' => 'NORMAL'],
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
'CertificateName' => ['description' => 'SSL证书名称', 'type' => 'string', 'example' => 'myCertificate'],
'DomainLegalStatus' => ['description' => '域名合法状态,取值:'."\n"
."\n"
.'- NORMAL:正常'."\n"
.'- ABNORMAL:异常,该状态会影响API调用,需尽快解决', 'type' => 'string', 'example' => 'NORMAL'],
'GroupId' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'example' => '927d50c0f2e54b359919923d908bb015'],
'CertificateBody' => ['description' => '证书内容', 'type' => 'string', 'example' => 'xxx'],
'SubDomain' => ['description' => '系统为分组分配的二级域名', 'type' => 'string', 'example' => 'xxx-cn-hangzhou.alicloudapi.com'],
'DomainCNAMEStatus' => ['description' => '域名解析情况,取值:'."\n"
."\n"
.'- RESOLVED:已解析'."\n"
.'- UNRESOLVED:未解析', 'type' => 'string', 'example' => 'RESOLVED'],
'CertificateValidStart' => ['description' => '证书生效时间戳(毫秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1672502400000'],
'CertificateValidEnd' => ['description' => '证书失效时间戳(毫秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1704038400000'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertificatePrivateKey\\": \\"xxx\\",\\n \\"DomainName\\": \\"api.demo.com\\",\\n \\"DomainBindingStatus\\": \\"BINDING\\",\\n \\"DomainRemark\\": \\"The domain name is not registered.\\",\\n \\"CertificateId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"DomainWebSocketStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\",\\n \\"CertificateName\\": \\"myCertificate\\",\\n \\"DomainLegalStatus\\": \\"NORMAL\\",\\n \\"GroupId\\": \\"927d50c0f2e54b359919923d908bb015\\",\\n \\"CertificateBody\\": \\"xxx\\",\\n \\"SubDomain\\": \\"xxx-cn-hangzhou.alicloudapi.com\\",\\n \\"DomainCNAMEStatus\\": \\"RESOLVED\\",\\n \\"CertificateValidStart\\": 1672502400000,\\n \\"CertificateValidEnd\\": 1704038400000\\n}","type":"json"}]',
'title' => '查询自定义域名详情信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDomain'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeGroupLatency' => [
'summary' => '查询指定分组指定环境下,分组的平均延迟。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94358',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-03-30T16:00:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-14T06:26:14Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => 'd825094fdd114a869f5adb443d9b7ead'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '75DC3AB0-421C-5371-8170-86AEABF77AD0'],
'LatencyPacket' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '平均时延信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '延迟数,单位:ms', 'type' => 'string', 'example' => '100.0'],
'ItemTime' => ['description' => '时间节点,按照ISO8601标准表示,格式为:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2023-03-30T16:10:00Z'],
'Item' => ['description' => '指标'."\n"
.'- latency:后端处理延迟'."\n"
.'- gatewayLatency:API网关处理延迟', 'type' => 'string', 'example' => 'latency'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询分组的平均延迟',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupLatency'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupLatency',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75DC3AB0-421C-5371-8170-86AEABF77AD0\\",\\n \\"LatencyPacket\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"100.0\\",\\n \\"ItemTime\\": \\"2023-03-30T16:10:00Z\\",\\n \\"Item\\": \\"latency\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeGroupQps' => [
'summary' => '查询指定的分组在一段时间内请求量的统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94359',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-08-12T06:09:52Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-08-23T07:27:44Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'example' => '264c60db9f764345a13ac5c825b229b9'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
'GroupQps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '返回指定的分组的请求量',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应时间节点的请求数量', 'type' => 'string', 'example' => '17'],
'ItemTime' => ['description' => '时间节点', 'type' => 'string', 'example' => '2023-08-02T09:15:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询指定分组的 QPS 数据',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupQps'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupQps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"GroupQps\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"17\\",\\n \\"ItemTime\\": \\"2023-08-02T09:15:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeGroupTraffic' => [
'summary' => '查询指定api分组的流量。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94360',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-29T01:27:43Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-06-16T02:16:53Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE '],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '16df9d11caa04900bcafe23b38a81600'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
'TrafficPerSecond' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '每秒的流量信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '100.0'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2023-01-29T01:30:00Z'],
'Item' => ['description' => '指标'."\n"
.'- inbound 请求流量'."\n"
.'- outbound 应答流量', 'type' => 'string', 'example' => 'inbound'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询分组流量',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupTraffic'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupTraffic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"TrafficPerSecond\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"100.0\\",\\n \\"ItemTime\\": \\"2023-01-29T01:30:00Z\\",\\n \\"Item\\": \\"inbound\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeHistoryApis' => [
'summary' => '查询API历史发布版本列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94362',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => true, 'example' => '0ccb66aadb5345b78a40f57d192d8aa4'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定要查询的Api编号', 'type' => 'string', 'required' => false, 'example' => 'a12068f555964ca8a0c9c33288f1e5a7'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称(模糊匹配)', 'type' => 'string', 'required' => false, 'example' => 'getPersonInfo'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码。', 'type' => 'string', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
'PageSize' => ['description' => '指定分页查询时每页行数,最大值50,默认值为10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApiHisItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiHisItem' => [
'description' => '由 ApiHisItem 组成的数组格式,返回API的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '对应版本的API是否生效,取值为:**ONLINE**、**OFFLINE**,分别表示有效、无效。', 'type' => 'string', 'example' => 'ONLINE'],
'ApiId' => ['description' => 'API的ID。', 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Create object API'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'myGroup2'],
'GroupId' => ['description' => 'API分组ID', 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6'],
'DeployedTime' => ['description' => '发布时间(格林威治时间)', 'type' => 'string', 'example' => '2016-07-20T08:28:48Z'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'RELEASE'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => 'Production'],
'HistoryVersion' => ['description' => 'API定义的历史版本', 'type' => 'string', 'example' => '20210915101416294'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'v2_role_assign'],
'RegionId' => ['description' => '地域ID', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiHisItems\\": {\\n \\"ApiHisItem\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"Description\\": \\"Create object API\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"DeployedTime\\": \\"2016-07-20T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"Production\\",\\n \\"HistoryVersion\\": \\"20210915101416294\\",\\n \\"ApiName\\": \\"v2_role_assign\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询API发布版本定义列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeHistoryApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeImportOASTask' => [
'summary' => '查询OAS批量导入API的结果。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '155133',
'abilityTreeNodes' => ['FEATUREapigateway9WMX21'],
],
'parameters' => [
[
'name' => 'OperationId',
'in' => 'query',
'schema' => ['description' => '进行导入操作时生成的异步任务ID,用来查询导入任务的执行情况', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4c53ccf1d40c489686d1adf5c2644a7f'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的id', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
'ApiResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiResult' => [
'description' => 'API的导入结果',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'example' => 'c5a0c2900ff746b789c007545be22fb8'],
'Path' => ['description' => 'API的请求路径', 'type' => 'string', 'example' => '/creator/getByCreatorId'],
'Method' => ['description' => 'API的请求HTTP Method', 'type' => 'string', 'example' => 'GET'],
'Description' => ['description' => 'API的描述信息', 'type' => 'string', 'example' => 'This API is used for queries.'],
'GroupId' => ['description' => 'API分组 ID', 'type' => 'string', 'example' => '736508d885074167ba8fbce3bc95ea0b'],
'ApiName' => ['description' => 'api名称', 'type' => 'string', 'example' => 'GetByCreatorIdUsingGET'],
'ErrorMessage' => ['description' => '如果导入失败时,显示失败的原因', 'type' => 'string', 'example' => 'Internal Error'],
'UpdateStatus' => ['description' => '当前子任务执行的状态'."\n"
.' - RUNNING:执行中'."\n"
.' - WAIT:等待调度'."\n"
.' - OVER:执行成功'."\n"
.' - FAIL:执行失败'."\n"
.' - CANCEL:取消执行', 'type' => 'string', 'example' => 'WAIT'],
],
'description' => '',
],
],
],
'description' => '',
],
'ModelResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ModelResult' => [
'description' => '模型的导入结果',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'Pet'],
'ModelId' => ['description' => '导入的模型id', 'type' => 'string', 'example' => '6b48d724c921415486e190c494dd6bf8'],
'GroupId' => ['description' => 'API分组ID', 'type' => 'string', 'example' => '736508d885074167ba8fbce3bc95ea0b'],
'ErrorMessage' => ['description' => '如果导入失败时,显示失败的原因', 'type' => 'string', 'example' => 'Internal Error'."\n"],
'UpdateStatus' => ['description' => '当前子任务执行的状态'."\n"
.' - RUNNING:执行中'."\n"
.' - WAIT:等待调度'."\n"
.' - OVER:执行成功'."\n"
.' - FAIL:执行失败'."\n"
.' - CANCEL:取消执行', 'type' => 'string', 'example' => 'FAIL'],
],
'description' => '',
],
],
],
'description' => '',
],
'TaskStatus' => ['description' => '导入任务的执行状态:'."\n"
.'- Running:运行中'."\n"
.'- Finished:执行完成', 'type' => 'string', 'example' => 'Finished'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\",\\n \\"ApiResults\\": {\\n \\"ApiResult\\": [\\n {\\n \\"ApiId\\": \\"c5a0c2900ff746b789c007545be22fb8\\",\\n \\"Path\\": \\"/creator/getByCreatorId\\",\\n \\"Method\\": \\"GET\\",\\n \\"Description\\": \\"This API is used for queries.\\",\\n \\"GroupId\\": \\"736508d885074167ba8fbce3bc95ea0b\\",\\n \\"ApiName\\": \\"GetByCreatorIdUsingGET\\",\\n \\"ErrorMessage\\": \\"Internal Error\\",\\n \\"UpdateStatus\\": \\"WAIT\\"\\n }\\n ]\\n },\\n \\"ModelResults\\": {\\n \\"ModelResult\\": [\\n {\\n \\"ModelName\\": \\"Pet\\",\\n \\"ModelId\\": \\"6b48d724c921415486e190c494dd6bf8\\",\\n \\"GroupId\\": \\"736508d885074167ba8fbce3bc95ea0b\\",\\n \\"ErrorMessage\\": \\"Internal Error\\\\n\\",\\n \\"UpdateStatus\\": \\"FAIL\\"\\n }\\n ]\\n },\\n \\"TaskStatus\\": \\"Finished\\"\\n}","type":"json"}]',
'title' => '查询OAS导入API的任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeImportOASTask'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeImportOASTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeInstanceClusterInfo' => [
'summary' => '查询专享实例集群信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '175318',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'InstanceClusterName',
'in' => 'query',
'schema' => ['description' => '专享实例集群名称', 'type' => 'string', 'required' => false, 'example' => 'testvpc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'InstanceClusterName' => ['description' => '专享实例集群名称', 'type' => 'string', 'example' => 'test'],
'InstanceClusterId' => ['description' => '纳管该专享实例的专享实例集群的ID', 'type' => 'string', 'example' => 'apigateway-ht-04e41d95e9c1'."\n"],
'InstanceClusterStatus' => ['description' => '专享实例集群状态', 'type' => 'string', 'example' => 'RUNNING'],
'InstanceClusterVersion' => ['description' => '专享实例集群版本', 'type' => 'string', 'example' => '3.5.3.856'],
'Description' => ['description' => '描述,不超过200个字符', 'type' => 'string', 'example' => 'v0.0.4'],
'RegionId' => ['description' => '实例所属地域的ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2022-10-10T18:29:27'],
'ModifiedTime' => ['description' => '修改时间', 'type' => 'string', 'example' => '2023-06-19 10:40:29 +0800'],
'InstanceClusterAttribute' => [
'description' => '专享实例集群的详细信息',
'type' => 'object',
'properties' => [
'HttpsPolicies' => ['description' => 'https安全策略', 'type' => 'string', 'example' => 'HTTPS2_TLS1_0'],
'InternetEgressAddress' => ['description' => '公网出口地址', 'type' => 'string', 'example' => '39.106.XX.XX'],
'IntranetEgressAddress' => ['description' => '内网出口地址', 'type' => 'string', 'example' => '100.104.XX.XX/26'],
'VpcIntranetEnable' => ['description' => '是否开启内网VPC域名', 'type' => 'boolean'],
'IntranetSegments' => ['description' => '自定义网段,所配置的网段将被视为私网地址', 'type' => 'string', 'example' => '123.0.0.1'],
'UserVpcId' => ['description' => '客户端vpcid', 'type' => 'string', 'example' => 'vpc-2zew2v4vcg78mXXXX'],
'UserVswitchId' => ['description' => '客户端vpc的交换机', 'type' => 'string', 'example' => 'vsw-2zecr5r7ao44tslsXXXX'],
'VpcOwnerId' => ['description' => 'VPC实例所属账号ID', 'type' => 'integer', 'format' => 'int64', 'example' => '165438596694XXXX'],
'IPV4AclId' => ['description' => 'IPV4访问控制策略ID', 'type' => 'string', 'example' => 'acl-t4n8i4rvvp70kcyuoXXXX'],
'IPV4AclName' => ['description' => 'IPV4访问控制策略名称', 'type' => 'string', 'example' => 'test-black'],
'IPV4AclStatus' => ['description' => '是否开启IPV4访问控制功能。取值:'."\n"
."\n"
.'- on:开启访问控制'."\n"
.'- off:关闭访问控制', 'type' => 'string', 'example' => 'on'],
'IPV4AclType' => ['description' => 'IPV4访问控制策略类型'."\n"
."\n"
.'- black:黑名单'."\n"
."\n"
.'- white:白名单', 'type' => 'string', 'example' => 'black'],
'EgressIpv6Enable' => ['description' => 'IPV6出访能力是否支持', 'type' => 'boolean', 'example' => 'true'],
'SupportIpv6' => ['description' => '是否支持ipv6', 'type' => 'boolean', 'example' => 'true'],
'IPV6AclName' => ['description' => 'IPV6访问控制策略名称', 'type' => 'string', 'example' => 'test'],
'IPV6AclId' => ['description' => 'IPV6访问控制策略ID', 'type' => 'string', 'example' => 'acl-t4nevzhwbpe7cup18XXXX'],
'IPV6AclStatus' => ['description' => '是否开启IPV6访问控制功能。取值:'."\n"
."\n"
.'- **on**:开启访问控制'."\n"
."\n"
.'- **off**:关闭访问控制', 'type' => 'string', 'example' => 'on'],
'IPV6AclType' => ['description' => 'IPV6访问控制策略类型'."\n"
.'- black:黑名单 '."\n"
.'- white:白名单', 'type' => 'string', 'example' => 'white'],
'VipTypeList' => ['description' => '实例集群已开通的VIP列表', 'type' => 'string', 'example' => 'VPC_INTERNET_IPV6'],
'VpcSlbIntranetEnable' => ['description' => '是否开启API网关自调用域名', 'type' => 'boolean', 'example' => 'false'],
'ConnectVpcId' => ['description' => 'VPC融合类型实例集群联通的用户VPC ID', 'type' => 'string', 'example' => 'vpc-p0w3kxxxxxxxxxxxxxxxx'],
'ConnectCidrBlocks' => ['description' => 'VPC融合类型实例集群可以访问到的用户VPC的内网网段', 'type' => 'string', 'example' => '["192.168.1.0/24","192.168.0.0/24"]'],
],
],
'InstanceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '实例集群包含的专享实例列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'tf-testacceu-central-1apigatewayinstance8752'],
'InstanceId' => ['description' => '专享实例ID', 'type' => 'string', 'example' => 'apigateway-ht-04e41d95e9c1'],
'Status' => ['description' => '专享实例状态', 'type' => 'string', 'example' => 'RUNNING'],
'ErrorMessage' => ['description' => '调用失败时,返回的出错信息', 'type' => 'string', 'example' => 'Instance not found.'],
],
],
],
],
],
'InstanceClusterType' => ['description' => '专享实例集群类型', 'type' => 'string', 'example' => 'normal'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"InstanceClusterName\\": \\"test\\",\\n \\"InstanceClusterId\\": \\"apigateway-ht-04e41d95e9c1\\\\n\\",\\n \\"InstanceClusterStatus\\": \\"RUNNING\\",\\n \\"InstanceClusterVersion\\": \\"3.5.3.856\\",\\n \\"Description\\": \\"v0.0.4\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CreatedTime\\": \\"2022-10-10T18:29:27\\",\\n \\"ModifiedTime\\": \\"2023-06-19 10:40:29 +0800\\",\\n \\"InstanceClusterAttribute\\": {\\n \\"HttpsPolicies\\": \\"HTTPS2_TLS1_0\\",\\n \\"InternetEgressAddress\\": \\"39.106.XX.XX\\",\\n \\"IntranetEgressAddress\\": \\"100.104.XX.XX/26\\",\\n \\"VpcIntranetEnable\\": true,\\n \\"IntranetSegments\\": \\"123.0.0.1\\",\\n \\"UserVpcId\\": \\"vpc-2zew2v4vcg78mXXXX\\",\\n \\"UserVswitchId\\": \\"vsw-2zecr5r7ao44tslsXXXX\\",\\n \\"VpcOwnerId\\": 0,\\n \\"IPV4AclId\\": \\"acl-t4n8i4rvvp70kcyuoXXXX\\",\\n \\"IPV4AclName\\": \\"test-black\\",\\n \\"IPV4AclStatus\\": \\"on\\",\\n \\"IPV4AclType\\": \\"black\\",\\n \\"EgressIpv6Enable\\": true,\\n \\"SupportIpv6\\": true,\\n \\"IPV6AclName\\": \\"test\\",\\n \\"IPV6AclId\\": \\"acl-t4nevzhwbpe7cup18XXXX\\",\\n \\"IPV6AclStatus\\": \\"on\\",\\n \\"IPV6AclType\\": \\"white\\",\\n \\"VipTypeList\\": \\"VPC_INTERNET_IPV6\\",\\n \\"VpcSlbIntranetEnable\\": false,\\n \\"ConnectVpcId\\": \\"vpc-p0w3kxxxxxxxxxxxxxxxx\\",\\n \\"ConnectCidrBlocks\\": \\"[\\\\\\"192.168.1.0/24\\\\\\",\\\\\\"192.168.0.0/24\\\\\\"]\\"\\n },\\n \\"InstanceList\\": {\\n \\"Instance\\": [\\n {\\n \\"InstanceName\\": \\"tf-testacceu-central-1apigatewayinstance8752\\",\\n \\"InstanceId\\": \\"apigateway-ht-04e41d95e9c1\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"Instance not found.\\"\\n }\\n ]\\n },\\n \\"InstanceClusterType\\": \\"normal\\"\\n}","type":"json"}]',
'title' => '查询专享实例集群信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterInfo'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceClusterInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeInstanceClusterList' => [
'summary' => '查询专享实例集群列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '175317',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'InstanceClusterName',
'in' => 'query',
'schema' => ['description' => '专享实例集群名称', 'type' => 'string', 'required' => false, 'example' => 'test-cluster'],
],
[
'name' => 'InstanceClusterId',
'in' => 'query',
'schema' => ['description' => '纳管该专享实例的专享实例集群的ID', 'type' => 'string', 'required' => false, 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'InstanceClusters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceCluster' => [
'description' => '专享实例集群列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceClusterName' => ['description' => '专享实例集群名称', 'type' => 'string', 'example' => 'test-cluster'],
'InstanceClusterId' => ['description' => '纳管该专享实例的专享实例集群的ID', 'type' => 'string', 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx'."\n"],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Test TrafficControl'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2023-08-14T17:46:59+08:00'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2024-01-12T10:11:08+08:00'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'InstanceClusterStatus' => ['description' => '专享实例集群状态', 'type' => 'string', 'example' => 'RUNNING'],
'InstanceClusterType' => ['description' => '专享实例集群类型', 'type' => 'string', 'example' => 'normal'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询专享实例集群',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterList'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceClusterList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"InstanceClusters\\": {\\n \\"InstanceCluster\\": [\\n {\\n \\"InstanceClusterName\\": \\"test-cluster\\",\\n \\"InstanceClusterId\\": \\"apigateway-cluster-hz-xxxxxxxxxxxx\\\\n\\",\\n \\"Description\\": \\"Test TrafficControl\\",\\n \\"CreatedTime\\": \\"2023-08-14T17:46:59+08:00\\",\\n \\"ModifiedTime\\": \\"2024-01-12T10:11:08+08:00\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceClusterStatus\\": \\"RUNNING\\",\\n \\"InstanceClusterType\\": \\"normal\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceDropConnections' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94363',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-31T06:00:09Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-31T07:00:09Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '专享实例ID', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-n6w1v1234501'],
],
[
'name' => 'SbcName',
'in' => 'query',
'schema' => ['description' => '统计指标'."\n"
.'- Maximum 最大'."\n"
.'- Minimum 最小'."\n"
.'- Average 平均', 'type' => 'string', 'required' => true, 'example' => 'Maximum'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'],
'InstanceDropConnections' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '丢失的连接',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '0.0'],
'ItemTime' => ['description' => '时间坐标,按照ISO8601标准表示。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2023-01-31T01:11:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例的丢失链接',
'summary' => '查看专享实例一定时间内丢失的连接数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropConnections'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceDropConnections',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\",\\n \\"InstanceDropConnections\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"0.0\\",\\n \\"ItemTime\\": \\"2023-01-31T01:11:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceDropPacket' => [
'summary' => '查看专享实例一定时间内丢弃数据包数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94364',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-06T04:00:36Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-16T02:04:36Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v641b9dxc00p'],
],
[
'name' => 'SbcName',
'in' => 'query',
'schema' => ['description' => '统计指标'."\n"
.'- Maximum 最大'."\n"
.'- Minimum 最小'."\n"
.'- Average 平均', 'type' => 'string', 'required' => true, 'example' => 'Maximum'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001'],
'InstanceDropPacket' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例丢包信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '0.0'],
'ItemTime' => ['description' => '时间坐标,按照ISO8601标准表示。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-06T04:00:36Z'."\n"],
'Item' => ['description' => '指标'."\n"
.'- InstanceDropPacketRX 实例每秒丢弃入包数'."\n"
.'- InstanceDropPacketTX 实例每秒丢弃出包数', 'type' => 'string', 'example' => 'InstanceDropPacketRX'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例丢弃的数据数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropPacket'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceDropPacket',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ001\\",\\n \\"InstanceDropPacket\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"0.0\\",\\n \\"ItemTime\\": \\"2022-09-06T04:00:36Z\\\\n\\",\\n \\"Item\\": \\"InstanceDropPacketRX\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceHttpCode' => [
'summary' => '查看专享实例一定时间内请求的HTTP状态码分布。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94365',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-04-14T02:12:10Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-07-21T06:05:52Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-m7r227yy2004'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA'],
'InstanceHttpCode' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '返回的HTTP返回码列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '1'],
'ItemTime' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '404'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例HTTP代码',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceHttpCode'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceHttpCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\",\\n \\"InstanceHttpCode\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"1\\",\\n \\"ItemTime\\": \\"404\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceLatency' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94366',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-15T11:07:05Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-06T02:05:13Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v641jf5tt01v'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'InstanceLatency' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例平均延时列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '10'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-06T02:05:13Z'."\n"],
'Item' => ['description' => '指标'."\n"
.'- gatewayLatency API网关处理产生的延时'."\n"
.'- latency 后端服务处理产生的延时', 'type' => 'string', 'example' => 'latency'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例时延',
'summary' => '查看专享实例一定时间内平均延时。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceLatency'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceLatency',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"InstanceLatency\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"10\\",\\n \\"ItemTime\\": \\"2022-09-06T02:05:13Z\\\\n\\",\\n \\"Item\\": \\"latency\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceNewConnections' => [
'summary' => '查看专享实例一定时间内新建连接数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94367',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-10-01T02:08:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-10-08T02:08:00Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001'],
],
[
'name' => 'SbcName',
'in' => 'query',
'schema' => ['description' => '统计指标'."\n"
.'- Maximum 最大'."\n"
.'- Minimum 最小'."\n"
.'- Average 平均', 'type' => 'string', 'required' => true, 'example' => 'Maximum'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'InstanceNewConnections' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例新连接列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '16'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-10-08T02:08:00Z'."\n"],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询实例的新连接数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceNewConnections'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceNewConnections',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"InstanceNewConnections\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"16\\",\\n \\"ItemTime\\": \\"2022-10-08T02:08:00Z\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstancePackets' => [
'summary' => '查看专享实例一定时间内流入流出数据包数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94368',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-05-18T01:14:26Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-05-24T10:14:53Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001'],
],
[
'name' => 'SbcName',
'in' => 'query',
'schema' => ['description' => '统计指标'."\n"
.'- Maximum 最大'."\n"
.'- Minimum 最小'."\n"
.'- Average 平均', 'type' => 'string', 'required' => true, 'example' => 'Maximum'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'InstancePackets' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例流入/流出的数据包',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '0'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-05-24T10:14:53Z'."\n"],
'Item' => ['description' => '指标'."\n"
.'- InstancePacketRX 流入数据包'."\n"
.'- InstancePacketTX 流出数据包', 'type' => 'string', 'example' => 'InstancePacketRX'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例的数据包数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstancePackets'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstancePackets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"InstancePackets\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"0\\",\\n \\"ItemTime\\": \\"2022-05-24T10:14:53Z\\\\n\\",\\n \\"Item\\": \\"InstancePacketRX\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceQps' => [
'summary' => '查看专享实例一定时间内请求次数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94369',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-10T06:03:47Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-29T06:25:00Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-bj-6c219f1fd5d4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'InstanceQps' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '按实例统计API请求次数',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '500'],
'ItemTime' => ['description' => '时间坐标,按照ISO8601标准表示。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-03-29T06:25:00Z'."\n"],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询实例的QPS数据',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceQps'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceQps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"InstanceQps\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"500\\",\\n \\"ItemTime\\": \\"2022-03-29T06:25:00Z\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceSlbConnect' => [
'summary' => '查看专享实例一定时间内并发连接数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94371',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-01T02:09:33Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-15T15:07:06Z'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-sz-1574cc7c5a31'],
],
[
'name' => 'SbcName',
'in' => 'query',
'schema' => ['description' => '统计指标'."\n"
.'- Maximum 最大'."\n"
.'- Minimum 最小'."\n"
.'- Average 平均', 'type' => 'string', 'required' => true, 'example' => 'Maximum'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06'],
'InstanceSlbConnect' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例并发连接数',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '12'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-15T15:07:06Z'."\n"],
'Item' => ['description' => '指标'."\n"
.'- InstanceMaxConnection 最大并发连接数'."\n"
.'- InstanceInactiveConnection 非活跃连接数'."\n"
.'- InstanceActiveConnection 活跃连接数', 'type' => 'string', 'example' => 'InstanceActiveConnection'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取实例的Slb链接',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSlbConnect'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceSlbConnect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\",\\n \\"InstanceSlbConnect\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"12\\",\\n \\"ItemTime\\": \\"2022-09-15T15:07:06Z\\\\n\\",\\n \\"Item\\": \\"InstanceActiveConnection\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstanceTraffic' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94372',
'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-31T03:42:00Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-04-01T06:34:03Z'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'InstanceTraffic' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MonitorItem' => [
'description' => '实例的请求流量和应答流量',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemValue' => ['description' => '对应值', 'type' => 'string', 'example' => '10'],
'ItemTime' => ['description' => '对应时间,按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-04-01T06:34:03Z'."\n"],
'Item' => ['description' => '指标'."\n"
.'- inbound 请求流量'."\n"
.'- outbound 应答流量', 'type' => 'string', 'example' => 'inbound'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询指定实例流量信息',
'summary' => '查看专享实例一定时间内请求和应答流量。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceTraffic'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceTraffic',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"InstanceTraffic\\": {\\n \\"MonitorItem\\": [\\n {\\n \\"ItemValue\\": \\"10\\",\\n \\"ItemTime\\": \\"2022-04-01T06:34:03Z\\\\n\\",\\n \\"Item\\": \\"inbound\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeInstances' => [
'summary' => '查询region下的共享实例/专享实例详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94370',
'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id'."\n"
.'不填写默认查询所有实例', 'type' => 'string', 'required' => false, 'example' => 'api-shared-vpc-001'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n"
."\n"
.'- en:英文。'."\n"
.'- zh:中文。'."\n"
.'- ja:日文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'InstanceType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['VPC_SHARED', 'VPC_DEDICATED'],
'description' => '',
],
],
[
'name' => 'EnableTagAuthorization',
'in' => 'query',
'schema' => ['description' => '是否开启了Tag授权', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例所绑定的标签',
'type' => 'array',
'items' => [
'description' => '实例所绑定的标签',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '500', 'default' => '500'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
'PageSize' => ['description' => '每页数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceAttribute' => [
'description' => '实例信息列表。',
'type' => 'array',
'items' => [
'description' => '实例列表信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '实例状态', 'type' => 'string', 'example' => 'RUNNING'],
'VpcSlbIntranetEnable' => ['description' => '是否开启内网VPC SLB', 'type' => 'boolean', 'example' => 'true'],
'ClassicEgressAddress' => ['description' => '出口地址', 'type' => 'string', 'example' => '10.0.0.1'],
'ZoneLocalName' => ['description' => '可用区域', 'type' => 'string', 'example' => 'Multi Zone 2'],
'UserVpcId' => ['description' => '用户VPC Id', 'type' => 'string', 'example' => 'vpc-t***hx****yu9****t0g4'],
'VpcIntranetEnable' => ['description' => '是否开启内网VPC', 'type' => 'boolean', 'example' => 'true'],
'VpcOwnerId' => ['description' => 'VPC实例所属账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1408453217640291****'],
'InstanceId' => ['description' => '实例id', 'type' => 'string', 'example' => 'api-shared-vpc-020'],
'InstanceRpsLimit' => ['description' => '实例rps限制', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
'InstanceType' => ['description' => '实例类型'."\n"
.'- VPC_SHARED:共享实例(VPC)'."\n"
.'- VPC_DEDICATED:专享实例(VPC)', 'type' => 'string', 'example' => 'VPC_SHARED'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-beijing'],
'InstanceSpec' => ['description' => '实例规格', 'type' => 'string', 'example' => 'api.s1.small'],
'InstanceChargeType' => ['description' => '实例的计费方式。可能值:'."\n"
."\n"
.'- PrePaid:包年包月。'."\n"
.'- PayAsYouGo:按量付费。', 'type' => 'string', 'example' => 'PrePaid'],
'HttpsPolicies' => ['description' => 'https安全策略', 'type' => 'string', 'example' => 'HTTPS2_TLS1_2'],
'VpcEgressAddress' => ['description' => '内网VPC出口网段', 'type' => 'string', 'example' => '100.104.254.0/26'],
'NewVpcEgressAddress' => ['description' => '新的内网VPC出口网段', 'type' => 'string', 'example' => '100.104.253.0/26'],
'EgressIpv6Enable' => ['description' => 'IPV6出访能力是否支持', 'type' => 'boolean', 'example' => 'true'],
'ExpiredTime' => ['description' => '实例过期时间。', 'type' => 'string', 'example' => '1659801600000'],
'InstanceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'test'],
'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-MAZ5(g,h)'],
'SupportIpv6' => ['description' => '是否支持ipv6', 'type' => 'boolean', 'example' => 'true'],
'InternetEgressAddress' => ['description' => '公网出口地址', 'type' => 'string', 'example' => '47.241.89.244'],
'CreatedTime' => ['description' => '实例创建时间', 'type' => 'string', 'example' => '2021-10-22 15:36:53.0'],
'InstanceSpecAttributes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SpecAttribute' => [
'description' => '实例规格',
'type' => 'array',
'items' => [
'description' => '实例规格',
'type' => 'object',
'properties' => [
'Value' => ['description' => '变量值', 'type' => 'string', 'example' => '2500'],
'LocalName' => ['description' => '变量名', 'type' => 'string', 'example' => '最大每秒请求数'],
],
],
],
],
'description' => '',
],
'UserVswitchId' => ['description' => '用户交互机Id', 'type' => 'string', 'example' => 'vsw-t4***eh****d7q****i2f'],
'AclName' => ['description' => '访问控制策略名称。', 'type' => 'string', 'example' => 'test'],
'AclType' => ['description' => '访问控制的类型:'."\n"
.'- black:黑名单 '."\n"
.'- white:白名单', 'type' => 'string', 'example' => 'white'],
'AclStatus' => ['description' => '是否开启访问控制功能。取值:'."\n"
."\n"
.'- **on**:开启访问控制。'."\n"
."\n"
.'- **off**:关闭访问控制。'."\n", 'type' => 'string', 'example' => 'on'],
'AclId' => ['description' => '访问控制策略ID。', 'type' => 'string', 'example' => 'acl-uf6f9zfxfxtp5j9ng3yv4'],
'IntranetSegments' => ['description' => '可访问API网关实例的内网网段', 'type' => 'string', 'example' => '[\\"172.36.0.0/16\\",\\"172.31.16.0/20\\"]'],
'IPV6AclName' => ['description' => 'IPV6访问控制策略名称', 'type' => 'string', 'example' => 'testIPV6'],
'IPV6AclId' => ['description' => 'IPV6访问控制策略ID', 'type' => 'string', 'example' => 'acl-124resFfs235'],
'IPV6AclType' => ['description' => 'IPV6访问控制策略类型'."\n"
.'- black:黑名单 '."\n"
.'- white:白名单', 'type' => 'string', 'example' => 'black'],
'IPV6AclStatus' => ['description' => '是否开启IPV6访问控制功能。取值:'."\n"
."\n"
.'- **on**:开启访问控制。'."\n"
."\n"
.'- **off**:关闭访问控制。', 'type' => 'string', 'example' => 'off'],
'DedicatedInstanceType' => ['description' => '专享实例类型'."\n"
.'- vpc_connect:VPC融合类型专享实例'."\n"
.'- normal:传统类型专享实例', 'type' => 'string', 'example' => 'vpc_connect'],
'InstanceCidrBlock' => ['description' => '专享实例所在网段'."\n"
.'- 172.16.0.0/12'."\n"
.'- 192.168.0.0/16', 'type' => 'string', 'example' => '192.168.0.0/16'],
'ConnectVpcId' => ['description' => 'VPC融合类型专享实例联通的用户VPC ID', 'type' => 'string', 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg'],
'NetworkInterfaceAttributes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NetworkInterfaceAttribute' => [
'description' => 'VPC融合类型专享实例连通的用户VPC内的网络信息',
'type' => 'array',
'items' => [
'description' => 'VPC融合类型专享实例连通的用户VPC内的网络信息',
'type' => 'object',
'properties' => [
'VswitchId' => ['description' => '虚拟交换机ID', 'type' => 'string', 'example' => 'vsw-2zeqals6rbj51bhjn8b89'],
'SecurityGroupId' => ['description' => '安全组的ID,同一个安全组内的服务可以互相访问。', 'type' => 'string', 'example' => 'sg-2zeehz13zcyj1kfk3o85'],
'CidrBlock' => ['description' => 'vSwitch的网段。', 'type' => 'string', 'example' => '192.168.17.0/24'],
'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'example' => 'cn-shenzhen-d'],
],
],
],
],
'description' => '',
],
'InstanceClusterId' => ['description' => '纳管该专享实例的专享实例集群的ID', 'type' => 'string', 'example' => 'apigateway-cluster-sh-1523cafbgffd'],
'MaintainStartTime' => ['description' => '可运维开始时间,格式为HH:mmZ(UTC时间)。', 'type' => 'string', 'example' => '22:00Z'],
'MaintainEndTime' => ['description' => '可运维结束时间,格式为HH:mmZ(UTC时间)。', 'type' => 'string', 'example' => '01:00Z'],
'ConnectCidrBlocks' => ['description' => 'VPC融合类型专享实例,可以访问到的用户VPC的内网网段。', 'type' => 'string', 'example' => '[\\"172.16.0.0/24\\",\\"172.16.1.0/24\\"]'],
'PrivateDnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PrivateDns' => [
'description' => '内网域名列表',
'type' => 'array',
'items' => ['description' => '内网域名', 'type' => 'string', 'example' => 'www.private.com'],
],
],
'description' => '',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'example' => 'tag3'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => '50699_0'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"InstanceAttribute\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"VpcSlbIntranetEnable\\": true,\\n \\"ClassicEgressAddress\\": \\"10.0.0.1\\",\\n \\"ZoneLocalName\\": \\"Multi Zone 2\\",\\n \\"UserVpcId\\": \\"vpc-t***hx****yu9****t0g4\\",\\n \\"VpcIntranetEnable\\": true,\\n \\"VpcOwnerId\\": 0,\\n \\"InstanceId\\": \\"api-shared-vpc-020\\",\\n \\"InstanceRpsLimit\\": 500,\\n \\"InstanceType\\": \\"VPC_SHARED\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"InstanceSpec\\": \\"api.s1.small\\",\\n \\"InstanceChargeType\\": \\"PrePaid\\",\\n \\"HttpsPolicies\\": \\"HTTPS2_TLS1_2\\",\\n \\"VpcEgressAddress\\": \\"100.104.254.0/26\\",\\n \\"NewVpcEgressAddress\\": \\"100.104.253.0/26\\",\\n \\"EgressIpv6Enable\\": true,\\n \\"ExpiredTime\\": \\"1659801600000\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-hangzhou-MAZ5(g,h)\\",\\n \\"SupportIpv6\\": true,\\n \\"InternetEgressAddress\\": \\"47.241.89.244\\",\\n \\"CreatedTime\\": \\"2021-10-22 15:36:53.0\\",\\n \\"InstanceSpecAttributes\\": {\\n \\"SpecAttribute\\": [\\n {\\n \\"Value\\": \\"2500\\",\\n \\"LocalName\\": \\"最大每秒请求数\\"\\n }\\n ]\\n },\\n \\"UserVswitchId\\": \\"vsw-t4***eh****d7q****i2f\\",\\n \\"AclName\\": \\"test\\",\\n \\"AclType\\": \\"white\\",\\n \\"AclStatus\\": \\"on\\",\\n \\"AclId\\": \\"acl-uf6f9zfxfxtp5j9ng3yv4\\",\\n \\"IntranetSegments\\": \\"[\\\\\\\\\\\\\\"172.36.0.0/16\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"172.31.16.0/20\\\\\\\\\\\\\\"]\\",\\n \\"IPV6AclName\\": \\"testIPV6\\",\\n \\"IPV6AclId\\": \\"acl-124resFfs235\\",\\n \\"IPV6AclType\\": \\"black\\",\\n \\"IPV6AclStatus\\": \\"off\\",\\n \\"DedicatedInstanceType\\": \\"vpc_connect\\",\\n \\"InstanceCidrBlock\\": \\"192.168.0.0/16\\",\\n \\"ConnectVpcId\\": \\"vpc-m5eo7khlb4h4f8y9egsdg\\",\\n \\"NetworkInterfaceAttributes\\": {\\n \\"NetworkInterfaceAttribute\\": [\\n {\\n \\"VswitchId\\": \\"vsw-2zeqals6rbj51bhjn8b89\\",\\n \\"SecurityGroupId\\": \\"sg-2zeehz13zcyj1kfk3o85\\",\\n \\"CidrBlock\\": \\"192.168.17.0/24\\",\\n \\"ZoneId\\": \\"cn-shenzhen-d\\"\\n }\\n ]\\n },\\n \\"InstanceClusterId\\": \\"apigateway-cluster-sh-1523cafbgffd\\",\\n \\"MaintainStartTime\\": \\"22:00Z\\",\\n \\"MaintainEndTime\\": \\"01:00Z\\",\\n \\"ConnectCidrBlocks\\": \\"[\\\\\\\\\\\\\\"172.16.0.0/24\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"172.16.1.0/24\\\\\\\\\\\\\\"]\\",\\n \\"PrivateDnsList\\": {\\n \\"PrivateDns\\": [\\n \\"www.private.com\\"\\n ]\\n },\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"tag3\\",\\n \\"Value\\": \\"50699_0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询实例列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'],
],
],
],
],
],
'DescribeIpControlPolicyItems' => [
'summary' => '分页查询某IP访问控制下的策略列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94373',
'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => false, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'PolicyItemId',
'in' => 'query',
'schema' => ['description' => '策略ID', 'type' => 'string', 'required' => false, 'example' => 'P151617000829241'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IpControlPolicyItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IpControlPolicyItem' => [
'description' => '由 IpControlPolicyItem组成的数组格式,返回的是某IP访问控制下的策略信息。'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModifiedTime' => ['description' => '修改时间(UTC)', 'type' => 'string', 'example' => '2018-01-17T06:25:13Z'],
'PolicyItemId' => ['description' => '某项策略的ID', 'type' => 'string', 'example' => 'P151617000829241'],
'CidrIp' => ['description' => 'IP或者IP段组成的字符串', 'type' => 'string', 'example' => '113.125.XX.XX;101.11.XX.XX'],
'CreateTime' => ['description' => '创建时间(UTC)', 'type' => 'string', 'example' => '2018-01-17T06:20:08Z'],
'AppId' => ['description' => '应用ID', 'type' => 'string', 'example' => '11112'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询IP访问控制策略列表',
'description' => '- 此功能面向API提供者'."\n"
.'- 可支持策略ID过滤'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControlPolicyItems'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeIpControlPolicyItems',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"IpControlPolicyItems\\": {\\n \\"IpControlPolicyItem\\": [\\n {\\n \\"ModifiedTime\\": \\"2018-01-17T06:25:13Z\\",\\n \\"PolicyItemId\\": \\"P151617000829241\\",\\n \\"CidrIp\\": \\"113.125.XX.XX;101.11.XX.XX\\",\\n \\"CreateTime\\": \\"2018-01-17T06:20:08Z\\",\\n \\"AppId\\": \\"11112\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 2\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n P151617000829241\\r\\n 2018-01-17T06:20:08Z\\r\\n 2018-01-17T06:25:13Z\\r\\n 113.125.1.101;101.11.1.1\\r\\n 11112\\r\\n \\r\\n \\r\\n P151616809156728\\r\\n 2018-01-17T05:48:11Z\\r\\n 2018-01-17T05:48:11Z\\r\\n 102.0.0.0/8\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeIpControls' => [
'summary' => '调用DescribeIpControls分页查询用户自定义的IP访问控制列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94374',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => false, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'IpControlName',
'in' => 'query',
'schema' => ['description' => '访问控制名称', 'type' => 'string', 'required' => false, 'example' => 'Access control test'],
],
[
'name' => 'IpControlType',
'in' => 'query',
'schema' => ['description' => 'IP访问控制类型:'."\n"
."\n"
.'- **ALLOW**:IP访问控制为白名单类型'."\n"
.'- **REFUSE**:IP访问控制为黑名单类型', 'type' => 'string', 'required' => false, 'example' => 'ALLOW'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'IpControlInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IpControlInfo' => [
'description' => '由IpControlInfo组成的数组格式,返回的是IP访问控制的信息项(不包含具体的策略)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IpControlId' => ['description' => 'IP访问控制编号', 'type' => 'string', 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
'IpControlType' => ['description' => 'IP访问控制类型', 'type' => 'string', 'example' => 'ALLOW'],
'ModifiedTime' => ['description' => '修改时间(UTC)', 'type' => 'string', 'example' => '2018-01-17T06:00:38Z'],
'IpControlName' => ['description' => 'IP访问控制名称', 'type' => 'string', 'example' => 'testControl11'],
'Description' => ['description' => '描述', 'type' => 'string', 'example' => 'description'],
'CreateTime' => ['description' => '创建时间(UTC)', 'type' => 'string', 'example' => '2018-01-17T05:48:11Z'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"IpControlInfos\\": {\\n \\"IpControlInfo\\": [\\n {\\n \\"IpControlId\\": \\"7ea91319a34d48a09b5c9c871d9768b1\\",\\n \\"IpControlType\\": \\"ALLOW\\",\\n \\"ModifiedTime\\": \\"2018-01-17T06:00:38Z\\",\\n \\"IpControlName\\": \\"testControl11\\",\\n \\"Description\\": \\"description\\",\\n \\"CreateTime\\": \\"2018-01-17T05:48:11Z\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n 7ea91319a34d48a09b5c9c871d9768b1\\r\\n testControl11\\r\\n ALLOW\\r\\n description\\r\\n 2018-01-17T05:48:11Z\\r\\n 2018-01-17T06:00:38Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询IP访问控制列表',
'description' => '- 此功能面向API提供者'."\n"
.'- 用于查询某Region下的IP访问控制列表,Region为系统参数'."\n"
.'- 可根据控制ID,名称,类型等过滤'."\n"
.'- 该接口不含具体的策略,如果需要查询详细策略,请用[查询IP访问控制策略列表](~~65532~~)接口',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControls'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeIpControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'],
],
],
],
],
],
'DescribeLogConfig' => [
'summary' => '查询日志配置',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94375',
'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'],
],
'parameters' => [
[
'name' => 'LogType',
'in' => 'query',
'schema' => [
'description' => '日志类型',
'type' => 'string',
'required' => false,
'example' => 'PROVIDER',
'default' => 'PROVIDER',
'enum' => ['PROVIDER'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'E3BC2706-ABDB-5B64-A12F-08DFD9E3F339'],
'LogInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LogInfo' => [
'description' => '日志信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SlsLogStore' => ['description' => 'SLS 的 log store 值。', 'type' => 'string', 'example' => 'slsstore'],
'LogType' => ['description' => '日志类型', 'type' => 'string', 'example' => 'PROVIDER'],
'SlsProject' => ['description' => 'SLS 项目', 'type' => 'string', 'example' => 'slsproject'],
'RegionId' => ['description' => '日志服务的区域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取日志配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogConfig'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/{#LogType}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3BC2706-ABDB-5B64-A12F-08DFD9E3F339\\",\\n \\"LogInfos\\": {\\n \\"LogInfo\\": [\\n {\\n \\"SlsLogStore\\": \\"slsstore\\",\\n \\"LogType\\": \\"PROVIDER\\",\\n \\"SlsProject\\": \\"slsproject\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeMarketRemainsQuota' => [
'summary' => '给购买者查询订购关系剩余次数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94376',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.demo.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RemainsQuota' => ['description' => '剩余配额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06'],
],
'description' => '',
],
],
],
'title' => '描述剩余配额',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMarketRemainsQuota'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeMarketRemainsQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RemainsQuota\\": 1000,\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]',
],
'DescribeModels' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94377',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381'],
],
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['description' => '模型的名称', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ModelId',
'in' => 'query',
'schema' => ['description' => '模型ID', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签的key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的值。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '40306469-2FB5-417A-B723-AF1F4A4FA204'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ModelDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ModelDetail' => [
'description' => '由ModelDetail组成的数组格式,返回模型的详细信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModifiedTime' => ['description' => '模型的最后修改时间', 'type' => 'string', 'example' => '2019-01-29T11:07:48Z'],
'GroupId' => ['description' => '模型所属的分组编号', 'type' => 'string', 'example' => '30e792398d6c4569b04c0e53a3494381'],
'Description' => ['description' => '模型的定义说明', 'type' => 'string', 'example' => 'Model Description'],
'Schema' => ['description' => '模型的定义', 'type' => 'string', 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}'],
'ModelName' => ['description' => '模型的名称', 'type' => 'string', 'example' => 'Test'],
'CreatedTime' => ['description' => '模型的创建时间', 'type' => 'string', 'example' => '2019-01-29T11:07:48Z'],
'ModelId' => ['description' => '模型的编号', 'type' => 'string', 'example' => '766c0b9538a04bdf974953b5576783ba'],
'ModelRef' => ['description' => '模型的URI', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'ENV'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => 'ST4'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取已创建的模型',
'summary' => '获取API分组已创建的模型。',
'description' => '- 模型查询支持模糊查询',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModels'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeModels',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"40306469-2FB5-417A-B723-AF1F4A4FA204\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ModelDetails\\": {\\n \\"ModelDetail\\": [\\n {\\n \\"ModifiedTime\\": \\"2019-01-29T11:07:48Z\\",\\n \\"GroupId\\": \\"30e792398d6c4569b04c0e53a3494381\\",\\n \\"Description\\": \\"Model Description\\",\\n \\"Schema\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"int64\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maximum\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"exclusiveMaximum\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"integer\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"maxLength\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\"}}}\\",\\n \\"ModelName\\": \\"Test\\",\\n \\"CreatedTime\\": \\"2019-01-29T11:07:48Z\\",\\n \\"ModelId\\": \\"766c0b9538a04bdf974953b5576783ba\\",\\n \\"ModelRef\\": \\"https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba\\",\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"ENV\\",\\n \\"Value\\": \\"ST4\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n 1\\r\\n 10\\r\\n 40306469-2FB5-417A-B723-AF1F4A4FA204\\r\\n \\r\\n \\r\\n Model Description\\r\\n 766c0b9538a04bdf974953b5576783ba\\r\\n 2019-01-29T11:07:48Z\\r\\n Test\\r\\n {"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}\\r\\n https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba\\r\\n 2019-01-29T11:07:48Z\\r\\n 30e792398d6c4569b04c0e53a3494381\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribePluginApis' => [
'summary' => '查询插件绑定的API列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94378',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API网关插件的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bf6583efcef44c51adb00c4e********'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API所属分组ID。', 'type' => 'string', 'required' => false, 'example' => '231a4bb81ee94da785733c29********'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号。', 'type' => 'string', 'required' => false, 'example' => 'c6b0dd188b0e4e408e12f926********'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称。', 'type' => 'string', 'required' => false, 'example' => 'API name'],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['description' => 'API请求路径。', 'type' => 'string', 'required' => false, 'example' => '/sendVerifyCode'],
],
[
'name' => 'Method',
'in' => 'query',
'schema' => ['description' => 'API的请求HTTP Method。', 'type' => 'string', 'required' => false, 'example' => 'GET'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API描述信息。', 'type' => 'string', 'required' => false, 'example' => 'API description'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数,每页显示条数,默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '请求的返回数据',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F9C5C4A5-BC6C-57A3-839F-AB08********'],
'PageSize' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果总数', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'ApiSummarys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiPluginSummary' => [
'description' => 'API信息集合',
'type' => 'array',
'items' => [
'description' => 'API信息',
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API编号', 'type' => 'string', 'example' => 'accc8c68b7294b1cb4928741********'],
'Description' => ['description' => 'API描述信息', 'type' => 'string', 'example' => 'API description'],
'GroupName' => ['description' => 'API所属的分组名称', 'type' => 'string', 'example' => 'myGroup2'],
'GroupId' => ['description' => 'API分组编号', 'type' => 'string', 'example' => '5f51f89261854fd9ad5116be********'],
'Path' => ['description' => 'API的请求路径', 'type' => 'string', 'example' => '/mqTest'],
'Method' => ['description' => 'API的请求HTTP Method', 'type' => 'string', 'example' => 'GET'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'fhosQueryDayOfStock_V2'],
'RegionId' => ['description' => 'API所在地域ID', 'type' => 'string', 'example' => 'cn-shanghai'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => 'Production'],
],
],
],
],
'description' => '',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"F9C5C4A5-BC6C-57A3-839F-AB08********\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 7,\\n \\"ApiSummarys\\": {\\n \\"ApiPluginSummary\\": [\\n {\\n \\"ApiId\\": \\"accc8c68b7294b1cb4928741********\\",\\n \\"Description\\": \\"API description\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"5f51f89261854fd9ad5116be********\\",\\n \\"Path\\": \\"/mqTest\\",\\n \\"Method\\": \\"GET\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"fhosQueryDayOfStock_V2\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"StageAlias\\": \\"Production\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询插件绑定的API列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
],
'DescribePluginGroups' => [
'summary' => '根据插件查询绑定的分组列表',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => 'API网关插件ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1f3bde29b43d4d53989248327ff737f2'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID', 'type' => 'string', 'required' => false, 'example' => '8cc2a3cbe3394524b6e71be5db9b02a3'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => 'API分组名称', 'type' => 'string', 'required' => false, 'example' => 'crm_custom_service'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API分组描述信息', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '765BC99E-F583-5A80-9A42-42AC125C2CDC'],
'PageSize' => ['description' => '分页参数:每页显示条数,默认值10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'GroupSummarys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GroupPluginSummary' => [
'description' => '分组信息集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'test'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'ECP_API'],
'GroupId' => ['description' => 'API分组 ID', 'type' => 'string', 'example' => '4ed31575e2de43de8c51eb1217a1f56b'],
'BasePath' => ['description' => 'api根路径', 'type' => 'string', 'example' => '/rpew'],
'StageName' => ['description' => '环境名称,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'example' => 'RELEASE'],
'RegionId' => ['description' => 'API分组所在地域ID', 'type' => 'string', 'example' => 'cn-beijing'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => 'DEV'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询插件绑定的分组列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginGroups'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"765BC99E-F583-5A80-9A42-42AC125C2CDC\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"GroupSummarys\\": {\\n \\"GroupPluginSummary\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"GroupName\\": \\"ECP_API\\",\\n \\"GroupId\\": \\"4ed31575e2de43de8c51eb1217a1f56b\\",\\n \\"BasePath\\": \\"/rpew\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"StageAlias\\": \\"DEV\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePluginSchemas' => [
'summary' => '描述API网关支持的插件模式。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94381',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '指定返回结果中管控策略描述的语言。取值:'."\n"
."\n"
.'- zh-CN(默认值):中文。'."\n"
.'- en:英文。'."\n"
.'- ja:日文。', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989'],
'PluginSchemas' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PluginSchema' => [
'description' => '插件模式列表',
'type' => 'array',
'items' => [
'description' => '插件模式列表',
'type' => 'object',
'properties' => [
'Title' => ['description' => '插件标题', 'type' => 'string', 'example' => 'plugin schema title'],
'Description' => ['description' => '插件描述', 'type' => 'string', 'example' => 'plugin scheme description'],
'Name' => ['description' => '插件名称', 'type' => 'string', 'example' => 'VPC_C'],
'DocumentId' => ['description' => '文档ID', 'type' => 'string', 'example' => '4107**'],
'SupportClassic' => ['description' => '是否支持分类', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '描述插件模式',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginSchemas'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginSchemas',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989\\",\\n \\"PluginSchemas\\": {\\n \\"PluginSchema\\": [\\n {\\n \\"Title\\": \\"plugin schema title\\",\\n \\"Description\\": \\"plugin scheme description\\",\\n \\"Name\\": \\"VPC_C\\",\\n \\"DocumentId\\": \\"4107**\\",\\n \\"SupportClassic\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePluginTemplates' => [
'summary' => '查询插件模板',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94382',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'PluginName',
'in' => 'query',
'schema' => ['description' => 'API网关插件名称', 'type' => 'string', 'required' => false, 'example' => 'jwtAuth'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n"
."\n"
.'- en:英文。'."\n"
.'- zh-CN:中文。'."\n"
.'- ja:日文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
'Templates' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '模板列表',
'type' => 'array',
'items' => [
'description' => '模板列表',
'type' => 'object',
'properties' => [
'Title' => ['description' => '插件模版标题', 'type' => 'string', 'example' => 'template title'],
'DocumentAnchor' => ['description' => '文档锚点。', 'type' => 'string', 'example' => 'anchor'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'balabala'],
'DocumentId' => ['description' => '文档ID', 'type' => 'string', 'example' => '41079'],
'Sample' => ['description' => '样例。', 'type' => 'string', 'example' => '1'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取插件模板列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginTemplates'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"Title\\": \\"template title\\",\\n \\"DocumentAnchor\\": \\"anchor\\",\\n \\"Description\\": \\"balabala\\",\\n \\"DocumentId\\": \\"41079\\",\\n \\"Sample\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePlugins' => [
'summary' => '查询插件列表及详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94379',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => 'API网关插件ID', 'type' => 'string', 'required' => false, 'example' => 'a96926e82f994915a8da40a119374537 '],
],
[
'name' => 'PluginType',
'in' => 'query',
'schema' => ['description' => 'API网关插件业务类型', 'type' => 'string', 'required' => false, 'example' => 'cors'],
],
[
'name' => 'PluginName',
'in' => 'query',
'schema' => ['description' => 'API网关插件名称', 'type' => 'string', 'required' => false, 'example' => 'testPlugin'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Plugins' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PluginAttribute' => [
'description' => '由 PluginAttribute 组成的数组格式,返回插件信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PluginId' => ['description' => '插件ID', 'type' => 'string', 'example' => '9a3f1a5279434f2ba74ccd91c295af9f'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z'],
'PluginData' => ['description' => '插件定义语句', 'type' => 'string', 'example' => '{"unit":"MINUTE","apiDefault":20}'],
'Description' => ['description' => '插件描述', 'type' => 'string', 'example' => 'Throttling'],
'PluginName' => ['description' => '插件名称', 'type' => 'string', 'example' => 'firstPlugin'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z'],
'PluginType' => ['description' => '插件类型', 'type' => 'string', 'example' => 'trafficControl'],
'RegionId' => ['description' => '插件所在Region', 'type' => 'string', 'example' => 'cn-qingdao'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'example' => 'testkey'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => 'tetstvalue'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"46373DC4-19F1-4DC8-8C31-1107289BB5E0\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Plugins\\": {\\n \\"PluginAttribute\\": [\\n {\\n \\"PluginId\\": \\"9a3f1a5279434f2ba74ccd91c295af9f\\",\\n \\"ModifiedTime\\": \\"2019-01-11T09:29:58Z\\",\\n \\"PluginData\\": \\"{\\\\\\"unit\\\\\\":\\\\\\"MINUTE\\\\\\",\\\\\\"apiDefault\\\\\\":20}\\",\\n \\"Description\\": \\"Throttling\\",\\n \\"PluginName\\": \\"firstPlugin\\",\\n \\"CreatedTime\\": \\"2019-01-11T09:29:58Z\\",\\n \\"PluginType\\": \\"trafficControl\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"testkey\\",\\n \\"Value\\": \\"tetstvalue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 46373DC4-19F1-4DC8-8C31-1107289BB5E0\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n 9a3f1a5279434f2ba74ccd91c295af9f\\r\\n firstPlugin\\r\\n cn-qingdao\\r\\n trafficControl\\r\\n {\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}\\r\\n 流控\\r\\n 2019-01-11T09:29:58Z\\r\\n 2019-01-11T09:29:58Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询插件列表',
'description' => '- 支持分页'."\n"
.'- 支持按照插件业务类型查询'."\n"
.'- 支持按照插件ID查询'."\n"
.'- 支持按照插件名称查询',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlugins'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePlugins',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'],
],
],
],
],
],
'DescribePluginsByApi' => [
'summary' => '查询指定环境指定API上绑定的一组插件,该API在该环境必须是运行中状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94380',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API所属分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3c7a38392e764718ad7673e7b7f535d4'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '93f4ead4080c4b2da70b7f81f50ae459'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Plugins' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PluginAttribute' => [
'description' => '由PluginAttribute组成的数组格式,返回插件的信息项',
'type' => 'array',
'items' => [
'description' => '返回插件的信息',
'type' => 'object',
'properties' => [
'PluginId' => ['description' => '插件ID', 'type' => 'string', 'example' => '9a3f1a5279434f2ba74ccd91c295af9f'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z'],
'PluginData' => ['description' => '插件定义语句', 'type' => 'string', 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}'],
'Description' => ['description' => '插件描述', 'type' => 'string', 'example' => 'Throttling'],
'PluginName' => ['description' => '插件名称', 'type' => 'string', 'example' => 'firstPlugin'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z'],
'PluginType' => ['description' => '插件类型', 'type' => 'string', 'example' => 'trafficControl'],
'RegionId' => ['description' => '插件所在Region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"46373DC4-19F1-4DC8-8C31-1107289BB5E0\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Plugins\\": {\\n \\"PluginAttribute\\": [\\n {\\n \\"PluginId\\": \\"9a3f1a5279434f2ba74ccd91c295af9f\\",\\n \\"ModifiedTime\\": \\"2019-01-11T09:29:58Z\\",\\n \\"PluginData\\": \\"{\\\\\\\\\\\\\\"unit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MINUTE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"apiDefault\\\\\\\\\\\\\\":20}\\",\\n \\"Description\\": \\"Throttling\\",\\n \\"PluginName\\": \\"firstPlugin\\",\\n \\"CreatedTime\\": \\"2019-01-11T09:29:58Z\\",\\n \\"PluginType\\": \\"trafficControl\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询API上绑定的插件',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 支持分页',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginsByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribePluginsByGroup' => [
'summary' => '查询API分组绑定的插件',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171238',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '分页参数:当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5F5574BA-F22B-563D-841E-C817964F517F'],
'PageSize' => ['description' => '分页参数:每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
'Plugins' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PluginAttribute' => [
'description' => '返回插件的信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PluginId' => ['description' => '插件ID', 'type' => 'string', 'example' => '5e204eeb4aa94c919a49f471ad3fc716'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2022-03-15T02:30:18Z'],
'PluginData' => ['description' => '插件定义语句', 'type' => 'string', 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}'],
'Description' => ['description' => '插件描述', 'type' => 'string', 'example' => 'Throttling'],
'PluginName' => ['description' => '插件名称', 'type' => 'string', 'example' => 'firstPlugin'],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2024-12-20T02:05:57Z'],
'PluginType' => ['description' => '插件类型', 'type' => 'string', 'example' => 'trafficControl'],
'RegionId' => ['description' => '插件所在Region', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5F5574BA-F22B-563D-841E-C817964F517F\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 32,\\n \\"Plugins\\": {\\n \\"PluginAttribute\\": [\\n {\\n \\"PluginId\\": \\"5e204eeb4aa94c919a49f471ad3fc716\\",\\n \\"ModifiedTime\\": \\"2022-03-15T02:30:18Z\\",\\n \\"PluginData\\": \\"{\\\\\\\\\\\\\\"unit\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MINUTE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"apiDefault\\\\\\\\\\\\\\":20}\\",\\n \\"Description\\": \\"Throttling\\",\\n \\"PluginName\\": \\"firstPlugin\\",\\n \\"CreatedTime\\": \\"2024-12-20T02:05:57Z\\",\\n \\"PluginType\\": \\"trafficControl\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询API分组绑定的插件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginsByGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribePurchasedApiGroup' => [
'summary' => '获取云市场购买的 API 分组详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94387',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'example' => '102b631ae1094e33a77c45312226184e'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '分组状态'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **DELETE**:删除', 'type' => 'string', 'example' => 'NORMAL'],
'PurchasedTime' => ['description' => '购买时间', 'type' => 'string', 'example' => '2021-12-19T00:00:00'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2'],
'GroupId' => ['description' => 'api分组id', 'type' => 'string', 'example' => '48977d7b96074966a7c9c2a8872d7e06'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'Weather'],
'Description' => ['description' => 'api分组描述', 'type' => 'string', 'example' => 'api group description'],
'RegionId' => ['description' => 'api分组所在区域', 'type' => 'string', 'example' => 'cn-qingdao'],
'Domains' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainItem' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '域名列表。',
'type' => 'object',
'properties' => [
'DomainName' => ['description' => '域名', 'type' => 'string', 'example' => 'test_domain.com'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '获取购买的 API 组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"NORMAL\\",\\n \\"PurchasedTime\\": \\"2021-12-19T00:00:00\\",\\n \\"RequestId\\": \\"61A16D46-EC04-5288-8A18-811B0F536CC2\\",\\n \\"GroupId\\": \\"48977d7b96074966a7c9c2a8872d7e06\\",\\n \\"GroupName\\": \\"Weather\\",\\n \\"Description\\": \\"api group description\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"Domains\\": {\\n \\"DomainItem\\": [\\n {\\n \\"DomainName\\": \\"test_domain.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePurchasedApiGroups' => [
'summary' => '获取云市场购买的 API 分组列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94388',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E'],
'PageSize' => ['description' => '每页数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'PurchasedApiGroupAttributes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PurchasedApiGroupAttribute' => [
'description' => '采购的API分组属性',
'type' => 'array',
'items' => [
'description' => '采购的API分组属性',
'type' => 'object',
'properties' => [
'Status' => ['description' => '分组状态'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **DELETE**:删除', 'type' => 'string', 'example' => 'NORMAL'],
'PurchasedTime' => ['description' => '购买时间', 'type' => 'string', 'example' => '2021-12-19T00:00:00'],
'ExpireTime' => ['description' => '失效时间', 'type' => 'string', 'example' => '2021-12-19T00:00:00'],
'Description' => ['description' => '分组描述', 'type' => 'string', 'example' => '1'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'group1'],
'GroupId' => ['description' => 'API分组 ID', 'type' => 'string', 'example' => '8e91f23f88f94348855b82c9a73209f3'],
'InvokeTimesMax' => ['description' => '最大调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'InvokeTimesNow' => ['description' => '当前调用次数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'BillingType' => ['description' => '计费方式', 'type' => 'string', 'example' => 'POSTPAID'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai'],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"36BBBAD4-1CFB-489F-841A-8CA52EEA787E\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"PurchasedApiGroupAttributes\\": {\\n \\"PurchasedApiGroupAttribute\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"PurchasedTime\\": \\"2021-12-19T00:00:00\\",\\n \\"ExpireTime\\": \\"2021-12-19T00:00:00\\",\\n \\"Description\\": \\"1\\",\\n \\"GroupName\\": \\"group1\\",\\n \\"GroupId\\": \\"8e91f23f88f94348855b82c9a73209f3\\",\\n \\"InvokeTimesMax\\": 10,\\n \\"InvokeTimesNow\\": 10,\\n \\"BillingType\\": \\"POSTPAID\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取购买的API分组列表',
'changeSet' => [
['createdAt' => '2022-07-22T07:30:50.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroups'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApiGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
],
],
'DescribePurchasedApis' => [
'summary' => '获取在云市场购买的 API 列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组编号', 'type' => 'string', 'required' => false, 'example' => 'd27ad517be5f4c95ac3631780a8f4d50'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称', 'type' => 'string', 'required' => false, 'example' => 'CZ IP database query API'],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => ['description' => 'API是否公开,目前可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境,会在所有用户的控制台“发现API”页面展示'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
'PageSize' => ['description' => '每页条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'PurchasedApis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PurchasedApi' => [
'description' => '由purchasedapi组成的数组格式,返回api调用延迟监控信息',
'type' => 'array',
'items' => [
'description' => '由purchasedapi组成的数组格式,返回api调用延迟监控信息',
'type' => 'object',
'properties' => [
'Visibility' => ['description' => '可见性,可选值:'."\n"
."\n"
.'- **PUBLIC**:公开'."\n"
.'- **PRIVATE**:私有', 'type' => 'string', 'example' => 'PUBLIC'],
'PurchasedTime' => ['description' => '购买时间', 'type' => 'string', 'example' => '2021-06-11T13:57:38+08:00'],
'ApiId' => ['description' => 'API的ID。', 'type' => 'string', 'example' => 'eb6e54c1576d41149746e8e69b0a0792'],
'ModifiedTime' => ['description' => '最后修改时间,格林威治时间', 'type' => 'string', 'example' => '2021-06-11T13:57:38+08:00'],
'Description' => ['description' => 'API描述', 'type' => 'string', 'example' => 'Test'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'DMS_DEFAULT_GROUP_408589'],
'GroupId' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'example' => '3013a55c0c44483f984d26df27120513'],
'DeployedTime' => ['description' => '部署时间,格式为yyyy-mm-ddhh:mm:ss', 'type' => 'string', 'example' => '2021-06-1113:57:38'],
'StageName' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'example' => 'TEST'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'gw_rado_tissot_'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"PurchasedApis\\": {\\n \\"PurchasedApi\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"PurchasedTime\\": \\"2021-06-11T13:57:38+08:00\\",\\n \\"ApiId\\": \\"eb6e54c1576d41149746e8e69b0a0792\\",\\n \\"ModifiedTime\\": \\"2021-06-11T13:57:38+08:00\\",\\n \\"Description\\": \\"Test\\",\\n \\"GroupName\\": \\"DMS_DEFAULT_GROUP_408589\\",\\n \\"GroupId\\": \\"3013a55c0c44483f984d26df27120513\\",\\n \\"DeployedTime\\": \\"2021-06-1113:57:38\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"gw_rado_tissot_\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取购买的 API 列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'DescribeRegions' => [
'summary' => '查询可以使用的阿里云地域。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94396',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '指定返回结果中管控策略描述的语言。取值:'."\n"
."\n"
.'- zh-CN(默认值):中文。'."\n"
.'- en:英文。'."\n"
.'- ja:日文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求编号', 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E'],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => '由 Region 组成的数组格式,返回区域信息',
'example' => 'cn-huhehaote',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionEndpoint' => ['description' => '区域服务接入点', 'type' => 'string', 'example' => 'apigateway.cn-shenzhen.aliyuncs.com'],
'LocalName' => ['description' => '区域名称', 'type' => 'string', 'example' => 'China (Shenzhen)'],
'RegionId' => ['description' => '区域ID', 'type' => 'string', 'example' => 'cn-shenzhen'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"36BBBAD4-1CFB-489F-841A-8CA52EEA787E\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"apigateway.cn-shenzhen.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Shenzhen)\\",\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"code\\":500}"},{"type":"xml","example":"","errorExample":""}]',
'title' => '查询支持的区域',
'description' => '查询支持的区域列表'."\n"
."\n"
.'* 此功能面向开放API和调用API的用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
],
'DescribeSignatures' => [
'summary' => '查询API网关后端签名密钥列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94399',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定要查询的密钥ID', 'type' => 'string', 'required' => false, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'SignatureName',
'in' => 'query',
'schema' => ['description' => '指定要查询的密钥名称', 'type' => 'string', 'required' => false, 'example' => 'backendsignature'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'SignatureInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SignatureInfo' => [
'description' => '由 SignatureInfo 组成的数组格式,返回后端签名的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModifiedTime' => ['description' => '密钥最后修改时间', 'type' => 'string', 'example' => '2016-07-24T08:28:48Z'],
'SignatureId' => ['description' => '后端签名密钥编号', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'SignatureSecret' => ['description' => '密钥Secret值', 'type' => 'string', 'example' => 'asdfghjkl'],
'SignatureName' => ['description' => '后端签名密钥名称', 'type' => 'string', 'example' => 'backendsignature'],
'SignatureKey' => ['description' => '密钥Key值', 'type' => 'string', 'example' => 'qwertyuiop'],
'CreatedTime' => ['description' => '密钥创建时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'RegionId' => ['description' => '所在的region', 'type' => 'string', 'example' => 'cn-qingdao'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询后端签名密钥列表',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 用于查询某Region下的后端签名密钥列表,Region为系统参数'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignatures'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSignatures',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:secretkey/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"SignatureInfos\\": {\\n \\"SignatureInfo\\": [\\n {\\n \\"ModifiedTime\\": \\"2016-07-24T08:28:48Z\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureSecret\\": \\"asdfghjkl\\",\\n \\"SignatureName\\": \\"backendsignature\\",\\n \\"SignatureKey\\": \\"qwertyuiop\\",\\n \\"CreatedTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n 20\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n cn-qingdao\\r\\n dd05f1c54d6749eda95f9fa6d491449a \\r\\n backendsignature\\r\\n qwertyuiop\\r\\n asdfghjkl\\r\\n 2016-07-23T08:28:48Z\\r\\n 2016-07-24T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeSignaturesByApi' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94400',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API所属分组', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API编号', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'Signatures' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SignatureItem' => [
'description' => '由 SignatureItem 组成的数组格式,返回后端签名密钥的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'SignatureId' => ['description' => '后端签名密钥ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'SignatureName' => ['description' => '后端签名密钥名称', 'type' => 'string', 'example' => 'mysecret'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API绑定的后端签名密钥',
'summary' => '查询指定API已绑定的后端签名密钥。',
'description' => '- 此功能面向开放API的用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignaturesByApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSignaturesByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"Signatures\\": {\\n \\"SignatureItem\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"mysecret\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n \\r\\n \\r\\n dd05f1c54d6749eda95f9fa6d491449a \\r\\n mysecret\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeStageModels' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '103436',
'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'],
],
'parameters' => [
[
'name' => 'StageAlias',
'in' => 'query',
'schema' => ['description' => '环境别名', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '生产环境'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RELEASE'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页数目', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZxxx'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'StageModelInfoList' => [
'description' => '环境配置详情列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StageModelId' => ['description' => '环境配置 ID', 'type' => 'string', 'example' => 'j3j435j23l4j23l55xxx'],
'StageAlias' => ['description' => '环境别名', 'type' => 'string', 'example' => '生产环境'],
'StageName' => ['description' => '环境名称', 'type' => 'string', 'example' => 'PRE'],
'Type' => ['description' => '环境类型', 'type' => 'string', 'example' => 'CUSTOM'],
'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'Stage description'],
'ModifiedTime' => ['description' => '修改时间', 'type' => 'string', 'example' => '2024-12-10T00:01:09Z'],
'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-08-13T01:54:03Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'title' => '查询环境配置列表',
'summary' => '查询环境列表',
'description' => '- 模型查询支持模糊查询',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZxxx\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"StageModelInfoList\\": [\\n {\\n \\"StageModelId\\": \\"j3j435j23l4j23l55xxx\\",\\n \\"StageAlias\\": \\"生产环境\\",\\n \\"StageName\\": \\"PRE\\",\\n \\"Type\\": \\"CUSTOM\\",\\n \\"Description\\": \\"Stage description\\",\\n \\"ModifiedTime\\": \\"2024-12-10T00:01:09Z\\",\\n \\"CreatedTime\\": \\"2025-08-13T01:54:03Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeSummaryData' => [
'summary' => '查看API网关在指定region下的资源数量。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'UsageGroupNum' => ['description' => 'API分组的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'UsageInstanceNum' => ['description' => '运行中的专享实例数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'UsageApiNum' => ['description' => 'API的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Region' => ['description' => '地区', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ExpireInstanceNum' => ['description' => '14天内将要过期的预付费专享实例的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'description' => '',
],
],
],
'title' => '获取摘要数据',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSummaryData'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSummaryData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"UsageGroupNum\\": 1,\\n \\"UsageInstanceNum\\": 1,\\n \\"UsageApiNum\\": 10,\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ExpireInstanceNum\\": 1\\n}","type":"json"}]',
],
'DescribeSystemParameters' => [
'summary' => '查询系统支持的公共参数。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94406',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0CCDF65E-6050-412D-AD68-FA3D9196836C'],
'SystemParams' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SystemParamItem' => [
'description' => '由 SystemParam 组成的数组格式,返回系统参数信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DemoValue' => ['description' => '示例', 'type' => 'string', 'example' => '192.168.1.1'],
'Description' => ['description' => '参数描述', 'type' => 'string', 'example' => 'Client IP'],
'ParamName' => ['description' => '参数名称', 'type' => 'string', 'example' => 'CaClientIp'],
'ParamType' => ['description' => '参数类型', 'type' => 'string', 'example' => 'string'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0CCDF65E-6050-412D-AD68-FA3D9196836C\\",\\n \\"SystemParams\\": {\\n \\"SystemParamItem\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"Client IP\\",\\n \\"ParamName\\": \\"CaClientIp\\",\\n \\"ParamType\\": \\"string\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 0CCDF65E-6050-412D-AD68-FA3D9196836C\\r\\n \\r\\n \\r\\n 客户端IP\\r\\n 192.168.1.1\\r\\n CaClientIp\\r\\n string\\r\\n \\r\\n \\r\\n 请求域名\\r\\n api.aliyun.com\\r\\n CaDomain\\r\\n string\\r\\n \\r\\n \\r\\n 请求时间(格林威治时间)\\r\\n 2016-01-30T03:53:16Z\\r\\n CaRequestHandleTime\\r\\n string\\r\\n \\r\\n \\r\\n ConsumerAppId\\r\\n 123456\\r\\n CaAppId\\r\\n string\\r\\n \\r\\n \\r\\n RequestId\\r\\n 7157EBD9-4684-4827-B3B0-9B32D186819B\\r\\n CaRequestId\\r\\n string\\r\\n \\r\\n \\r\\n Http Schema\\r\\n https\\r\\n CaHttpSchema\\r\\n string\\r\\n \\r\\n \\r\\n 代理\\r\\n AliCloudApiGateway\\r\\n CaProxy\\r\\n string\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询系统参数列表',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 此接口返回定义API时可选择接收的系统参数列表'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemParameters'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSystemParameters',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeTrafficControls' => [
'summary' => '查询用户自定义的流控策略列表及详情信息,支持条件查询。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94409',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '流控策略ID', 'type' => 'string', 'required' => false, 'example' => 'tf123456'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号,必须和**ApiId**、**StageName**一起查询', 'type' => 'string', 'required' => false, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定的API编号,必须和**GroupId**、**StageName**一起查询', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,必须和**GroupId**、**ApiId**一起查询 ,可选值:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
[
'name' => 'TrafficControlName',
'in' => 'query',
'schema' => ['description' => '流控策略名称', 'type' => 'string', 'required' => false, 'example' => 'Throttling test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '93D91A99-F093-4596-87BA-3C4FBFD3FD8A'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TrafficControls' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TrafficControl' => [
'description' => '由 TrafficControl 组成的数组格式,返回流控策略信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UserDefault' => ['description' => '每个用户默认的流控值', 'type' => 'integer', 'format' => 'int32', 'example' => '15000'],
'ApiDefault' => ['description' => '每个API默认流控值', 'type' => 'integer', 'format' => 'int32', 'example' => '20000'],
'ModifiedTime' => ['description' => '上一次修改时间(格林威治时间)', 'type' => 'string', 'example' => '2016-01-27T10:34:38Z'],
'Description' => ['description' => '流控策略描述', 'type' => 'string', 'example' => 'test'],
'TrafficControlUnit' => ['description' => '流控策略单位,可选值:'."\n"
."\n"
.'- MINUTE:分钟'."\n"
.'- HOUR:小时'."\n"
.'- DAY:天', 'type' => 'string', 'example' => 'Minute'],
'TrafficControlName' => ['description' => '流控策略名称', 'type' => 'string', 'example' => 'wulingtestq1'],
'AppDefault' => ['description' => '每个app默认的流控值', 'type' => 'integer', 'format' => 'int32', 'example' => '8000'],
'TrafficControlId' => ['description' => '流控策略ID', 'type' => 'string', 'example' => 'cfed6c970d45481dbe136d6b5ac68c41'],
'CreatedTime' => ['description' => '创建时间(格林威治时间)', 'type' => 'string', 'example' => '2016-01-27T10:19:39Z'],
'SpecialPolicies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SpecialPolicy' => [
'description' => '由 SpecialPolicy 组成的数组格式,返回特殊流控策略信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SpecialType' => ['description' => '特殊流控类型,可选值:'."\n"
."\n"
.'- **APP**:应用'."\n"
.'- **USER**:用户', 'type' => 'string', 'example' => 'USER'],
'Specials' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Special' => [
'description' => '由 Special 组成的数组格式,返回特殊流控策略数据项信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TrafficValue' => ['description' => '流控值', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'SpecialKey' => ['description' => '根据SpecialType对应的AppId或者是用户账号', 'type' => 'string', 'example' => 'test_wg@aliyun.com'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"93D91A99-F093-4596-87BA-3C4FBFD3FD8A\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"TrafficControls\\": {\\n \\"TrafficControl\\": [\\n {\\n \\"UserDefault\\": 15000,\\n \\"ApiDefault\\": 20000,\\n \\"ModifiedTime\\": \\"2016-01-27T10:34:38Z\\",\\n \\"Description\\": \\"test\\",\\n \\"TrafficControlUnit\\": \\"Minute\\",\\n \\"TrafficControlName\\": \\"wulingtestq1\\",\\n \\"AppDefault\\": 8000,\\n \\"TrafficControlId\\": \\"cfed6c970d45481dbe136d6b5ac68c41\\",\\n \\"CreatedTime\\": \\"2016-01-27T10:19:39Z\\",\\n \\"SpecialPolicies\\": {\\n \\"SpecialPolicy\\": [\\n {\\n \\"SpecialType\\": \\"USER\\",\\n \\"Specials\\": {\\n \\"Special\\": [\\n {\\n \\"TrafficValue\\": 100,\\n \\"SpecialKey\\": \\"test_wg@aliyun.com\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n 10\\r\\n 1\\r\\n 93D91A99-F093-4596-87BA-3C4FBFD3FD8A\\r\\n \\r\\n \\r\\n cfed6c970d45481dbe136d6b5ac68c41\\r\\n 20000\\r\\n Minute\\r\\n wulingtestq1\\r\\n 2016-01-27T10:34:38Z\\r\\n 15000\\r\\n 8000\\r\\n test\\r\\n 2016-01-27T10:19:39Z\\r\\n \\r\\n \\r\\n User\\r\\n \\r\\n \\r\\n 100\\r\\n test_wg@aliyun.com\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n App\\r\\n \\r\\n \\r\\n 100\\r\\n 12345678\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询流控策略列表及详情',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略,包括详细信息'."\n"
.'- 此接口还可以支持条件查询,如查询指定接口所绑定的流控策略,如查询指定环境下的流控策略',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControls'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeTrafficControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
],
],
'DescribeTrafficControlsByApi' => [
'summary' => '查询指定API已绑定的流控策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94410',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要查询的API所属分组', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => '指定要查询的Api编号', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要查询的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'TrafficControlItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TrafficControlItem' => [
'description' => '由 TrafficControlItem 组成的数组格式,返回策略的信息项',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TrafficControlItemId' => ['description' => '流控策略ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'BoundTime' => ['description' => '绑定时间', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z'],
'TrafficControlItemName' => ['description' => '流控策略名称', 'type' => 'string', 'example' => 'mysecret'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询API绑定的流控策略',
'description' => '- 此功能面向开放API的用户'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControlsByApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeTrafficControlsByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"TrafficControlItems\\": {\\n \\"TrafficControlItem\\": [\\n {\\n \\"TrafficControlItemId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"TrafficControlItemName\\": \\"mysecret\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n \\r\\n \\r\\n dd05f1c54d6749eda95f9fa6d491449a \\r\\n mysecret\\r\\n 2016-07-23T08:28:48Z\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'DescribeUpdateBackendTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '119939',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'OperationUid',
'in' => 'query',
'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4e13c3e0c44c4a4ebb5231264eeb9bc1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
'ApiUpdateBackendResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiUpdateBackendResult' => [
'description' => 'API的更新结果',
'type' => 'array',
'items' => [
'description' => 'API的更新结果',
'type' => 'object',
'properties' => [
'StageId' => ['description' => '运行环境编号', 'type' => 'string', 'example' => 'd8f2f54f3309458b8aaceb36c01c2dd9'],
'UpdateStatus' => ['description' => 'API更新结果', 'type' => 'string', 'example' => 'OVER'],
'GroupName' => ['description' => '分组名称', 'type' => 'string', 'example' => 'imotob1'],
'GroupId' => ['description' => '分组ID', 'type' => 'string', 'example' => '3013a55c0c44483f984d26df27120513'],
'ApiUid' => ['description' => 'API的ID', 'type' => 'string', 'example' => '14faa7ba0572445685866ddb6a6f19da'],
'ErrorMsg' => ['description' => '更新失败的错误信息', 'type' => 'string', 'example' => 'Failed'],
'StageName' => ['description' => '环境名称', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'checkin_linechart_today'],
'BackendId' => ['description' => '后端服务ID', 'type' => 'string', 'example' => 'c09b078bcb8f4ade9677bd8b18cdf43f'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询后端服务更新任务',
'summary' => '修改后端服务在某个环境上的定义时,关联的已发布API会批量更新,该接口用来查询更新的结果。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateBackendTask'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeUpdateBackendTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\",\\n \\"ApiUpdateBackendResults\\": {\\n \\"ApiUpdateBackendResult\\": [\\n {\\n \\"StageId\\": \\"d8f2f54f3309458b8aaceb36c01c2dd9\\",\\n \\"UpdateStatus\\": \\"OVER\\",\\n \\"GroupName\\": \\"imotob1\\",\\n \\"GroupId\\": \\"3013a55c0c44483f984d26df27120513\\",\\n \\"ApiUid\\": \\"14faa7ba0572445685866ddb6a6f19da\\",\\n \\"ErrorMsg\\": \\"Failed\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"checkin_linechart_today\\",\\n \\"BackendId\\": \\"c09b078bcb8f4ade9677bd8b18cdf43f\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeUpdateVpcInfoTask' => [
'summary' => '更新VPC授权会异步更新关联的发布中的API,该API用来查询这些API的更新进度。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94411',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'OperationUid',
'in' => 'query',
'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7d341787517a47afaaef9cc1bdb7acce'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'ApiUpdateVpcInfoResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiUpdateVpcInfoResult' => [
'description' => '任务结果列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StageId' => ['description' => '阶段id', 'type' => 'string', 'example' => 'fe952b95072747e2a8dfd336bcff8d7f'],
'UpdateStatus' => ['description' => '更新状态', 'type' => 'string', 'example' => 'success'],
'GroupId' => ['description' => 'api分组编号', 'type' => 'string', 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b'],
'GroupName' => ['description' => 'api分组名称', 'type' => 'string', 'example' => 'test'],
'ApiUid' => ['description' => 'api编号', 'type' => 'string', 'example' => '86364e7c166c47ba819b3f8f95ac0913'],
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Success. Request Success.'],
'StageName' => ['description' => 'API发布的环境', 'type' => 'string', 'example' => 'RELEASE'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'api_test2'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '查询VPC授权更新状态',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateVpcInfoTask'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeUpdateVpcInfoTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"ApiUpdateVpcInfoResults\\": {\\n \\"ApiUpdateVpcInfoResult\\": [\\n {\\n \\"StageId\\": \\"fe952b95072747e2a8dfd336bcff8d7f\\",\\n \\"UpdateStatus\\": \\"success\\",\\n \\"GroupId\\": \\"e8da6f6346184da9a30d0dc1888b1f3b\\",\\n \\"GroupName\\": \\"test\\",\\n \\"ApiUid\\": \\"86364e7c166c47ba819b3f8f95ac0913\\",\\n \\"ErrorMsg\\": \\"Success. Request Success.\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"api_test2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeVpcAccesses' => [
'summary' => '查询已授权的VPC列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94417',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '当前页码', 'description' => '指定要查询的页码,默认是1,起始是1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页展示条目', 'description' => '指定分页查询时每页行数,最大值100,默认值为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => 'VPC授权名称', 'description' => '自定义授权名称,需要保持唯一,不能重复', 'type' => 'string', 'required' => false, 'example' => 'wuying-edm-svc'],
],
[
'name' => 'VpcAccessId',
'in' => 'query',
'schema' => ['title' => 'Vpc授权ID', 'description' => 'Vpc授权ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-*****ssds24'],
],
[
'name' => 'AccurateQuery',
'in' => 'query',
'schema' => ['description' => '是否进行精准查询', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['title' => 'Vpc ID', 'description' => '专用网络ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf657qec7lx42paw3qxxx'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => 'VPC授权中的实例ID或IP', 'type' => 'string', 'required' => false, 'example' => '10.199.26.***'],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['title' => '端口号', 'description' => '服务端口。', 'type' => 'string', 'required' => false, 'example' => '8080'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '端口号',
'type' => 'array',
'items' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'appname'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'product'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'VpcAccessAttributes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VpcAccessAttribute' => [
'description' => '由 VpcAccessAttribute 组成的数组格式,返回VPC授权信息',
'type' => 'array',
'items' => [
'description' => '由 VpcAccessAttribute 组成的数组格式,返回VPC授权信息',
'type' => 'object',
'properties' => [
'VpcId' => ['title' => 'VPC的ID', 'description' => '专用网络ID', 'type' => 'string', 'example' => 'vpc-uf657qec7lx42paw3qxxx'],
'Description' => ['title' => 'VPC授权的描述', 'description' => 'VPC授权的描述', 'type' => 'string', 'example' => 'Test'],
'InstanceId' => ['title' => 'VPC中的后端服务信息', 'description' => '专用网络中的实例ID(ECS/SLB)', 'type' => 'string', 'example' => 'i-uf6bzcg1pr4oh5jjmxxx'],
'Port' => ['title' => 'VPC中的后端服务端口', 'description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'Name' => ['title' => 'VPC授权名称', 'description' => '授权名称', 'type' => 'string', 'example' => 'test'],
'CreatedTime' => ['title' => 'VPC授权的创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2017-01-30T04:10:19Z'],
'RegionId' => ['title' => '地域id', 'description' => '地域ID', 'type' => 'string', 'example' => 'cn-hangzhou'],
'VpcAccessId' => ['title' => 'vpc授权ID', 'description' => 'vpc授权ID', 'type' => 'string', 'example' => 'vpc-*****ssds24'],
'VpcTargetHostName' => ['description' => '后端服务的host', 'type' => 'string', 'example' => 'hos-a***.fh-**nc.com'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'PROJECT'],
'Value' => ['description' => '标签值', 'type' => 'string', 'example' => '6427a17ae6041d1be62414e4'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"8883AC74-259D-4C0B-99FC-0B7F9A588B2F\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"VpcAccessAttributes\\": {\\n \\"VpcAccessAttribute\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf657qec7lx42paw3qxxx\\",\\n \\"Description\\": \\"Test\\",\\n \\"InstanceId\\": \\"i-uf6bzcg1pr4oh5jjmxxx\\",\\n \\"Port\\": 80,\\n \\"Name\\": \\"test\\",\\n \\"CreatedTime\\": \\"2017-01-30T04:10:19Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcAccessId\\": \\"vpc-*****ssds24\\",\\n \\"VpcTargetHostName\\": \\"hos-a***.fh-**nc.com\\",\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"PROJECT\\",\\n \\"Value\\": \\"6427a17ae6041d1be62414e4\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n vpc-uf657qec7lx42paw3qxxx\\r\\n i-uf6bzcg1pr4oh5jjmxxx\\r\\n 80\\r\\n test\\r\\n 2017-01-30T04:10:19Z \\r\\n \\r\\n \\r\\n ","errorExample":""}]',
'title' => '查询授权的VPC列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVpcAccesses'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeVpcAccesses',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'],
],
],
],
],
],
'DescribeZones' => [
'summary' => '查询指定地域中可用区的列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94419',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '语言类型。系统权限策略的描述将以此语言返回。'."\n"
."\n"
.'- en:英文。'."\n"
.'- zh-CN:中文。'."\n"
.'- ja:日文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '9324B68F-9863-5722-A0FD-0798E2B02A0E'],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => '当前地域支持的可用区列表',
'example' => '{\'Zone\': [{\'ZoneId\': \'cn-hangzhou-i\'}]}',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-MAZ2(j,g)'],
'LocalName' => ['description' => '本地名称', 'type' => 'string', 'example' => 'China (Hangzhou) Multi-zone 2(j,g)'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9324B68F-9863-5722-A0FD-0798E2B02A0E\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-MAZ2(j,g)\\",\\n \\"LocalName\\": \\"China (Hangzhou) Multi-zone 2(j,g)\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询地域的可用区列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
],
'DetachApiProduct' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
[
'name' => 'Apis',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'API 列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'required' => true, 'example' => 'ba84c55eca46488598da17c0609f3ead'],
'StageName' => ['description' => '环境名称,取值为:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
'required' => false,
'description' => '',
],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB'],
],
'description' => '',
],
],
],
'title' => '解除API与API产品的绑定关系',
'summary' => '解除API与API产品的绑定关系',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachApiProduct'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DetachApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB\\"\\n}","type":"json"}]',
],
'DetachGroupPlugin' => [
'summary' => '解绑分组插件',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '171235',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => 'API网关插件ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a96926e82f994915a8da40a119374537 '],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '3707E6FA-749C-5352-B72A-ABE95D9DEA49'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '解绑分组上绑定的插件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachGroupPlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:DetachGroupPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3707E6FA-749C-5352-B72A-ABE95D9DEA49\\"\\n}","type":"json"}]',
],
'DetachPlugin' => [
'summary' => '解绑API绑定的插件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => '绑定的API网关插件ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '93b87279e54c4c0baeb7113cdf9c67f5'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '19a2846d8e8541c788c6be740035eb68'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA'],
],
'description' => '',
],
],
],
'title' => '解绑API绑定的插件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachPlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DetachPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\"\\n}","type":"json"}]',
],
'DisableInstanceAccessControl' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'关闭实例上的访问控制。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-grgqc0mnuhkqciwtam'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-cn-v6419k43xxxxx'],
],
[
'name' => 'AddressIPVersion',
'in' => 'query',
'schema' => ['description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', 'type' => 'string', 'required' => false, 'example' => 'ipv4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
],
'description' => '',
],
],
],
'title' => '关闭实例上的访问控制',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInstanceAccessControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DisableInstanceAccessControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]',
],
'DissociateInstanceWithPrivateDNS' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-ead4f4b0bac8'],
],
[
'name' => 'IntranetDomains',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '需要解绑的内网域名解析的域名列表',
'type' => 'array',
'items' => ['description' => '内网域名解析的内网域名', 'type' => 'string', 'required' => false, 'example' => 'api.demo.com'],
'required' => true,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '解除内网域名解析和专享实例的关联',
'summary' => '解除内网域名解析和专享实例的关联',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateInstanceWithPrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DissociateInstanceWithPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]',
],
'DryRunSwagger' => [
'summary' => '使用swagger导入swagger之前先预先检查swagger的语法是否规范。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '94422',
'abilityTreeNodes' => ['FEATUREapigateway9WMX21'],
],
'parameters' => [
[
'name' => 'Overwrite',
'in' => 'query',
'schema' => ['description' => '是否覆盖现有API。'."\n"
."\n"
.'覆盖检测条件为:API的HTTP请求类型+后端请求路径相同。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'GlobalCondition',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '全局条件。', 'type' => 'object', 'required' => false, 'docRequired' => true, 'example' => '{}'],
],
[
'name' => 'DataFormat',
'in' => 'query',
'schema' => ['description' => 'Swagger文本格式:'."\n"
."\n"
.'- json'."\n"
.'- yaml', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yaml'],
],
[
'name' => 'Data',
'in' => 'formData',
'schema' => ['description' => 'Swagger文本内容。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"A Swagger API definition in YAML"'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd633cf5524f841b9950e245b191bdabf'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GlobalCondition' => ['description' => '全局条件。', 'type' => 'string', 'example' => '{}'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
'Success' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiDryRunSwaggerSuccess' => [
'description' => '本次所有通过swagger导入成功的API信息',
'type' => 'array',
'items' => [
'description' => '本次所有通过swagger导入成功的api信息',
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/http/get/mapping'],
'HttpMethod' => ['description' => '创建API时配置的http方法', 'type' => 'string', 'example' => 'get'],
'ApiSwagger' => ['description' => 'API 的 Swagger 定义', 'type' => 'string', 'example' => '"A Swagger API definition in YAML"'],
'ApiOperation' => ['description' => '该API是创建(CREATE)或修改(MODIFY)', 'type' => 'string', 'example' => 'CREATE'],
'ApiUid' => ['description' => '导入成功的API的UID', 'type' => 'string', 'example' => '8e274ec61cf6468e83b68371956831cb'],
],
],
],
],
'description' => '',
],
'Failed' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportSwaggerFailed' => [
'description' => '本次所有通过swagger导入失败的API信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/http/get/mapping'],
'HttpMethod' => ['description' => '创建API时配置的http方法', 'type' => 'string', 'example' => 'post'],
'ErrorMsg' => ['description' => '创建API时返回的错误信息', 'type' => 'string', 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb'],
],
'description' => '',
],
],
],
'description' => '',
],
'ModelFailed' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportModelFailed' => [
'description' => '本次所有通过 swagger 导入失败的 Model 信息。'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Not Found'],
'ModelName' => ['description' => '模型名字', 'type' => 'string', 'example' => 'Region'],
'GroupId' => ['description' => 'API 分组 ID', 'type' => 'string', 'example' => '36d4bcfaec1946e1870d90b2d7519710'],
],
'description' => '',
],
],
],
'description' => '',
],
'ModelSuccess' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportModelSuccess' => [
'description' => '本次所有通过 swagger 导入成功的 Model 信息。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModelUid' => ['description' => '模型uid', 'type' => 'string', 'example' => 'ec1946e1870d90b2d7519'],
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'NewInstance'],
'GroupId' => ['description' => 'api分组id', 'type' => 'string', 'example' => 'b2d552ed90ca435b86f7bf8d45414793'],
'ModelOperation' => ['description' => '该模型是创建(CREATE)或修改(MODIFY)', 'type' => 'string', 'example' => 'CREATE'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '预检查swagger',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DryRunSwagger'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:DryRunSwagger',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GlobalCondition\\": \\"{}\\",\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"Success\\": {\\n \\"ApiDryRunSwaggerSuccess\\": [\\n {\\n \\"Path\\": \\"/http/get/mapping\\",\\n \\"HttpMethod\\": \\"get\\",\\n \\"ApiSwagger\\": \\"\\\\\\"A Swagger API definition in YAML\\\\\\"\\",\\n \\"ApiOperation\\": \\"CREATE\\",\\n \\"ApiUid\\": \\"8e274ec61cf6468e83b68371956831cb\\"\\n }\\n ]\\n },\\n \\"Failed\\": {\\n \\"ApiImportSwaggerFailed\\": [\\n {\\n \\"Path\\": \\"/http/get/mapping\\",\\n \\"HttpMethod\\": \\"post\\",\\n \\"ErrorMsg\\": \\"api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb\\"\\n }\\n ]\\n },\\n \\"ModelFailed\\": {\\n \\"ApiImportModelFailed\\": [\\n {\\n \\"ErrorMsg\\": \\"Not Found\\",\\n \\"ModelName\\": \\"Region\\",\\n \\"GroupId\\": \\"36d4bcfaec1946e1870d90b2d7519710\\"\\n }\\n ]\\n },\\n \\"ModelSuccess\\": {\\n \\"ApiImportModelSuccess\\": [\\n {\\n \\"ModelUid\\": \\"ec1946e1870d90b2d7519\\",\\n \\"ModelName\\": \\"NewInstance\\",\\n \\"GroupId\\": \\"b2d552ed90ca435b86f7bf8d45414793\\",\\n \\"ModelOperation\\": \\"CREATE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'EnableInstanceAccessControl' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'设置实例上的访问控制。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp11escro2et2tioscy52'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-cn-v6419k43xxxxx'],
],
[
'name' => 'AclType',
'in' => 'query',
'schema' => ['description' => '访问控制的类型:'."\n"
.'- black:黑名单 '."\n"
.'- white:白名单', 'type' => 'string', 'required' => true, 'example' => 'black'],
],
[
'name' => 'AddressIPVersion',
'in' => 'query',
'schema' => ['description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', 'type' => 'string', 'required' => false, 'example' => 'ipv4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
],
'description' => '',
],
],
],
'title' => '设置实例上的访问控制',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInstanceAccessControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:EnableInstanceAccessControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]',
],
'ExportOAS' => [
'summary' => '导出OAS。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'DataFormat',
'in' => 'query',
'schema' => ['description' => 'Swagger文本格式:'."\n"
."\n"
.'- json'."\n"
.'- yaml', 'type' => 'string', 'required' => false, 'example' => 'yaml'],
],
[
'name' => 'ApiIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要导出的API列表',
'type' => 'array',
'items' => ['description' => 'API ID', 'type' => 'string', 'required' => false, 'example' => '8afff6c8c4c6447abb035812e4d66xxx'],
'required' => false,
'docRequired' => false,
'maxItems' => 300,
'minItems' => 1,
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID', 'type' => 'string', 'required' => false, 'example' => '42925e7f5209438186d5560239af5xxx'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => 'API已发布的环境:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **PRE**:预发'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => false, 'example' => 'RELEASE'],
],
[
'name' => 'OasVersion',
'in' => 'query',
'schema' => ['description' => 'OAS版本号:'."\n"
.'- **oas2**'."\n"
.'- **oas3**', 'type' => 'string', 'required' => false, 'example' => 'oas2'],
],
[
'name' => 'WithXExtensions',
'in' => 'query',
'schema' => ['description' => '是否导出API网关拓展定义', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '导出分组下所有API时的分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'Swagger文件经base64编码后的数据,通过base64解码可以得到文件', 'type' => 'string', 'example' => 'UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx'],
],
'description' => '',
],
],
],
'title' => '导出OAS定义',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportOAS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ExportOAS',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx\\"\\n}","type":"json"}]',
],
'ImportOAS' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077'],
],
[
'name' => 'Data',
'in' => 'formData',
'schema' => ['description' => 'OAS文本内容,或OSS链接', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'swagger: "2.0"'."\n"
.'info:'."\n"
.' version: "1.0.0"'."\n"
.' title: "Swagger Petstore 2.0"'."\n"
.'basePath: "/"'."\n"
.'schemes:'."\n"
.'- "https"'."\n"
.'- "http"'."\n"
.'paths:'."\n"
.' /pet/findByStatus:'."\n"
.' get:'."\n"
.' tags:'."\n"
.' - "pet"'."\n"
.' summary: "Finds Pets by status"'."\n"
.' operationId: "findPetsByStatus"'."\n"
.' parameters:'."\n"
.' - name: "status"'."\n"
.' in: "query"'."\n"
.' required: true'."\n"
.' type: "array"'."\n"
.' items:'."\n"
.' type: "string"'."\n"
.' enum:'."\n"
.' - "available"'."\n"
.' - "pending"'."\n"
.' - "sold"'."\n"
.' default: "available"'."\n"
.' collectionFormat: "multi"'."\n"
.' responses:'."\n"
.' "200":'."\n"
.' description: "successful operation"'."\n"
.' schema:'."\n"
.' type: "array"'."\n"
.' items:'."\n"
.' $ref: "#/definitions/Pet"'."\n"
.' "400":'."\n"
.' description: "Invalid status value"'."\n"
.'definitions:'."\n"
.' Category:'."\n"
.' type: "object"'."\n"
.' properties:'."\n"
.' id:'."\n"
.' type: "integer"'."\n"
.' format: "int64"'."\n"
.' name:'."\n"
.' type: "string"'."\n"
.' Tag:'."\n"
.' type: "object"'."\n"
.' properties:'."\n"
.' id:'."\n"
.' type: "integer"'."\n"
.' format: "int64"'."\n"
.' name:'."\n"
.' type: "string"'."\n"
.' Pet:'."\n"
.' type: "object"'."\n"
.' required:'."\n"
.' - "name"'."\n"
.' - "photoUrls"'."\n"
.' properties:'."\n"
.' id:'."\n"
.' type: "integer"'."\n"
.' format: "int64"'."\n"
.' category:'."\n"
.' $ref: "#/definitions/Category"'."\n"
.' name:'."\n"
.' type: "string"'."\n"
.' example: "doggie"'."\n"
.' photoUrls:'."\n"
.' type: "array"'."\n"
.' items:'."\n"
.' type: "string"'."\n"
.' tags:'."\n"
.' type: "array"'."\n"
.' items:'."\n"
.' $ref: "#/definitions/Tag"'."\n"
.' status:'."\n"
.' type: "string"'."\n"
.' description: "pet status in the store"'."\n"
.' enum:'."\n"
.' - "available"'."\n"
.' - "pending"'."\n"
.' - "sold"'],
],
[
'name' => 'Overwrite',
'in' => 'query',
'schema' => ['description' => '是否覆盖现有API。'."\n"
."\n"
.'覆盖检测条件为:API的HTTP请求类型+后端请求路径相同。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'IgnoreWarning',
'in' => 'query',
'schema' => ['description' => '忽略警告信息', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'SkipDryRun',
'in' => 'query',
'schema' => ['description' => '跳过预检查,进行导入', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'OASVersion',
'in' => 'query',
'schema' => ['description' => 'OAS版本信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'OAS2'],
],
[
'name' => 'BackendName',
'in' => 'query',
'schema' => ['description' => '后端服务名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testBackendService'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'APP'],
],
[
'name' => 'RequestMode',
'in' => 'query',
'schema' => ['description' => '入参请求的模式,取值为:'."\n"
."\n"
.'- MAPPING:入参映射(过滤未知参数)'."\n"
."\n"
.'- PASSTHROUGH:入参透传', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PASSTHROUGH'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperationId' => ['description' => '进行导入操作时生成的异步任务ID,用来查询导入任务的执行情况', 'type' => 'string', 'example' => 'c16a1880f5164d779f6a54f64d997cd9'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06'],
'ErrorMessages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ErrorMessage' => [
'description' => 'OAS定义中不支持的错误内容',
'type' => 'array',
'items' => ['description' => 'OAS定义中不支持的错误内容', 'type' => 'string', 'example' => 'Invalid extensions:x-aliyun-apigateway-auth-type. Option value [ANONYMOUS, APP].'],
],
],
'description' => '',
],
'WarningMessages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'WarningMessage' => [
'description' => 'OAS定义中不支持的警告信息,可以忽略',
'type' => 'array',
'items' => ['description' => 'OAS定义中不支持的警告信息,可以忽略', 'type' => 'string', 'example' => 'There is no valid api definition in your file.'],
],
],
'description' => '',
],
'SuccessApis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessApi' => [
'description' => '预检成功的API信息',
'type' => 'array',
'items' => [
'description' => '预检成功的API信息',
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/st1'],
'HttpMethod' => ['description' => '创建API时配置的HTTP方法', 'type' => 'string', 'example' => 'POST'],
'ApiId' => ['description' => 'API的ID。'."\n", 'type' => 'string', 'example' => '92af1abffc2443eaa2b815fdbd9c13f1'],
'ApiOperation' => ['description' => '该API是创建(CREATE)或修改(MODIFY)', 'type' => 'string', 'example' => 'CREATE'],
],
],
],
],
'description' => '',
],
'FailedApis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailedApi' => [
'description' => '预检失败的API信息',
'type' => 'array',
'items' => [
'description' => '预检失败的API信息',
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/st1'],
'HttpMethod' => ['description' => '创建API时配置的HTTP方法', 'type' => 'string', 'example' => 'POST'],
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Invalid Api Definition.'],
],
],
],
],
'description' => '',
],
'FailedModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailedModel' => [
'description' => '预检失败的模型信息',
'type' => 'array',
'items' => [
'description' => '预检失败的模型信息',
'type' => 'object',
'properties' => [
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Invalid Model Definition.'],
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'test'],
'GroupId' => ['description' => 'API 分组 ID', 'type' => 'string', 'example' => '2c1bc62e19614cc68c6b0b484bc9c5db'],
],
],
],
],
'description' => '',
],
'SuccessModels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessModel' => [
'description' => '预检成功的模型信息',
'type' => 'array',
'items' => [
'description' => '预检成功的模型信息',
'type' => 'object',
'properties' => [
'ModelUid' => ['description' => '模型uid', 'type' => 'string', 'example' => '1r4efwee19614cc68c6b0b484bc9c5dbs'],
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'test'],
'GroupId' => ['description' => 'API 分组 ID', 'type' => 'string', 'example' => 'feaccf67040643bcbdedb253e59eb527'],
'ModelOperation' => ['description' => '模型操作,创建(CREATE)或修改(MODIFY)', 'type' => 'string', 'example' => 'CREATE'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '通过OAS导入API',
'summary' => '使用标准OAS定义导入API。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportOAS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:ImportOAS',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"c16a1880f5164d779f6a54f64d997cd9\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\",\\n \\"ErrorMessages\\": {\\n \\"ErrorMessage\\": [\\n \\"Invalid extensions:x-aliyun-apigateway-auth-type. Option value [ANONYMOUS, APP].\\"\\n ]\\n },\\n \\"WarningMessages\\": {\\n \\"WarningMessage\\": [\\n \\"There is no valid api definition in your file.\\"\\n ]\\n },\\n \\"SuccessApis\\": {\\n \\"SuccessApi\\": [\\n {\\n \\"Path\\": \\"/st1\\",\\n \\"HttpMethod\\": \\"POST\\",\\n \\"ApiId\\": \\"92af1abffc2443eaa2b815fdbd9c13f1\\",\\n \\"ApiOperation\\": \\"CREATE\\"\\n }\\n ]\\n },\\n \\"FailedApis\\": {\\n \\"FailedApi\\": [\\n {\\n \\"Path\\": \\"/st1\\",\\n \\"HttpMethod\\": \\"POST\\",\\n \\"ErrorMsg\\": \\"Invalid Api Definition.\\"\\n }\\n ]\\n },\\n \\"FailedModels\\": {\\n \\"FailedModel\\": [\\n {\\n \\"ErrorMsg\\": \\"Invalid Model Definition.\\",\\n \\"ModelName\\": \\"test\\",\\n \\"GroupId\\": \\"2c1bc62e19614cc68c6b0b484bc9c5db\\"\\n }\\n ]\\n },\\n \\"SuccessModels\\": {\\n \\"SuccessModel\\": [\\n {\\n \\"ModelUid\\": \\"1r4efwee19614cc68c6b0b484bc9c5dbs\\",\\n \\"ModelName\\": \\"test\\",\\n \\"GroupId\\": \\"feaccf67040643bcbdedb253e59eb527\\",\\n \\"ModelOperation\\": \\"CREATE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ImportSwagger' => [
'summary' => '通过导入符合阿里云 Swagger 规范的文本内容创建 API。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Overwrite',
'in' => 'query',
'schema' => ['description' => '是否覆盖现有API。'."\n"
."\n"
.'覆盖检测条件为:API的HTTP请求类型+后端请求路径相同。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'GlobalCondition',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '全局条件。', 'type' => 'object', 'required' => false, 'docRequired' => false, 'example' => '{}'],
],
[
'name' => 'DataFormat',
'in' => 'query',
'schema' => ['description' => 'Swagger文本格式:'."\n"
."\n"
.'- json'."\n"
.'- yaml', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yaml'],
],
[
'name' => 'Data',
'in' => 'formData',
'schema' => ['description' => 'Swagger文本内容。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"A Swagger API definition in YAML"'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'Swagger将被导入的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0009db9c828549768a200320714b****'],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => '预检验', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求ID', 'type' => 'string', 'example' => '647CEF05-404C-4125-B3D7-44792EB77392'],
'Success' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportSwaggerSuccess' => [
'description' => '本次所有通过swagger导入成功的API信息',
'type' => 'array',
'items' => [
'description' => '本次所有通过swagger导入成功的API信息',
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/http/get/mapping'],
'HttpMethod' => ['description' => '创建API时配置的http方法', 'type' => 'string', 'example' => 'get'],
'ApiOperation' => ['description' => '该API是创建(CREATE)或修改(MODIFY)', 'type' => 'string', 'example' => 'CREATE'],
'ApiUid' => ['description' => '导入成功的API的UID', 'type' => 'string', 'example' => '8e274ec61cf6468e83b683719568****'],
],
],
],
],
'description' => '',
],
'Failed' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportSwaggerFailed' => [
'description' => '本次所有通过swagger导入失败的API信息',
'type' => 'array',
'items' => [
'description' => '本次所有通过swagger导入失败的API信息',
'type' => 'object',
'properties' => [
'Path' => ['description' => '创建API时配置的请求路径', 'type' => 'string', 'example' => '/http/get/mapping'],
'HttpMethod' => ['description' => '创建API时配置的http方法', 'type' => 'string', 'example' => 'post'],
'ErrorMsg' => ['description' => '创建API时返回的错误信息', 'type' => 'string', 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****'],
],
],
],
],
'description' => '',
],
'ModelFailed' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportModelFailed' => [
'description' => '本次所有通过 swagger 导入失败的 Model 信息。'."\n",
'type' => 'array',
'items' => [
'description' => '本次所有通过 swagger 导入失败的 Model 信息。'."\n",
'type' => 'object',
'properties' => [
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'error msg'],
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'Region'],
'GroupId' => ['description' => 'API 分组 ID', 'type' => 'string', 'example' => '36d4bcfaec1946e1870d90b2d751****'],
],
],
],
],
'description' => '',
],
'ModelSuccess' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApiImportModelSuccess' => [
'description' => '本次所有通过 swagger 导入成功的 Model 信息。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '本次所有通过 swagger 导入成功的 Model 信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'ModelUid' => ['description' => '模型uid', 'type' => 'string', 'example' => 'd4bcfaec1946e1870d'],
'ModelName' => ['description' => '模型名称', 'type' => 'string', 'example' => 'NewInstance'],
'GroupId' => ['description' => 'api分组id', 'type' => 'string', 'example' => 'b2d552ed90ca435b86f7bf8d4541****'],
'ModelOperation' => ['description' => '模型操作', 'type' => 'string', 'example' => 'CREATE'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '通过 Swagger 创建 API',
'description' => '- 阿里云目前支持基于Swagger 2.0的扩展'."\n"
.'- 只支持json/yaml格式的Swagger配置文件',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportSwagger'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:ImportSwagger',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"647CEF05-404C-4125-B3D7-44792EB77392\\",\\n \\"Success\\": {\\n \\"ApiImportSwaggerSuccess\\": [\\n {\\n \\"Path\\": \\"/http/get/mapping\\",\\n \\"HttpMethod\\": \\"get\\",\\n \\"ApiOperation\\": \\"CREATE\\",\\n \\"ApiUid\\": \\"8e274ec61cf6468e83b683719568****\\"\\n }\\n ]\\n },\\n \\"Failed\\": {\\n \\"ApiImportSwaggerFailed\\": [\\n {\\n \\"Path\\": \\"/http/get/mapping\\",\\n \\"HttpMethod\\": \\"post\\",\\n \\"ErrorMsg\\": \\"api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****\\"\\n }\\n ]\\n },\\n \\"ModelFailed\\": {\\n \\"ApiImportModelFailed\\": [\\n {\\n \\"ErrorMsg\\": \\"error msg\\",\\n \\"ModelName\\": \\"Region\\",\\n \\"GroupId\\": \\"36d4bcfaec1946e1870d90b2d751****\\"\\n }\\n ]\\n },\\n \\"ModelSuccess\\": {\\n \\"ApiImportModelSuccess\\": [\\n {\\n \\"ModelUid\\": \\"d4bcfaec1946e1870d\\",\\n \\"ModelName\\": \\"NewInstance\\",\\n \\"GroupId\\": \\"b2d552ed90ca435b86f7bf8d4541****\\",\\n \\"ModelOperation\\": \\"CREATE\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 647CEF05-404C-4125-B3D7-44792EB77392\\r\\n \\r\\n \\r\\n api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb\\r\\n post\\r\\n /http/get/mapping\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n CREATE\\r\\n 8e274ec61cf6468e83b68371956831cb\\r\\n get\\r\\n /http/get/mapping\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'ListPrivateDNS' => [
'summary' => '查询内网域名解析,支持根据内网域名或解析类型查询。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '215588',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'IntranetDomain',
'in' => 'query',
'schema' => ['description' => '内网域名', 'type' => 'string', 'required' => false, 'example' => 'api.demo.com'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '内网域名解析的类型'."\n"
.'- VPC:针对VPC授权解析,仅支持绑定传统类型专享实例;'."\n"
.'- A:支持创建A记录,仅支持绑定VPC融合类型专享实例',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'],
'example' => 'A',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'description' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
'TotalCount' => ['description' => '返回结果的总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'PageNumber' => ['description' => '返回指定的页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '返回指定的每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PrivateDNSList' => [
'description' => '内网域名解析列表',
'type' => 'array',
'items' => [
'description' => '内网域名解析',
'type' => 'object',
'properties' => [
'IntranetDomain' => ['description' => '内网域名', 'type' => 'string', 'example' => 'api.demo.com'],
'Type' => [
'description' => '内网域名解析的类型'."\n"
.'- VPC:针对VPC授权解析,仅支持绑定传统类型专享实例;'."\n"
.'- A:支持创建A记录,仅支持绑定VPC融合类型专享实例',
'type' => 'string',
'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'],
'example' => 'A',
],
'CreatedTime' => ['description' => '创建时间,格林威治时间', 'type' => 'string', 'example' => '2023-05-10T08:17:00Z'],
'Records' => [
'description' => '解析记录列表',
'type' => 'array',
'items' => [
'description' => '解析记录列表',
'type' => 'object',
'properties' => [
'Record' => ['description' => '解析记录值', 'type' => 'string', 'example' => '192.168.0.1'],
'Weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
'BindInstances' => [
'description' => '内网域名解析所关联的专享实例列表',
'type' => 'array',
'items' => ['description' => '专享实例ID', 'type' => 'string', 'example' => 'apigateway-hz-ead4f4b0bac8'],
],
],
],
],
],
],
],
],
'title' => '查询内网域名解析',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:ListPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\",\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PrivateDNSList\\": [\\n {\\n \\"IntranetDomain\\": \\"api.demo.com\\",\\n \\"Type\\": \\"A\\",\\n \\"CreatedTime\\": \\"2023-05-10T08:17:00Z\\",\\n \\"Records\\": [\\n {\\n \\"Record\\": \\"192.168.0.1\\",\\n \\"Weight\\": 100\\n }\\n ],\\n \\"BindInstances\\": [\\n \\"apigateway-hz-ead4f4b0bac8\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListTagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94429',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型定义。'."\n"
."\n"
.'目前分组,插件,应用接入了标签,API相关操作基于分组的标签:'."\n"
.'- **apiGroup**'."\n"
.'- **plugin**'."\n"
.'- **app**'."\n"
.'- **api**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1d2db86sca4384811e0b5e8707e68181f'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:`[1, 50]`',
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'example' => '285bb759342649a1b70c2093a772e087',
'maxItems' => 10000,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'N的取值范围为:`[1, 20]`', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '标签值。当参数有值,要求对应的**tag.N.Key**在相同的N的标签键也传入值,否则会报错。'."\n"
."\n"
.'N的取值范围为:`[1, 20]`', 'type' => 'string', 'required' => false, 'example' => 'product'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 10000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token。'."\n"
."\n"
.'NextToken为**-1**表示没有下一个。', 'type' => 'string', 'example' => '1d2db86sca4384811e0b5e8707e68181f'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043'],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'description' => '资源列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => ['description' => '标签值', 'type' => 'string', 'example' => 'zhangsan'],
'ResourceType' => ['description' => '资源类型', 'type' => 'string', 'example' => 'apiGroup'],
'ResourceId' => ['description' => '资源ID', 'type' => 'string', 'example' => '285bb759342649a1b70c2093a772e087'],
'TagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'owner'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '用户查询标签接口',
'summary' => '查询可见的资源标签关系。',
'description' => '- 对于Tag.N.Key及Tag.N.Value中相同的N是一对键值对。'."\n"
.'- ResourceId.N需满足所有输入的键值对。当输入多个键值对,查询结果为资源中包含指定多个键值对的资源。'."\n"
.'- 查询返回符合条件的标签资源关系,当过滤后没有匹配的资源标签关系则返回空列表。'."\n"
.'- 用户同时查询用户标签跟可见系统标签。'."\n"
.'- 除必填参数传入外,传入ResourceId.N,查询某个region的指定资源的可见资源标签关系。'."\n"
.'- 除必填参数传入外,传入Tag.N.Key,查询某个region的指定Key下的可见资源标签关系。'."\n"
.'- ResourceId.N 及 (Tag.N.Key,Tag.N.Value) 至少存在一个。'."\n"
.'- 单次操作,标签可以为相同类型的,也可以不同类型。'."\n"
.'- 用户对于用户标签全部的查询权限,用户有查询可见系统标签的权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"1d2db86sca4384811e0b5e8707e68181f\\",\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"zhangsan\\",\\n \\"ResourceType\\": \\"apiGroup\\",\\n \\"ResourceId\\": \\"285bb759342649a1b70c2093a772e087\\",\\n \\"TagKey\\": \\"owner\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 2D69A58F-345C-4FDE-88E4-BF5189484043\\r\\n 1d2db86sca4384811e0b5e8707e68181f\\r\\n \\r\\n \\r\\n 285bb759342649a1b70c2093a772e087\\r\\n apiGroup\\r\\n env\\r\\n product\\r\\n \\r\\n \\r\\n 285bb759342649a1b70c2093a772e087\\r\\n apiGroup\\r\\n owner\\r\\n zhangsan\\r\\n \\r\\n \\r\\n","errorExample":""}]',
],
'ModifyApi' => [
'summary' => '修改API的定义信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8afff6c8c4c6447abb035812e4d66b65'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API的名称,组内不允许重复。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,4~50个字符', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ApiName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'API描述信息,最多180个字符', 'type' => 'string', 'required' => false, 'example' => 'Api description'],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => ['description' => 'API是否公开,目前可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境,会在所有用户的控制台“发现API”页面展示'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PUBLIC'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。'."\n"
.' - “ANONYMOUS”API**不建议上架云市场**,网关无法对调用者区分计量,也无法限制调用次数,若所在分组要上架云市场,建议将该API转移至其他分组,或将类型设置为“私有”,或选择“阿里云APP”认证方式。', 'type' => 'string', 'required' => false, 'example' => 'APP'],
],
[
'name' => 'RequestConfig',
'in' => 'query',
'schema' => ['description' => 'Consumer向网关发送API请求的相关配置项', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}'],
],
[
'name' => 'ServiceConfig',
'in' => 'query',
'schema' => ['description' => '网关向后端服务发送API请求的相关配置项', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}'],
],
[
'name' => 'RequestParameters',
'in' => 'formData',
'schema' => ['description' => 'Consumer向网关发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[RequestParameter](~~43986~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 2'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "OPTIONAL",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "header1",'."\n"
.' "DefaultValue": "123124",'."\n"
.' "Location": "Head"'."\n"
.' },'."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 2'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "header2",'."\n"
.' "DefaultValue": "",'."\n"
.' "Location": "Head"'."\n"
.' },'."\n"
.' {'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Query",'."\n"
.' "orderNumber": 3'."\n"
.' },'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "OPTIONAL",'."\n"
.' "isHide": false,'."\n"
.' "ApiParameterName": "query1",'."\n"
.' "DefaultValue": "1245",'."\n"
.' "Location": "Query"'."\n"
.' },'."\n"
.' {'."\n"
.' "ApiParameterName": "CaClientIp",'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Query",'."\n"
.' "orderNumber": 0'."\n"
.' },'."\n"
.' "Location": "Query",'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "Description": "ClientIP"'."\n"
.' },'."\n"
.' {'."\n"
.' "ApiParameterName": "testConstant",'."\n"
.' "ParameterLocation": {'."\n"
.' "name": "Head",'."\n"
.' "orderNumber": 0'."\n"
.' },'."\n"
.' "Location": "Head",'."\n"
.' "ParameterType": "String",'."\n"
.' "Required": "REQUIRED",'."\n"
.' "DefaultValue": "111"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'SystemParameters',
'in' => 'formData',
'schema' => ['description' => '网关发送给后端服务的系统参数', 'type' => 'string', 'required' => false, 'example' => '[{\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaDomain\\",\\"serviceParameterName\\":\\"host\\"}]'],
],
[
'name' => 'ConstantParameters',
'in' => 'formData',
'schema' => ['description' => '网关发送给后端服务的常量参数', 'type' => 'string', 'required' => false, 'example' => '[{\\"ConstantValue\\":\\"123\\",\\"Description\\":\\"Constant parameter\\",\\"Location\\":\\"HEAD\\",\\"ServiceParameterName\\":\\"test\\"}]'],
],
[
'name' => 'ServiceParameters',
'in' => 'formData',
'schema' => ['description' => '网关向后端服务发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[ServiceParameter](~~43988~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ServiceParameterName": "header1",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "header2",'."\n"
.' "Location": "Query",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "query1",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "REQUEST"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "ipp",'."\n"
.' "Location": "Query",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "SYSTEM"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "testConstant",'."\n"
.' "Location": "Head",'."\n"
.' "Type": "String",'."\n"
.' "ParameterCatalog": "CONSTANT"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'ServiceParametersMap',
'in' => 'formData',
'schema' => ['description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。'."\n"
."\n"
.'更多信息,请参见[ServiceParameterMap](~~43989~~)。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' {'."\n"
.' "ServiceParameterName": "header1",'."\n"
.' "RequestParameterName": "header1"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "header2",'."\n"
.' "RequestParameterName": "header2"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "query1",'."\n"
.' "RequestParameterName": "query1"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "ipp",'."\n"
.' "RequestParameterName": "CaClientIp"'."\n"
.' },'."\n"
.' {'."\n"
.' "ServiceParameterName": "testConstant",'."\n"
.' "RequestParameterName": "testConstant"'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'ResultType',
'in' => 'query',
'schema' => ['description' => '后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTML'],
],
[
'name' => 'ResultSample',
'in' => 'formData',
'schema' => ['description' => '后端服务返回应答的示例 该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{}'],
],
[
'name' => 'FailResultSample',
'in' => 'formData',
'schema' => ['description' => '后端服务失败返回应答的示例。'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'example' => '{\\"requestId\\":\\"3b9b8b31-93c3-489e-8ebb-cab35a1aee51\\",\\"errCode\\":500,\\"errMsg\\":\\"connection refused\\"}'],
],
[
'name' => 'ErrorCodeSamples',
'in' => 'formData',
'schema' => ['description' => '后端服务返回的错误码示例。'."\n"
."\n"
.'更多信息,请参见[ErrorCodeSample](~~44392~~)。', 'type' => 'string', 'required' => false, 'example' => '[{\\"Code\\":\\"400\\",\\"Message\\":\\"Login failed\\",\\"Description\\":\\"Invalid user name or password\\"}]'],
],
[
'name' => 'ResultDescriptions',
'in' => 'formData',
'schema' => ['description' => 'API的返回说明', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'OpenIdConnectConfig',
'in' => 'query',
'schema' => ['description' => '第三方账号认证OpenID Connect相关配置项', 'type' => 'string', 'required' => false, 'example' => '{\\"OpenIdApiType\\":\\"IDTOKEN\\",\\"PublicKey\\":\\"lzlj1573\\",\\"IdTokenParamName\\":\\"\\",\\"PublicKeyId\\":\\"lzljorders\\"}'],
],
[
'name' => 'AllowSignatureMethod',
'in' => 'query',
'schema' => ['description' => 'API的客户端请求签名方法,可选值:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256'],
],
[
'name' => 'WebSocketApiType',
'in' => 'query',
'schema' => ['description' => '双向通信API类型:'."\n"
."\n"
.'- **COMMON**:普通API'."\n"
.'- **REGISTER**:注册API'."\n"
.'- **UNREGISTER**:注销API'."\n"
.'- **NOTIFY**:下行通知'."\n", 'type' => 'string', 'required' => false, 'example' => 'COMMON'],
],
[
'name' => 'ResultBodyModel',
'in' => 'query',
'schema' => ['description' => 'api的返回结果', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'ForceNonceCheck',
'in' => 'query',
'schema' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
.'- 设置**ForceNonceCheck**为**false**, 则不检查。修改时,不设置则不修改原来的取值。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DisableInternet',
'in' => 'query',
'schema' => ['description' => '- 设置DisableInternet为**true**,仅支持内网调用API。'."\n"
.'- 设置DisableInternet为**false**,则不限制调用。'."\n"
."\n"
.'> 修改API时,不设置则不修改原来的取值。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AppCodeAuthType',
'in' => 'query',
'schema' => ['description' => '支持AppCode的认证类型。可选值:'."\n"
."\n"
.'- DEFAULT:默认值:上架云市场后支持'."\n"
.'- DISABLE: 不支持AppCode调用方式'."\n"
.'- HEADER :仅在Header中支持'."\n"
.'- HEADER_QUERY :可以在Header或者Query中支持', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'],
],
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => false, 'example' => '0d105f80a8f340408bd34954d4e4ff22'],
],
[
'name' => 'BackendEnable',
'in' => 'query',
'schema' => ['description' => '是否启用后端服务', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\r\\n","errorExample":""}]',
'title' => '修改API定义',
'description' => '**"** 此接口面向开放API的用户'."\n"
.'- 该接口需要全量更新,不支持部分参数更新'."\n"
.'- 修改ApiName时需要注意,同一个分组内API不允许重名'."\n"
.'- 修改RequestPath时需要注意,同一个分组内Path不允许重复'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'ModifyApiConfiguration' => [
'summary' => '本API用于修改API的草稿定义信息,区别于接口ModifyApi,不需要填充所有的API信息才能操作,只需指定要修改的参数进行修改。例如,当需要修改API的认证方式从匿名变为APP认证,只需要传入AuthType的值APP即可。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API的ID标识', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38'],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'API名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testModifyApiName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'api描述', 'type' => 'string', 'required' => false, 'example' => 'Test modify description'],
],
[
'name' => 'Visibility',
'in' => 'query',
'schema' => ['description' => 'API是否公开,可以取值:'."\n"
."\n"
.'- **PUBLIC**:公开,如选择此类型,该API的线上环境定义,会在所有用户的控制台“发现API”页面可见。'."\n"
.'- **PRIVATE**:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PUBLIC'],
],
[
'name' => 'ForceNonceCheck',
'in' => 'query',
'schema' => ['description' => '- 设置**ForceNonceCheck**为**true**, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。'."\n"
.'- 设置**ForceNonceCheck**为**false**, 则不检查。修改时,不设置则不修改原来的取值。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DisableInternet',
'in' => 'query',
'schema' => ['description' => '- 设置**DisableInternet**为**true**, 仅支持内网调用API。'."\n"
.'- 设置**DisableInternet**为**false**, 则不限制调用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AppCodeAuthType',
'in' => 'query',
'schema' => ['description' => '当**AuthType**为**APP**认证时,可选值如下:'."\n"
."\n"
.'- **DEFAULT**:不传默认是DEFAULT(随分组设置)'."\n"
.'- **DISABLE**:不允许'."\n"
.'- **HEADER**:允许AppCode的Header认证'."\n"
.'- **HEADER_QUERY**:允许AppCode的Header及Query认证', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'],
],
[
'name' => 'AllowSignatureMethod',
'in' => 'query',
'schema' => ['description' => '当**AuthType**为**APP**认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:'."\n"
."\n"
.'- HmacSHA256'."\n"
.'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => 'API安全认证类型,目前可以取值:'."\n"
."\n"
.'- **APP**:只允许已授权的APP调用'."\n"
.'- **ANONYMOUS**:允许匿名调用,设置为允许匿名调用需要注意:'."\n"
.' - 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制;'."\n"
.' - AppCodeAuthType的值不会生效。', 'type' => 'string', 'required' => false, 'example' => 'APP'],
],
[
'name' => 'RequestProtocol',
'in' => 'query',
'schema' => ['description' => 'API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS。', 'type' => 'string', 'required' => false, 'example' => 'HTTP'],
],
[
'name' => 'RequestHttpMethod',
'in' => 'query',
'schema' => ['description' => 'HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。', 'type' => 'string', 'required' => false, 'example' => 'GET'],
],
[
'name' => 'RequestPath',
'in' => 'query',
'schema' => ['description' => 'API path,比如API的完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`,path是指`/object/add`这一部分。', 'type' => 'string', 'required' => false, 'example' => '/test/api'],
],
[
'name' => 'RequestMode',
'in' => 'query',
'schema' => ['description' => '入参请求的模式,取值为:'."\n"
."\n"
.'- MAPPING:入参映射(过滤未知参数)'."\n"
."\n"
.'- PASSTHROUGH:入参透传'."\n"
."\n"
.'- MAPPING_PASSTHROUGH:入参映射(透传未知参数)', 'type' => 'string', 'required' => false, 'example' => 'MAPPING'],
],
[
'name' => 'BodyFormat',
'in' => 'query',
'schema' => ['description' => '当**RequestMode**值为**MAPPING**时有效。'."\n"
."\n"
.'POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:**FORM**、**STREAM**,分别表示表单形式(k-v对应)、字节流形式。', 'type' => 'string', 'required' => false, 'example' => 'STREAM'],
],
[
'name' => 'PostBodyDescription',
'in' => 'query',
'schema' => ['description' => '请求body描述', 'type' => 'string', 'required' => false, 'example' => 'Body description'],
],
[
'name' => 'BodyModel',
'in' => 'query',
'schema' => ['description' => 'body模型', 'type' => 'string', 'required' => false, 'example' => 'https://apigateway.aliyun.com/models/f4e7333c****40dcbaf7c9da553ccd8d/3ab61f775b****d4bc35e993****87aa8'],
],
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['description' => '模型的名称', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
'name' => 'BackendName',
'in' => 'query',
'schema' => ['description' => '后端服务名称'."\n"
.'UseBackendService置为TRUE时才会生效', 'type' => 'string', 'required' => false, 'example' => 'testBackendService'],
],
[
'name' => 'ServiceProtocol',
'in' => 'query',
'schema' => ['description' => '后端服务协议类型,目前支持:'."\n"
.'- Http: http/https后端'."\n"
.'- Vpc: Vpc后端'."\n"
.'- FC: 函数计算后端'."\n"
.'- OSS: 对象存储后端'."\n"
.'- Mock: mock后端'."\n"
.'- EventBridge: 事件总线后端'."\n"
."\n"
.'需要指明对应后端服务的配置信息,即为对应的后端服务的config参数赋值。', 'type' => 'string', 'required' => false, 'example' => 'HTTP'],
],
[
'name' => 'HttpConfig',
'in' => 'query',
'schema' => ['description' => 'http配置信息', 'type' => 'string', 'required' => false, 'example' => '{"serviceAddress":"http://test.api.com","servicePath":"/test/api","serviceHttpMethod":"GET"}'],
],
[
'name' => 'VpcConfig',
'in' => 'query',
'schema' => ['description' => 'vpc配置', 'type' => 'string', 'required' => false, 'example' => '{"VpcId":"vpc-xxxxxxx","Name":"testVpc","InstanceId":"i-p0ssssss","Port":80,"servicePath":"/test/vpc","serviceHttpMethod":"HEAD"}'],
],
[
'name' => 'FunctionComputeConfig',
'in' => 'query',
'schema' => ['description' => '函数计算配置信息', 'type' => 'string', 'required' => false, 'example' => '{"FcType":"FCEvent","FcRegionId":"cn-hangzhou","RoleArn":"acs:ram::xxxxxxxx:role/aliyunserviceroleforapigateway","selectServiceName":"fcTest","FunctionName":"funcTest","selectFunctionName":"funcTest","Qualifier":"LATEST","Path":"","FcBaseUrl":"","ServiceName":"fcTest"}'],
],
[
'name' => 'OssConfig',
'in' => 'query',
'schema' => ['description' => 'OSS配置信息', 'type' => 'string', 'required' => false, 'example' => '{"OssRegionId":"cn-hangzhou","Key":"/test.html","BucketName":"test-api-oss","Action":"GetObject"}'],
],
[
'name' => 'MockConfig',
'in' => 'query',
'schema' => ['description' => 'Mock配置信息', 'type' => 'string', 'required' => false, 'example' => '{"MockResult":"test","MockHeaders":[{"HeaderName":"testHeader","HeaderValue":"testHeader"}],"MockStatusCode":"400"}'],
],
[
'name' => 'ServiceTimeout',
'in' => 'query',
'schema' => ['description' => '后端服务超时时间,单位:毫秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'ContentTypeCategory',
'in' => 'query',
'schema' => ['description' => '后端请求ContentType配置'."\n"
.'- DEFAULT:API网关默认'."\n"
.'- CUSTOM:自定义', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT'],
],
[
'name' => 'ContentTypeValue',
'in' => 'query',
'schema' => ['description' => '调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。', 'type' => 'string', 'required' => false, 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'],
],
[
'name' => 'RequestParameters',
'in' => 'query',
'schema' => ['description' => 'Consumer向网关发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[RequestParameter](~~43986~~)。', 'type' => 'string', 'required' => false, 'example' => '[{"ParameterLocation":{"name":"Head","orderNumber":2},"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"header1","DefaultValue":"123124","Location":"Head"},{"ParameterLocation":{"name":"Head","orderNumber":2},"ParameterType":"String","Required":"REQUIRED","isHide":false,"ApiParameterName":"header2","DefaultValue":"","Location":"Head"},{"ParameterLocation":{"name":"Query","orderNumber":3},"ParameterType":"String","Required":"OPTIONAL","isHide":false,"ApiParameterName":"query1","DefaultValue":"1245","Location":"Query"},{"ApiParameterName":"CaClientIp","ParameterLocation":{"name":"Query","orderNumber":0},"Location":"Query","ParameterType":"String","Required":"REQUIRED","Description":"ClientIP"},{"ApiParameterName":"testConstant","ParameterLocation":{"name":"Head","orderNumber":0},"Location":"Head","ParameterType":"String","Required":"REQUIRED","DefaultValue":"111"}]'],
],
[
'name' => 'ServiceParameters',
'in' => 'query',
'schema' => ['description' => '网关向后端服务发送API请求的参数描述。'."\n"
."\n"
.'更多信息,请参见[ServiceParameter](~~43988~~)。', 'type' => 'string', 'required' => false, 'example' => '[{"ServiceParameterName":"header1","Location":"Head","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"header2","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"query1","Location":"Head","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"ipp","Location":"Query","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"testConstant","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]'],
],
[
'name' => 'ServiceParametersMap',
'in' => 'query',
'schema' => ['description' => 'Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系。'."\n"
."\n"
.'更多信息,请参见[ServiceParameterMap](~~43989~~)。', 'type' => 'string', 'required' => false, 'example' => '[{"ServiceParameterName":"header1","RequestParameterName":"header1"},{"ServiceParameterName":"header2","RequestParameterName":"header2"},{"ServiceParameterName":"query1","RequestParameterName":"query1"},{"ServiceParameterName":"ipp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"testConstant","RequestParameterName":"testConstant"}]'],
],
[
'name' => 'ResultType',
'in' => 'query',
'schema' => ['description' => '后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'JSON'],
],
[
'name' => 'ResultSample',
'in' => 'query',
'schema' => ['description' => '后端服务返回应答的示例'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}'],
],
[
'name' => 'FailResultSample',
'in' => 'query',
'schema' => ['description' => '后端服务失败返回应答的示例'."\n"
.'该值仅用于生成文档使用。不对返回结果产生影响。', 'type' => 'string', 'required' => false, 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}'],
],
[
'name' => 'ErrorCodeSamples',
'in' => 'query',
'schema' => ['description' => '后端服务返回的错误码示例。'."\n"
."\n"
.'更多信息,请参见[ErrorCodeSample](~~44392~~)。', 'type' => 'string', 'required' => false, 'example' => '[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]'],
],
[
'name' => 'UseBackendService',
'in' => 'query',
'schema' => ['description' => '是否使用创建的后端服务资源:'."\n"
.'- TRUE:使用创建的后端服务'."\n"
.'- FALSE:自定义后端服务信息'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'TRUE'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]',
'title' => '修改API定义',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiConfiguration'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyApiGroup' => [
'summary' => '修改已经存在的API分组的名称,描述,或者basepath。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94431',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '分组名称,必须唯一,支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符,不传递表示不修改', 'type' => 'string', 'required' => false, 'example' => 'NewWeather'],
],
[
'name' => 'BasePath',
'in' => 'query',
'schema' => ['description' => 'api根路径', 'type' => 'string', 'required' => false, 'example' => '/eeee'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '分组描述,不超过180个字符,不传递表示不修改', 'type' => 'string', 'required' => false, 'example' => 'New weather informations.'],
],
[
'name' => 'UserLogConfig',
'in' => 'query',
'schema' => ['description' => '用户日志配置', 'type' => 'string', 'required' => false, 'example' => '{\\"requestBody\\":false,\\"responseBody\\":false,\\"queryString\\":\\"\\",\\"requestHeaders\\":\\"\\",\\"responseHeaders\\":\\"\\",\\"jwtClaims\\":\\"\\"}'],
],
[
'name' => 'CustomTraceConfig',
'in' => 'query',
'schema' => ['description' => '自定义trace配置', 'type' => 'string', 'required' => false, 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}'],
],
[
'name' => 'CompatibleFlags',
'in' => 'query',
'schema' => ['description' => '关联的标签列表,多个用逗号(,)分隔', 'type' => 'string', 'required' => false, 'example' => 'depart:dep1'],
],
[
'name' => 'CustomerConfigs',
'in' => 'query',
'schema' => ['description' => '用户自定义的配置项数据', 'type' => 'string', 'required' => false, 'example' => 'removeResponseServerHeader'],
],
[
'name' => 'PassthroughHeaders',
'in' => 'query',
'schema' => ['description' => '透传 Headers', 'type' => 'string', 'required' => false, 'example' => 'eagleeye-rpcid,x-b3-traceid,host'],
],
[
'name' => 'DefaultDomain',
'in' => 'query',
'schema' => ['description' => '默认域名', 'type' => 'string', 'required' => false, 'example' => 'mkt.api.gaore.com'],
],
[
'name' => 'RpcPattern',
'in' => 'query',
'schema' => ['description' => 'rpc模式', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => true, 'example' => 'uat'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'SupportSSE',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '是否支持网关向客户端发送事件流,实现实时数据推送', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'FilterAppCodeForBackend',
'in' => 'query',
'schema' => ['description' => '是否过滤后端请求中的appcode', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'CustomAppCodeConfig',
'in' => 'query',
'schema' => ['description' => '自定义AppCode配置', 'type' => 'string', 'required' => false, 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}'],
],
[
'name' => 'RpsLimitForServerless',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '4CF287C6-CE5B-477B-BE27-C48F99EADBC8'],
'BasePath' => ['description' => 'api根路径', 'type' => 'string', 'example' => '/test'],
'GroupId' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'NewWeather'],
'Description' => ['description' => 'API分组描述', 'type' => 'string', 'example' => 'New weather informations.'],
'SubDomain' => ['description' => '系统为API分组分配的二级域名', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com'],
],
'description' => '',
],
],
],
'title' => '修改API分组的信息',
'description' => '- 此功能面向API提供者'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CF287C6-CE5B-477B-BE27-C48F99EADBC8\\",\\n \\"BasePath\\": \\"/test\\",\\n \\"GroupId\\": \\"523e8dc7bbe04613b5b1d726c2a7889d\\",\\n \\"GroupName\\": \\"NewWeather\\",\\n \\"Description\\": \\"New weather informations.\\",\\n \\"SubDomain\\": \\"523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4CF287C6-CE5B-477B-BE27-C48F99EADBC8\\r\\n 523e8dc7bbe04613b5b1d726c2a7889d\\r\\n NewWeather\\r\\n 523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com\\r\\n New weather informations.\\r\\n","errorExample":""}]',
],
'ModifyApiGroupInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94432',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要迁移的API分组', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01c97ed08a614118849b00079753d1e2'],
],
[
'name' => 'TargetInstanceId',
'in' => 'query',
'schema' => ['description' => '目标实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-bj-c325375b1ebe'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '备注', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'migrate'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值', 'type' => 'string', 'required' => true, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D'],
],
'description' => '',
],
],
],
'title' => '修改api分组所属的实例',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupInstance'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D\\"\\n}","type":"json"}]',
],
'ModifyApiGroupNetworkPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94433',
'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要修改的分组id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0162c75d7d34ff48506f1aff878b05e'],
],
[
'name' => 'HttpsPolicy',
'in' => 'query',
'schema' => ['description' => 'https安全策略', 'type' => 'string', 'required' => false, 'example' => 'HTTPS1_1_TLS1_0'],
],
[
'name' => 'InternetEnable',
'in' => 'query',
'schema' => ['description' => '是否支持公网访问,**关闭后将无法通过公网访问API网关,请谨慎操作**'."\n"
.'- **True**:支持公网访问'."\n"
.'- **False**:关闭公网访问', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'InternetIPV6Enable',
'in' => 'query',
'schema' => ['description' => '是否开启ipv6'."\n"
.'- **True**:开启'."\n"
.'- **False**:关闭', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'VpcIntranetEnable',
'in' => 'query',
'schema' => ['description' => '是否开启内网VPC域名'."\n"
."\n"
.'- **True**:开通内网VPC域名'."\n"
."\n"
.'- **False**:关闭内网VPC域名', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false'],
],
[
'name' => 'VpcSlbIntranetEnable',
'in' => 'query',
'schema' => ['description' => '是否开启API网关自调用域名', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false'],
],
[
'name' => 'InnerDomainEnable',
'in' => 'query',
'schema' => ['description' => '是否支持分组的公网二级域名调用'."\n"
.'- **True**:支持分组公网二级域名调用'."\n"
.'- **False**:关闭分组公网二级域名调用,仅支持自定义域名访问', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C'],
],
'description' => '',
],
],
],
'title' => '修改api分组的网络策略',
'summary' => '修改api分组的网络。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupNetworkPolicy'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupNetworkPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E707B25-5119-5ACF-9D26-7D2A2762F05C\\"\\n}","type":"json"}]',
],
'ModifyApiGroupVpcWhitelist' => [
'summary' => '修改API分组VPC专有网络白名单。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94434',
'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9b80408147724ddab4c4e2703c6ca019'],
],
[
'name' => 'VpcIds',
'in' => 'query',
'schema' => ['description' => 'vpc实例id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp11w979o2s9rcr962w25'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'F8B9DC8C-D6E2-5065-BD1F-0401866E7F10'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B9DC8C-D6E2-5065-BD1F-0401866E7F10\\"\\n}","type":"json"}]',
'title' => '修改API分组VPC白名单',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupVpcWhitelist'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupVpcWhitelist',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'ModifyApp' => [
'summary' => '修改指定APP应用。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94436',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20112314518278'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '支持汉字、英文字母、数字、英文格式的下划线,且必须以字母或汉字开始,4~26个字符,1个中文汉字算2个字符。'."\n"
."\n"
.'若不修改,可不传该参数。', 'type' => 'string', 'required' => false, 'example' => 'jiedian_pord'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'APP描述信息,长度不超过180个字符。'."\n"
."\n"
.'若不修改,可不传该参数。', 'type' => 'string', 'required' => false, 'example' => 'modidyTest'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'key'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 20,
],
],
[
'name' => 'Extend',
'in' => 'query',
'schema' => ['description' => '扩展信息', 'type' => 'string', 'required' => false, 'example' => '110461946884'],
],
[
'name' => 'Disabled',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n","errorExample":""}]',
'title' => '修改APP应用',
'description' => '- 此功能面向调用API的用户'."\n"
.'- 可修改**AppName**或者**Description**,若两个属性都为空,则不做修改,直接返回成功'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
],
'ModifyBackend' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'BackendName',
'in' => 'query',
'schema' => ['description' => '后端服务名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testHttpModify'],
],
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端服务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20bcdc9453524b78a8beb1f6de21edb7'],
],
[
'name' => 'BackendType',
'in' => 'query',
'schema' => ['description' => '后端服务类型', 'type' => 'string', 'required' => true, 'example' => 'HTTP'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '06DACA61-9359-5EC6-AEDA-C73E620E49A9'],
],
'description' => '',
],
],
],
'title' => '修改后端服务',
'summary' => '修改后端服务的基本信息如名称,描述,后端服务类型一经创建无法修改。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackend'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06DACA61-9359-5EC6-AEDA-C73E620E49A9\\"\\n}","type":"json"}]',
],
'ModifyBackendModel' => [
'summary' => '修改后端服务在环境上的定义,修改后,使用该后端服务并发布在此环境上的API的后端地址都会批量更新,无需手动发布。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'BackendId',
'in' => 'query',
'schema' => ['description' => '后端 ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '20bcdc9453524b78a8beb1f6de21edb7'],
],
[
'name' => 'BackendType',
'in' => 'query',
'schema' => ['description' => '后端类型', 'type' => 'string', 'required' => false, 'example' => 'OSS'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TEST'],
],
[
'name' => 'BackendModelId',
'in' => 'query',
'schema' => ['description' => '后端模型 ID', 'type' => 'string', 'required' => false, 'example' => '3bb6375bc71c4e4c95ce05b4e7a55a9d'],
],
[
'name' => 'BackendModelData',
'in' => 'query',
'schema' => ['description' => '后端模型数据。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"ServiceAddress\\":\\"http://121.40.XX.XX\\"}'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '后端模型定义的描述', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'modify plugin first'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19B89B04-418B-55EE-94A8-6B42CA06002A'],
'OperationId' => ['description' => '操作ID。', 'type' => 'string', 'example' => 'c16a1880f5164d779f6a54f64d997cd9'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
],
],
'title' => '修改后端模型',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackendModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19B89B04-418B-55EE-94A8-6B42CA06002A\\",\\n \\"OperationId\\": \\"c16a1880f5164d779f6a54f64d997cd9\\"\\n}","type":"json"}]',
],
'ModifyDataset' => [
'summary' => '修改用户自定义数据集名称。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREapigatewayE6KZ22'],
],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'."\n"],
],
[
'name' => 'DatasetName',
'in' => 'query',
'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'NewDatasetName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876********'],
],
'description' => '',
],
],
],
'title' => '修改数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDataset'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876********\\"\\n}","type":"json"}]',
],
'ModifyDatasetItem' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DatasetId',
'in' => 'query',
'schema' => ['description' => '数据集ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'],
],
[
'name' => 'DatasetItemId',
'in' => 'query',
'schema' => ['description' => '数据集条目ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5045****'."\n"],
],
[
'name' => 'ExpiredTime',
'in' => 'query',
'schema' => ['description' => '数据条目超时时间,格式为**yyyy-MM-ddTHH:mm:ssZ(UTC时间)**', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-09-22T12:00:00Z'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息,长度不超过180个字符', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F7DE77BC-0F7D-5A18-B494-BD2C********'],
],
'description' => '',
],
],
],
'title' => '修改数据集条目',
'summary' => '修改用户自定义数据集的数据条目的超时时间和描述。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatasetItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7DE77BC-0F7D-5A18-B494-BD2C********\\"\\n}","type":"json"}]',
],
'ModifyInstanceAttribute' => [
'summary' => '修改API网关实例属性。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94438',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-ht-8xxxxxxxxx'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例名称', 'type' => 'string', 'required' => false, 'example' => 'apigatewayInstance'],
],
[
'name' => 'HttpsPolicy',
'in' => 'query',
'schema' => ['description' => 'HTTPS安全策略', 'type' => 'string', 'required' => false, 'example' => 'HTTPS2_TLS1_0'],
],
[
'name' => 'IPV6Enabled',
'in' => 'query',
'schema' => ['description' => '是否开启IPv6', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'EgressIpv6Enable',
'in' => 'query',
'schema' => ['description' => '是否支持IPv6出访能力', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'VpcSlbIntranetEnable',
'in' => 'query',
'schema' => ['description' => '是否开启API网关自调用域名', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性', 'type' => 'string', 'required' => false, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136'],
],
[
'name' => 'IntranetSegments',
'in' => 'query',
'schema' => ['description' => '自定义网段,所配置的网段将被视为私网地址', 'type' => 'string', 'required' => false, 'example' => '172.0.0.1/24'],
],
[
'name' => 'MaintainStartTime',
'in' => 'query',
'schema' => ['description' => '可运维开始时间,格式为HH:mmZ(UTC时间)', 'type' => 'string', 'required' => false, 'example' => '18:00Z'],
],
[
'name' => 'MaintainEndTime',
'in' => 'query',
'schema' => ['description' => '可运维结束时间,格式为HH:mmZ(UTC时间)', 'type' => 'string', 'required' => false, 'example' => '23:00Z'],
],
[
'name' => 'ToConnectVpcIpBlock',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'API网关可访问的网段信息',
'type' => 'object',
'properties' => [
'VswitchId' => ['description' => '虚拟交换机ID', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz94cqvaoe1ipxxxxxx'],
'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a'],
'CidrBlock' => ['description' => '虚拟交换机的网段', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/16'],
'Customized' => ['description' => '是否为自定义网段', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
],
[
'name' => 'DeleteVpcIpBlock',
'in' => 'query',
'schema' => ['description' => '是否删除VPC可访问网段', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX'],
],
'description' => '',
],
],
],
'title' => '修改指定实例的信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAttribute'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX\\"\\n}","type":"json"}]',
],
'ModifyInstanceSpec' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94441',
'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v6419k43xxxxx'],
],
[
'name' => 'InstanceSpec',
'in' => 'query',
'schema' => ['description' => '实例规格', 'type' => 'string', 'required' => true, 'example' => 'api.s1.small'],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => '续费时是否自动付费。取值:'."\n"
.'* **True**:自动付费。请确保账号有足够的余额。'."\n"
.'* **False**:控制台手动付费。具体操作为:登录控制台,在右上角选择**费用>进入费用中心**,在**订单管理**找到目标订单进行支付。'."\n"
."\n"
.'默认值:**False**。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '口令', 'type' => 'string', 'required' => true, 'example' => 'b5845042-2f2f-4e96-bd5c-36c6e5c2a68c'],
],
[
'name' => 'ModifyAction',
'in' => 'query',
'schema' => ['description' => '变配参数,取值:'."\n"
.'- 升配:**UPGRADE**。'."\n"
.'- 降配:**DOWNGRADE**。'."\n"
."\n"
.'默认值:**UPGRADE**。', 'type' => 'string', 'required' => false, 'example' => 'UPGRADE'],
],
[
'name' => 'SkipWaitSwitch',
'in' => 'query',
'schema' => ['description' => '是否跳过"待切流"状态。变配过程中API网关实例可能会增加新的出口IP,"待切流"状态是为了提醒用户将新的出口IP添加到IP白名单,将SkipWaitSwitch参数置为true后,实例不会再进入到"待切流"状态,若有新的出口IP,系统会发送站内信通知用户。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E'],
],
'description' => '',
],
],
],
'title' => '网关实例变配',
'summary' => 'API网关实例升降配置变更接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceSpec'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceSpec',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36BBBAD4-1CFB-489F-841A-8CA52EEA787E\\"\\n}","type":"json"}]',
],
'ModifyInstanceVpcAttributeForConsole' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94442',
'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-bj-f28baxxxxb51'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '专用网络ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-8vbnnd66xxxx2xb5oig4f'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性', 'type' => 'string', 'required' => false, 'example' => '505959c38776d9324945dbff709582'],
],
[
'name' => 'VpcOwnerId',
'in' => 'query',
'schema' => ['description' => 'VPC实例所属账号ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1121011712128923'],
],
[
'name' => 'VswitchId',
'in' => 'query',
'schema' => ['description' => '虚拟交换机ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bj9e2i8w3wz7shkvnuj9a'],
],
[
'name' => 'DeleteVpcAccess',
'in' => 'query',
'schema' => ['description' => '是否删除客户端所在VPC'."\n"
.'- FALSE:表示设置或修改客户端所在VPC'."\n"
.'- TRUE:表示删除客户端所在VPC', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D08741CF-BE59-5DA6-B06F-BB65173110C0'],
],
'description' => '',
],
],
],
'title' => '修改实例的客户端所在VPC',
'summary' => '修改实例的客户端所在VPC',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceVpcAttributeForConsole'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceVpcAttributeForConsole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D08741CF-BE59-5DA6-B06F-BB65173110C0\\"\\n}","type":"json"}]',
],
'ModifyIntranetDomainPolicy' => [
'summary' => '修改分组的内网VPC域名策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '192821',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'VpcIntranetEnable',
'in' => 'query',
'schema' => ['description' => '是否开启内网VPC域名'."\n"
."\n"
.'- TRUE:开通内网VPC域名'."\n"
."\n"
.'- FALSE:关闭内网VPC域名', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'],
],
'description' => '',
],
],
],
'title' => '修改分组内网VPC域名策略',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIntranetDomainPolicy'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIntranetDomainPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]',
],
'ModifyIpControl' => [
'summary' => '修改某个已存在的IP访问控制。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94443',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'IpControlName',
'in' => 'query',
'schema' => ['description' => 'IP访问控制名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。', 'type' => 'string', 'required' => false, 'example' => 'testControl11'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,不超过200个字符', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '修改IP访问控制',
'description' => '- 此功能面向API提供者'."\n"
.'- 该接口只能修改访问控制的名称和描述,访问控制类型不支持修改。'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'ModifyIpControlPolicyItem' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94444',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'P访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'PolicyItemId',
'in' => 'query',
'schema' => ['description' => '某条策略ID', 'type' => 'string', 'required' => true, 'example' => 'P151617000829241'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '指定策略限制的AppId,只有控制类型为白名单(即 IpControlType为ALLOW)时,才可同时增加AppId的限制。'."\n"
."\n"
.'- 一次只能增加一个;'."\n"
.'- 为空表示没有AppId的限制;'."\n"
.'- 当该值不为空,表示在有IP限制的同时,还限制访问的AppId;'."\n"
.'- 请注意:当该值不为空,如果API的安全认证为“无认证”,将限制所有的API调用;'."\n"
.'- 当黑名单(IpControlType为REFUSE)时,该值不为空,API网关会自动忽略该值,只设置IP的限制;', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'CidrIp',
'in' => 'query',
'schema' => ['description' => '具体策略的IP或者IP段,多个请用英文分号(;)分割,最多添加10个', 'type' => 'string', 'required' => true, 'example' => '113.125.1.101;101.11.1.1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '修改IP访问控制下的策略',
'summary' => '修改某个IP访问控制下的某条策略。',
'description' => '- 此功能面向API提供者'."\n"
.'- 增加该策略后,所有绑定该访问控制的API,即时生效'."\n"
.'- 修改是某条策略内容的全量修改',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControlPolicyItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'ModifyLogConfig' => [
'summary' => '修改日志配置',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94445',
'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'],
],
'parameters' => [
[
'name' => 'SlsProject',
'in' => 'query',
'schema' => ['description' => 'sls的项目名称', 'type' => 'string', 'required' => true, 'example' => 'ford-api-gateway-log'],
],
[
'name' => 'SlsLogStore',
'in' => 'query',
'schema' => ['description' => '日志服务日志存储名。', 'type' => 'string', 'required' => true, 'example' => 'logs-gateway'],
],
[
'name' => 'LogType',
'in' => 'query',
'schema' => [
'description' => '日志类型,可选值:'."\n"
."\n"
.'- **log**:日志'."\n"
.'- **survey**:质检日志',
'type' => 'string',
'required' => false,
'example' => 'PROVIDER',
'default' => 'PROVIDER',
'enum' => ['PROVIDER'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '75A4ADCB-AA26-51FB-94D4-AB3240040974'],
],
'description' => '',
],
],
],
'title' => '修改日志配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyLogConfig'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75A4ADCB-AA26-51FB-94D4-AB3240040974\\"\\n}","type":"json"}]',
],
'ModifyModel' => [
'summary' => '更新API分组的模型。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94446',
'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'],
],
'parameters' => [
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['description' => '模型的名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '新的模型定义的描述', 'type' => 'string', 'required' => false, 'example' => 'Model Description'],
],
[
'name' => 'Schema',
'in' => 'query',
'schema' => ['description' => '新的模型定义', 'type' => 'string', 'required' => false, 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '模型所属的分组编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381'],
],
[
'name' => 'NewModelName',
'in' => 'query',
'schema' => ['description' => '新的模型名称', 'type' => 'string', 'required' => false, 'example' => 'NewTest'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4173F95B-360C-460C-9F6C-4A960B904411\\r\\n","errorExample":""}]',
'title' => '更新模型',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyModel'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'ModifyPlugin' => [
'summary' => '修改插件信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94447',
'abilityTreeNodes' => ['FEATUREapigateway910B7T'],
],
'parameters' => [
[
'name' => 'PluginId',
'in' => 'query',
'schema' => ['description' => '指定要修改的API网关插件的ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a96926e82f994915a8da40a119374537 '],
],
[
'name' => 'PluginName',
'in' => 'query',
'schema' => ['description' => '插件名称。支持大小写英文字母、中文、数字、下划线(_)、长度为[4,50]个字符, 且不能以下划线开头。', 'type' => 'string', 'required' => false, 'example' => 'modifyCors'],
],
[
'name' => 'PluginData',
'in' => 'query',
'schema' => ['description' => '修改插件定义语句', 'type' => 'string', 'required' => false, 'example' => 'Plugin definition'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,限200字以内', 'type' => 'string', 'required' => false, 'example' => 'modify plugin first'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => false,
'example' => 'Key, Value',
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
],
'description' => '',
],
],
],
'title' => '修改插件',
'description' => '- 此接口面向开放API的用户。'."\n"
.'- 插件不允许重名。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlugin'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CE5722A6-AE78-4741-A9B0-6C817D360510\\r\\n","errorExample":""}]',
],
'ModifySignature' => [
'summary' => '修改API网关后端签名密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94448',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定要修改的签名密钥的ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'SignatureName',
'in' => 'query',
'schema' => ['description' => '设置新的密钥名称。支持汉字、英文字母、数字、英文格式的下划线,必须以英文字母或汉字开头,4~50个字符', 'type' => 'string', 'required' => false, 'example' => 'backendsignature'],
],
[
'name' => 'SignatureKey',
'in' => 'query',
'schema' => ['description' => '设置新的密钥Key值。支持英文字母、数字、英文格式的下划线,必须以英文字母开头,6~20个字符', 'type' => 'string', 'required' => false, 'example' => 'qwertyuiop'],
],
[
'name' => 'SignatureSecret',
'in' => 'query',
'schema' => ['description' => '设置新的密钥secret值。支持英文字母、数字、英文格式的下划线、及特殊字符(@、#、!、*),必须以英文字母开头,6~30个字符', 'type' => 'string', 'required' => false, 'example' => 'asdfghjkl'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
'SignatureId' => ['description' => '密钥ID', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
'SignatureName' => ['description' => '密钥名称', 'type' => 'string', 'example' => 'backendsignature'],
],
'description' => '',
],
],
],
'title' => '修改后端签名密钥',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 用于修改某个已存在的签名密钥的名称、Key和Secret'."\n"
.'- 需要注意,修改立即生效,若该密钥已经绑定API,后端做验证时请及时调整为针对新签名字符串的验证'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySignature'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifySignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n dd05f1c54d6749eda95f9fa6d491449a\\r\\n backendsignature\\r\\n","errorExample":""}]',
],
'ModifyStageModel' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'StageAlias',
'in' => 'query',
'schema' => ['description' => '环境别名', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '生产环境'],
],
[
'name' => 'StageModelId',
'in' => 'query',
'schema' => ['description' => '环境配置 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sdljflsjflj324xxx'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '环境描述', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381xxx'],
],
'description' => '',
],
],
],
'title' => '修改环境配置',
'summary' => '修改环境模型',
'description' => '**"** 此接口面向开放API的用户'."\n"
.'- 该接口需要全量更新,不支持部分参数更新'."\n"
.'- 修改ApiName时需要注意,同一个分组内API不允许重名'."\n"
.'- 修改RequestPath时需要注意,同一个分组内Path不允许重复'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381xxx\\"\\n}","type":"json"}]',
],
'ModifyTrafficControl' => [
'summary' => '修改用户自定义的流控策略设置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94449',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'tf123456'],
],
[
'name' => 'TrafficControlName',
'in' => 'query',
'schema' => ['description' => '流控策略名称,支持大小写英文字母,中文,数字,下划线,长度4~50,且不能以下划线开头。', 'type' => 'string', 'required' => false, 'example' => 'Throttling test'],
],
[
'name' => 'TrafficControlUnit',
'in' => 'query',
'schema' => ['description' => '单位,可选值:'."\n"
."\n"
.'- **SECOND**:秒'."\n"
.'- **MINUTE**:分钟'."\n"
.'- **HOUR**:小时'."\n"
.'- **DAY**:天', 'type' => 'string', 'required' => false, 'example' => 'HOUR'],
],
[
'name' => 'ApiDefault',
'in' => 'query',
'schema' => ['description' => '每个API默认流控值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'UserDefault',
'in' => 'query',
'schema' => ['description' => '每个用户默认的流控值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'AppDefault',
'in' => 'query',
'schema' => ['description' => '每个app默认的流控值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '流控描述信息', 'type' => 'string', 'required' => false, 'example' => 'Throttling test description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 '],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 \\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
'title' => '修改用户自定义的流控策略设置',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 修改将对策略下绑定的API即时生效'."\n"
.'- 该接口调用的QPS限制为:单用户QPS不超过50',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTrafficControl'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
],
],
'ModifyVpcAccessAndUpdateApis' => [
'summary' => '修改VPC授权信息并更新关联的API元信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '需要修改的新vpcId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-m5e7jqfppv5wbvmdw5pg2'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '需要修改的新的实例id'."\n"
."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => ' '."\n"
.'i-uf6bzcg1pr4oh5jjmxxx'."\n"],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => '需要修改的端口号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '80'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'VPC授权的名称。'."\n"
.'> '."\n"
.'> - VPC授权名称不可修改,该参数不可用于修改;'."\n"
.'> - 需要填写您当前VPC授权的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VpcName'],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => ['description' => '口令', 'type' => 'string', 'required' => false, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136'],
],
[
'name' => 'NeedBatchWork',
'in' => 'query',
'schema' => ['description' => '~~是否需要刷新关联的API,>如果您的VPC授权需要更新,并且该授权被API关联并已经发布上线,需要配置为true,否则您的API的后端服务不会刷新>'."\n"
.'~~'."\n"
.'该参数作废,更新VPC授权信息后如果有关联API存在,会自动更新API的元定义', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Refresh',
'in' => 'query',
'schema' => ['description' => '刷新VPC授权'."\n"
.'> '."\n"
.'> - 若您的VPC资源实例ID发生变化,但IP地址未变,勾选后可进行刷新授权', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'VpcTargetHostName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '后端授权的host', 'type' => 'string', 'required' => false, 'example' => 'iot.hu***ng.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperationId' => ['description' => '异步任务ID'."\n"
."\n"
.'> '."\n"
.'> - 如果关联API被刷新,可使用任务ID,调用**DescribeUpdateVpcInfoTask**接口,查询更新结果。', 'type' => 'string', 'example' => '7b6d0cb72b2e4215b0129f675c889746'],
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39'],
],
'description' => '',
],
],
],
'title' => '修改VPC授权信息,并且更新关联的API的元信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyVpcAccessAndUpdateApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyVpcAccessAndUpdateApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"7b6d0cb72b2e4215b0129f675c889746\\",\\n \\"RequestId\\": \\"C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39\\"\\n}","type":"json"}]',
],
'OpenApiGatewayService' => [
'summary' => '开通网关服务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '94453',
'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '开通服务的订单号。', 'type' => 'string', 'example' => '210981***530495'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989'],
],
'description' => '',
],
],
],
'title' => '开通服务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenApiGatewayService'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:OpenApiGatewayService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"210981***530495\\",\\n \\"RequestId\\": \\"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989\\"\\n}","type":"json"}]',
],
'QueryRequestLogs' => [
'summary' => '查询用户的操作日志记录。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94456',
'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'],
],
'parameters' => [
[
'name' => 'RequestLogId',
'in' => 'query',
'schema' => ['description' => '请求requestId', 'type' => 'string', 'required' => true, 'example' => '95657ED9-2F6F-426F-BD99-79C8********'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C81********'],
'RequestLogs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestLog' => [
'description' => '请求日志集合',
'type' => 'array',
'items' => [
'description' => '请求日志',
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API的ID', 'type' => 'string', 'example' => '4b83229ebcab4ecd88956fb3********'],
'ApiName' => ['description' => 'API名称', 'type' => 'string', 'example' => 'ApiName'],
'ConsumerAppKey' => ['description' => '调用方的App Key', 'type' => 'string', 'example' => '20412****'],
'TotalLatency' => ['description' => '总耗时,单位:ms', 'type' => 'string', 'example' => '1345'],
'HttpMethod' => ['description' => '请求使用的HTTP方法', 'type' => 'string', 'example' => 'POST'],
'Domain' => ['description' => '请求的域名', 'type' => 'string', 'example' => '360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com'],
'ErrorMessage' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`'],
'ConsumerAppId' => ['description' => '调用者应用ID', 'type' => 'string', 'example' => '11096****'],
'InstanceId' => ['description' => 'API服务所在的网关实例ID', 'type' => 'string', 'example' => 'apigateway-bj-ab2b********'],
'ClientNonce' => ['description' => '客户端X-Ca-Nonce头', 'type' => 'string', 'example' => 'd43df9db-3b05-4cd6-888a-1c0b********'],
'RequestSize' => ['description' => '请求大小,单位:字节', 'type' => 'string', 'example' => '1923'],
'StageId' => ['description' => 'API环境ID', 'type' => 'string', 'example' => '8a305b7f10334052a52d9156********'],
'StageName' => ['description' => 'API环境名称', 'type' => 'string', 'example' => 'RELEASE'],
'HttpPath' => ['description' => '请求的PATH', 'type' => 'string', 'example' => '/testPath'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********'],
'GroupId' => ['description' => 'API的分组ID', 'type' => 'string', 'example' => 'dc024277fe6c4cada79ba0bd6********'],
'GroupName' => ['description' => 'API分组名称', 'type' => 'string', 'example' => 'GroupName'],
'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'X500ER'],
'ResponseSize' => ['description' => '返回数据大小,单位:字节', 'type' => 'string', 'example' => '23441'],
'Region' => ['description' => '区域', 'type' => 'string', 'example' => 'cn-hangzhou'],
'StatusCode' => ['description' => '请求状态码', 'type' => 'string', 'example' => '200'],
'ClientIp' => ['description' => '调用者客户端IP', 'type' => 'string', 'example' => '21.237.XXX.XXX'],
'ServiceLatency' => ['description' => '访问后端资源耗时总和,包括申请连接资源耗时,建立连接耗时,调用后端服务耗时,单位:毫秒', 'type' => 'string', 'example' => '324'],
'RequestTime' => ['description' => '请求时间,UTC', 'type' => 'string', 'example' => '2022-10-29T03:59:59Z'],
'Exception' => ['description' => '后端返回的具体错信息', 'type' => 'string', 'example' => 'error msg'],
'CustomTraceId' => ['description' => '自定义API调用链id', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********'],
'JwtClaims' => ['description' => '从JWT中解析出来的Claim,可以在分组上配置', 'type' => 'string', 'example' => '{}'],
'RequestProtocol' => ['description' => '客户端请求协议:HTTP/HTTPS/WS', 'type' => 'string', 'example' => 'HTTP'],
'RequestHeaders' => ['description' => '客户端请求的header内容', 'type' => 'string', 'example' => 'content-type: application/x-www-form-urlencoded'],
'RequestQueryString' => ['description' => '客户端请求的queryString', 'type' => 'string', 'example' => 'username=name'],
'RequestBody' => ['description' => '客户端请求的body内容,最多1024个字节', 'type' => 'string', 'example' => 'param=paramName'],
'ResponseHeaders' => ['description' => 'API响应的header内容', 'type' => 'string', 'example' => 'content-type: application/x-www-form-urlencoded'."\n"],
'ResponseBody' => ['description' => 'API响应的response内容,最多1024个字节', 'type' => 'string', 'example' => 'param=paramName'."\n"],
'plugin' => ['description' => 'API请求命中的插件列表及相关上下文', 'type' => 'string', 'example' => '[]'],
'InitialRequestId' => ['description' => 'API网关自调用时,例如API-1调用API-2 ,那么API-2的日志中会用initialRequestId来记录API-1的requestid', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********'],
'AppName' => ['description' => 'APP名称', 'type' => 'string', 'example' => 'VIPROOM_VIPROOM'],
'FrontRequestStart' => ['description' => 'API网关开始接收到客户端请求的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224968'],
'FrontRequestEnd' => ['description' => 'API网关完成接收客户端请求的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224968'],
'BackendRequestStart' => ['description' => 'API网关开始向后端服务发起请求的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224969'],
'BackendRequestEnd' => ['description' => 'API网关完成向后端服务发起请求的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224969'],
'BackendResponseStart' => ['description' => 'API网关开始接收到后端服务响应的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989'],
'BackendResponseEnd' => ['description' => 'API网关完成接收后端服务响应的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989'],
'FrontResponseStart' => ['description' => 'API网关开始向客户端发送响应的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989'],
'FrontResponseEnd' => ['description' => 'API网关完成向客户端发送响应的时间点', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989'],
],
],
],
],
'description' => '',
],
],
],
],
],
'title' => '获取请求日志',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRequestLogs'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:QueryRequestLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C81********\\",\\n \\"RequestLogs\\": {\\n \\"RequestLog\\": [\\n {\\n \\"ApiId\\": \\"4b83229ebcab4ecd88956fb3********\\",\\n \\"ApiName\\": \\"ApiName\\",\\n \\"ConsumerAppKey\\": \\"20412****\\",\\n \\"TotalLatency\\": \\"1345\\",\\n \\"HttpMethod\\": \\"POST\\",\\n \\"Domain\\": \\"360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com\\",\\n \\"ErrorMessage\\": \\"Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`\\",\\n \\"ConsumerAppId\\": \\"11096****\\",\\n \\"InstanceId\\": \\"apigateway-bj-ab2b********\\",\\n \\"ClientNonce\\": \\"d43df9db-3b05-4cd6-888a-1c0b********\\",\\n \\"RequestSize\\": \\"1923\\",\\n \\"StageId\\": \\"8a305b7f10334052a52d9156********\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"HttpPath\\": \\"/testPath\\",\\n \\"RequestId\\": \\"95657ED9-2F6F-426F-BD99-79C8********\\",\\n \\"GroupId\\": \\"dc024277fe6c4cada79ba0bd6********\\",\\n \\"GroupName\\": \\"GroupName\\",\\n \\"ErrorCode\\": \\"X500ER\\",\\n \\"ResponseSize\\": \\"23441\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"StatusCode\\": \\"200\\",\\n \\"ClientIp\\": \\"21.237.XXX.XXX\\",\\n \\"ServiceLatency\\": \\"324\\",\\n \\"RequestTime\\": \\"2022-10-29T03:59:59Z\\",\\n \\"Exception\\": \\"error msg\\",\\n \\"CustomTraceId\\": \\"95657ED9-2F6F-426F-BD99-79C8********\\",\\n \\"JwtClaims\\": \\"{}\\",\\n \\"RequestProtocol\\": \\"HTTP\\",\\n \\"RequestHeaders\\": \\"content-type: application/x-www-form-urlencoded\\",\\n \\"RequestQueryString\\": \\"username=name\\",\\n \\"RequestBody\\": \\"param=paramName\\",\\n \\"ResponseHeaders\\": \\"content-type: application/x-www-form-urlencoded\\\\n\\",\\n \\"ResponseBody\\": \\"param=paramName\\\\n\\",\\n \\"plugin\\": \\"[]\\",\\n \\"InitialRequestId\\": \\"95657ED9-2F6F-426F-BD99-79C8********\\",\\n \\"AppName\\": \\"VIPROOM_VIPROOM\\",\\n \\"FrontRequestStart\\": 1731487224968,\\n \\"FrontRequestEnd\\": 1731487224968,\\n \\"BackendRequestStart\\": 1731487224969,\\n \\"BackendRequestEnd\\": 1731487224969,\\n \\"BackendResponseStart\\": 1731487224989,\\n \\"BackendResponseEnd\\": 1731487224989,\\n \\"FrontResponseStart\\": 1731487224989,\\n \\"FrontResponseEnd\\": 1731487224989\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ReactivateDomain' => [
'summary' => '重新激活合法状态为异常的自定义域名。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94457',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
],
'description' => '',
],
],
],
'title' => '更新域名绑定状态',
'description' => '- 此功能面向API提供者'."\n"
.'- 需要先解决域名异常提示里的问题后,再执行激活操作'."\n"
.'- 当自定义域名合法状态为异常时(一般是域名未备案或者域名被管局列入黑名单),将不能通过该域名访问API'."\n"
.'- 域名通过该接口被重新激活后,通过该域名就可正常访问API',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReactivateDomain'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ReactivateDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\r\\n","errorExample":""}]',
],
'RemoveAccessControlListEntry' => [
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'在实例的访问控制策略中删除IP条目。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp12ag0xxcfhq1ll68wp9'],
],
[
'name' => 'AclEntrys',
'in' => 'query',
'schema' => ['description' => ' '."\n"
.'设置访问控制策略组。'."\n"
."\n"
.'* entry:访问控制策略组中的IP条目,可以指定IP地址或IP地址段(CIDR block),多个IP地址/地址段之间用逗号隔开。。'."\n"
."\n"
.'* comment:访问控制策略组备注说明。'."\n"
."\n"
.'>如果访问控制策略组关联了监听,不允许删除组内的所有IP条目。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{\\"entry\\":\\"192.168.1.0/24\\",\\"comment\\":\\"WhiteIp\\"}]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD'],
],
'description' => '',
],
],
],
'title' => '删除IP条目',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAccessControlListEntry'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:RemoveAccessControlListEntry',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\"\\n}","type":"json"}]',
],
'RemoveApiProductsAuthorities' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110982490'],
],
[
'name' => 'ApiProductIds',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => 'API产品ID列表',
'type' => 'array',
'items' => ['description' => 'API产品ID', 'type' => 'string', 'required' => false, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
],
'description' => '',
],
],
],
'title' => '批量移除API产品对指定APP的授权',
'summary' => '批量移除API产品对指定APP的授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApiProductsAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveApiProductsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]',
],
'RemoveApisAuthorities' => [
'summary' => '撤销指定应用(app)对多个API的访问权限。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94461',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用(app)编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,取值为:'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '授权说明', 'type' => 'string', 'required' => false, 'example' => 'Query weather by region name'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n","errorExample":""}]',
'title' => '撤销应用APP对多个API访问权限',
'description' => '- 此功能面向API提供者和API使用者'."\n"
.'- 撤销前请查看添加授权记录的授权者,API所有者只能撤销Provider的授权,API使用者只能撤销Consumer的授权',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApisAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveApisAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'RemoveAppsAuthorities' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94462',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,取值为'."\n"
."\n"
.'- **RELEASE**'."\n"
.'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'AppIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的app编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2386789,3286798'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
],
'description' => '',
],
],
],
'title' => '撤销多个APP对指定API的访问权限',
'summary' => '撤销多个APP对指定API的访问权限,多个APP一个API。',
'description' => '- 此功能面向API提供者和API使用者'."\n"
.'- 撤销前请查看添加授权记录的授权者,API所有者只能撤销Provider的授权,API使用者只能撤销Consumer的授权',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAppsAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveAppsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n","errorExample":""}]',
],
'RemoveIpControlApis' => [
'summary' => '解除API与IP访问控制的绑定关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94465',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => '指定要操作的IP访问控制ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要解绑的API。'."\n"
."\n"
.'- 若不传入:默认解绑该分组该环境下的所有API。'."\n"
.'- 指定要查询的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '解除API与IP访问控制的绑定',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 即时生效,解除后该API的对应环境将不会有IP访问控制',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveIpControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'RemoveIpControlPolicyItem' => [
'summary' => '移除某个IP访问控制下的一条或多条策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94466',
'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'],
],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => 'IP访问控制的ID,代表了唯一的IP控制策略', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1'],
],
[
'name' => 'PolicyItemIds',
'in' => 'query',
'schema' => ['description' => '具体的策略ID,多个以英文分号(;)分割,最多100个', 'type' => 'string', 'required' => true, 'example' => 'P151533572852362;P151533557750260'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '移除IP访问控制的策略',
'description' => '- 此功能面向API提供者',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlPolicyItem'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'RemoveSignatureApis' => [
'summary' => '解除API与后端签名密钥的绑定关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94467',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定要操作的签名密钥ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要解绑的API。'."\n"
."\n"
.'- 若不传入:默认解绑该分组该环境下的所有API。'."\n"
.'- 指定要查询的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '解除API与后端签名密钥的绑定',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 即时生效,解除后网关到后端服务的请求将不带有签名字符串,请后端去掉相应的校验环节',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSignatureApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveSignatureApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'RemoveTrafficControlApis' => [
'summary' => '解除API与流控策略的绑定关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94468',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '指定要操作的流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要解绑的API。'."\n"
."\n"
.'- 若不传入:默认解绑该分组该环境下的所有API。'."\n"
.'- 若输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '解除API与流控策略的绑定',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 用于解除API与流控策略的绑定关系,支持API批量,最多100个'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTrafficControlApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveTrafficControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'RemoveVpcAccess' => [
'summary' => '仅删除VPC授权,不做下线关联API的修改。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94469',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '专用网络ID', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf657qec7lx42paw3qxxx'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '专用网络中的实例ID(ECS/负载均衡)', 'type' => 'string', 'required' => true, 'example' => 'i-uf6bzcg1pr4oh5jjmxxx'],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '80'],
],
[
'name' => 'NeedBatchWork',
'in' => 'query',
'schema' => ['description' => '是否需要批量工作', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'Apis' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Api' => [
'description' => 'API 列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApiId' => ['description' => 'API Id', 'type' => 'string', 'example' => '551877242a4b4f3a84a56b7c3570e4a7'],
'StageId' => ['description' => '环境 ID', 'type' => 'string', 'example' => 'd1e1ee28f9fb4b729db0ee8ca76ff0a5'],
'GroupId' => ['description' => 'API分组ID', 'type' => 'string', 'example' => '78d54ac4424d4b1792e33ca35637e8e4'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'title' => '撤销 VPC 授权',
'description' => '- 此功能面向开放 API 的用户'."\n"
.'- 撤销 API 网关访问您 VPC 实例的权限'."\n"
."\n"
.'> 删除授权可能会影响您线上的API运行,请在删除前确认此授权未被API使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccess'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"Apis\\": {\\n \\"Api\\": [\\n {\\n \\"ApiId\\": \\"551877242a4b4f3a84a56b7c3570e4a7\\",\\n \\"StageId\\": \\"d1e1ee28f9fb4b729db0ee8ca76ff0a5\\",\\n \\"GroupId\\": \\"78d54ac4424d4b1792e33ca35637e8e4\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n","errorExample":""}]',
],
'RemoveVpcAccessAndAbolishApis' => [
'summary' => '删除VPC授权并下线关联的已经发布在线上的API。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94470',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '指定要操作的vpcid', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1iw82phcgkvupgfv0o8'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '专用网络中的实例ID(ECS/负载均衡)', 'type' => 'string', 'required' => true, 'example' => 'i-uf6iaale3gfef9t9cb41'],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => '服务端口。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8080'],
],
[
'name' => 'NeedBatchWork',
'in' => 'query',
'schema' => ['description' => '是否需要批量工作。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperationId' => ['description' => '操作ID。', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'],
],
'description' => '',
],
],
],
'title' => '删除VPC授权',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccessAndAbolishApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveVpcAccessAndAbolishApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]',
],
'ResetAppCode' => [
'summary' => '重置应用的AppCode。此接口每个用户每分钟只能调一次。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94471',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppCode',
'in' => 'query',
'schema' => ['description' => '应用的AppCode', 'type' => 'string', 'required' => true, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc'],
],
[
'name' => 'NewAppCode',
'in' => 'query',
'schema' => ['description' => '新的应用AppCode。', 'type' => 'string', 'required' => false, 'example' => '6f0e7ab2aa5f4b8fb18421e6edf4fb6c2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD'],
],
'description' => '',
],
],
],
'title' => '重置应用',
'description' => '重置AppCode会存在大约2秒的延迟。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppCode'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ResetAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\"\\n}","type":"json"}]',
],
'ResetAppSecret' => [
'summary' => '重置指定app的密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94472',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'App的Key,用于调用API时使用', 'type' => 'string', 'required' => true, 'example' => '60030986'],
],
[
'name' => 'NewAppKey',
'in' => 'query',
'schema' => ['description' => '设置的新的AppKey,需要全局唯一', 'type' => 'string', 'required' => false, 'example' => 'testAppKey'],
],
[
'name' => 'NewAppSecret',
'in' => 'query',
'schema' => ['description' => '新的应用密钥。为提高兼容性,建议您尽量使用其他参数。'."\n"
.'该参数不填,默认系统会自动生成一个新的AppSecret值', 'type' => 'string', 'required' => false, 'example' => 'test***'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
],
'description' => '',
],
],
],
'title' => '重置 app 密钥',
'description' => '- 此功能面向调用API的用户'."\n"
.'- 可以通过该接口重置AppKey和AppSecret'."\n"
.'- NewAppSecret不填写,系统默认会自动生成一个新的AppSecret'."\n"
.'- 该接口不直接返回密码,需要通过查询密码的接口获取'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppSecret'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ResetAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\r\\n","errorExample":""}]',
],
'SdkGenerateByApp' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94474',
'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的唯一编号', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110797019'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '需要生成的编程语言', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'java'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DownloadLink' => ['description' => 'SDK的base64后的编码,通过base64解码可以得到文件', 'type' => 'string', 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2'],
],
'description' => '',
],
],
],
'title' => '按应用生成SDK',
'summary' => '按APP应用生成SDK。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByApp'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......\\",\\n \\"RequestId\\": \\"61A16D46-EC04-5288-8A18-811B0F536CC2\\"\\n}","type":"json"}]',
],
'SdkGenerateByAppForRegion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'App编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110906109'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '需要生成的编程语言', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Java'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DownloadLink' => ['description' => 'SDK的base64后的编码,通过base64解码可以得到文件', 'type' => 'string', 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510'],
],
'description' => '',
],
],
],
'title' => '按应用生成SDK',
'summary' => '生成与App关联的API的SDK',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByAppForRegion'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByAppForRegion',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......\\",\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]',
],
'SdkGenerateByGroup' => [
'summary' => '按API分组生成SDK。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94475',
'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'api分组id,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1a991a450b9548a1a3df38fd3af117c2'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['description' => '指定返回的语言,取值:-**zh-cn**(默认值):中文-**en-us**:英文', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'java'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DownloadLink' => ['description' => '下载地址', 'type' => 'string', 'example' => 'http://oss-bucket/object'],
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F'],
],
'description' => '',
],
],
],
'title' => '按分组生成SDK',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByGroup'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"http://oss-bucket/object\\",\\n \\"RequestId\\": \\"D0075BDA-8AED-5073-A70A-FE44E86AB20F\\"\\n}","type":"json"}]',
],
'SetAccessControlListAttribute' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'AclName',
'in' => 'query',
'schema' => ['description' => '访问控制策略组名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAcl'],
],
[
'name' => 'AclId',
'in' => 'query',
'schema' => ['description' => '访问控制策略组id', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp1ohqkonqybecf4llbrc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2'],
],
'description' => '',
],
],
],
'title' => '修改访问控制策略名称',
'summary' => '本功能为API网关专享实例提供实例级别的访问控制能力;'."\n"
.'修改访问控制策略名称。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccessControlListAttribute'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetAccessControlListAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]',
],
'SetApiProductsAuthorities' => [
'summary' => '批量授权API产品给指定APP。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => 'APP的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '111385984'],
],
[
'name' => 'ApiProductIds',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'simple',
'schema' => [
'description' => 'API产品ID列表',
'type' => 'array',
'items' => ['description' => 'API产品ID', 'type' => 'string', 'required' => false, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
'required' => true,
],
],
[
'name' => 'AuthValidTime',
'in' => 'query',
'schema' => ['description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT), 如果为空,即为授权永久有效。', 'type' => 'string', 'required' => false, 'example' => '2023-06-12T03:07:37Z'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '授权描述信息', 'type' => 'string', 'required' => false, 'example' => 'Description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2603F41E-77FC-59A3-840E-296578A9BDE0'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2603F41E-77FC-59A3-840E-296578A9BDE0\\"\\n}","type":"json"}]',
'title' => '批量授权API产品给指定APP',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApiProductsAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SetApiProductsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SetApisAuthorities' => [
'summary' => '给指定app添加多个API的访问权限。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用编号,系统生成,全局唯一', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '授权说明', 'type' => 'string', 'required' => false, 'example' => 'Query weather by region name'],
],
[
'name' => 'AuthValidTime',
'in' => 'query',
'schema' => ['description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT), 如果为空,即为授权永久有效。', 'type' => 'string', 'required' => false, 'example' => 'Fri,05Oct201816:00:00GMT'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n","errorExample":""}]',
'title' => '给多个API添加APP访问权限',
'description' => '- 此功能面向API提供者和API使用者'."\n"
.'- API提供者可以授权自己的API给任意应用(app)调用'."\n"
.'- API使用者可以将已购买的API授权给自己的应用(app)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApisAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetApisAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'SetAppsAuthToApiProduct' => [
'summary' => '批量授权多个APP给指定的API产品',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiProductId',
'in' => 'query',
'schema' => ['description' => 'API产品ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e'],
],
[
'name' => 'AppIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '应用ID列表',
'type' => 'array',
'items' => ['description' => '授权的应用ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '110966607'],
'required' => true,
],
],
[
'name' => 'AuthValidTime',
'in' => 'query',
'schema' => ['description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT), 如果为空,即为授权永久有效。', 'type' => 'string', 'required' => false, 'example' => '2023-05-31T08:15:39Z'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'Description'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]',
'title' => '批量授权多个APP给指定API产品',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthToApiProduct'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SetAppsAuthToApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apiproduct/{#ApiProductId}'],
],
],
],
],
],
'SetAppsAuthorities' => [
'summary' => '给多个 APP 添加指定 API 的访问权限。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94478',
'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组ID,系统生成,全局唯一', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '环境名称,取值为:'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST'],
],
[
'name' => 'AppIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的app编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2386789,3389798'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '授权说明', 'type' => 'string', 'required' => false, 'example' => 'Query weather by region name'],
],
[
'name' => 'AuthValidTime',
'in' => 'query',
'schema' => ['description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT),如果为空,即为授权永久有效。', 'type' => 'string', 'required' => false, 'example' => 'Fri,05Oct201816:00:00GMT'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\r\\n","errorExample":""}]',
'title' => '给多个APP添加API访问权限',
'description' => '- 此功能面向API调用者和API使用者'."\n"
.'- API提供者可以授权自己的API给任意应用(app)调用'."\n"
.'- API使用者可以将已购买的API授权给自己的应用(app)'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthorities'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetAppsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}'],
],
],
],
],
],
'SetDomain' => [
'summary' => '给指定API分组绑定自定义域名。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94479',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'BindStageName',
'in' => 'query',
'schema' => ['description' => '域名要指定环境访问。不设置该值,则表示该域名能访问所有环境。'."\n"
."\n"
.'如果指定了某个具体的环境,则该域名只能访问这个环境。'."\n"
.'可选值:'."\n"
.'- TEST'."\n"
.'- PRE'."\n"
.'- RELEASE'."\n"
."\n"
.'当要修改为全部环境都可访问时,则将该值设置为空串(“”)即可。'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RELEASE'],
],
[
'name' => 'CustomDomainType',
'in' => 'query',
'schema' => ['description' => '指定域名要绑定的类型:公网或者内网。默认为INTERNET。可选值:'."\n"
."\n"
.'- INTERNET:公网类型'."\n"
.'- INTRANET:内网类型, 当指定了内网类型后,就不允许该域名从公网请求过来。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INTERNET'],
],
[
'name' => 'IsForce',
'in' => 'query',
'schema' => ['description' => '该字段用于当域名冲突时,是否强制绑定该域名。如果选择true,则会强制在该分组绑定此域名,另外冲突的分组上的域名会自动解绑。该操作有一定风险,请谨慎操作。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'IsHttpRedirectToHttps',
'in' => 'query',
'schema' => ['description' => '是否将http重定向到https', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231'],
'DomainLegalStatus' => ['description' => '域名合法状态,取值:'."\n"
."\n"
.'- **NORMAL**:正常'."\n"
.'- **ABNORMAL**:异常,该状态会影响API调用,需尽快解决', 'type' => 'string', 'example' => 'NORMAL'],
'GroupId' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'example' => '927d50c0f2e54b359919923d908bb015'],
'SubDomain' => ['description' => '系统给分组绑定的二级域名,用于测试API调用', 'type' => 'string', 'example' => 'xxx-cn-hangzhou.alicloudapi.com'],
'DomainName' => ['description' => '自定义域名', 'type' => 'string', 'example' => 'api.demo.com'],
'DomainBindingStatus' => ['description' => '自定义域名绑定状态'."\n"
."\n"
.'- **BINDING**:正常'."\n"
.'- **BOUND**:未生效', 'type' => 'string', 'example' => 'BINDING'],
'DomainRemark' => ['description' => '域名相关备注,如描述域名异常状态原因', 'type' => 'string', 'example' => '无'],
'DomainWebSocketStatus' => ['description' => '使用WebSocket功能的域名状态', 'type' => 'string', 'example' => 'NORMAL'],
],
'description' => '',
],
],
],
'title' => '给指定分组绑定自定义域名',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomain'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AA90E87-3506-5AA6-AFFB-A4D53B4F6231\\",\\n \\"DomainLegalStatus\\": \\"NORMAL\\",\\n \\"GroupId\\": \\"927d50c0f2e54b359919923d908bb015\\",\\n \\"SubDomain\\": \\"xxx-cn-hangzhou.alicloudapi.com\\",\\n \\"DomainName\\": \\"api.demo.com\\",\\n \\"DomainBindingStatus\\": \\"BINDING\\",\\n \\"DomainRemark\\": \\"无\\",\\n \\"DomainWebSocketStatus\\": \\"NORMAL\\"\\n}","type":"json"}]',
],
'SetDomainCertificate' => [
'summary' => '为指定自定义域名上传SSL证书。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94480',
'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'CertificateName',
'in' => 'query',
'schema' => ['description' => 'SSL证书名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_cert'],
],
[
'name' => 'CertificateBody',
'in' => 'query',
'schema' => ['description' => '证书内容', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud'."\n"
.'....'."\n"
.'-----END CERTIFICATE-----'],
],
[
'name' => 'CertificatePrivateKey',
'in' => 'query',
'schema' => ['description' => '证书私钥', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN RSA PRIVATE KEY-----'."\n"
.'MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud'."\n"
.'....'."\n"
.'-----END RSA PRIVATE KEY-----'],
],
[
'name' => 'CaCertificateBody',
'in' => 'query',
'schema' => ['description' => 'CA 证书内容'."\n"
."\n"
.'> ( HTTPS双向认证场景使用)。', 'type' => 'string', 'required' => false, 'example' => 'CA certificate encoding content'],
],
[
'name' => 'SslVerifyDepth',
'in' => 'query',
'schema' => ['description' => '证书验证深度'."\n"
.'> ( HTTPS双向认证场景使用)。', 'type' => 'string', 'required' => false, 'example' => '2'],
],
[
'name' => 'SslOcspEnable',
'in' => 'query',
'schema' => ['description' => '是否支持OCSP验证'."\n"
.'> ( HTTPS双向认证场景使用)。', 'type' => 'boolean', 'required' => false, 'example' => 'True'],
],
[
'name' => 'SslOcspCacheEnable',
'in' => 'query',
'schema' => ['description' => '是否支持OCSP缓存'."\n"
.'> ( HTTPS双向认证场景使用)。', 'type' => 'boolean', 'required' => false, 'example' => 'True'],
],
[
'name' => 'ClientCertSDnPassThrough',
'in' => 'query',
'schema' => ['description' => '将证书中 ssl_client_s_dn 的值通过 Header \'X-Client-S-Dn\' 传输给后端服务'."\n"
.'> ( HTTPS双向认证场景使用)。', 'type' => 'boolean', 'required' => false, 'example' => 'True'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6EF60BEC-0242-43AF-BB20-270359FB54A7\\r\\n","errorExample":""}]',
'title' => '为自定义域名添加SSL证书',
'description' => '- 此功能面向API提供者。'."\n"
.'- SSL证书必须与域名匹配。'."\n"
.'- 绑定SSL证书后,可提供基于HTTPS的API服务。'."\n"
.'- HTTPS双向认证场景才需要填写根证书,一般情况不需要填写。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainCertificate'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomainCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
],
'SetDomainWebSocketStatus' => [
'summary' => '开通或关闭自定义域名的WebSocket。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94481',
'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cf976e63b70c4993807e7bb9345d4695'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ac.fluvet.cn'],
],
[
'name' => 'ActionValue',
'in' => 'query',
'schema' => ['description' => '操作参数值', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN'],
],
[
'name' => 'WSSEnable',
'in' => 'query',
'schema' => ['description' => '是否开启WSS', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2'],
],
'description' => '',
],
],
],
'title' => '设置域名WebSocket状态',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainWebSocketStatus'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomainWebSocketStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61A16D46-EC04-5288-8A18-811B0F536CC2\\"\\n}","type":"json"}]',
],
'SetIpControlApis' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'IpControlId',
'in' => 'query',
'schema' => ['description' => '指定要操作的IP访问控制的ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'TEST'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'staticInfo' => [],
'title' => '绑定IP访问控制与API关系',
'summary' => '添加指定IP访问控制与API的绑定关系。',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 支持多个API批量操作,最多100个',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetIpControlApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetIpControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'SetSignatureApis' => [
'summary' => '添加指定签名密钥与API的绑定。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94485',
'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'],
],
'parameters' => [
[
'name' => 'SignatureId',
'in' => 'query',
'schema' => ['description' => '指定要操作的签名密钥id', 'type' => 'string', 'required' => true, 'example' => '9242e31589fc41f4ba15dd52ffa2ce61'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定的分组编号', 'type' => 'string', 'required' => true, 'example' => 'b1eed5faa2404af4945cca26d611a136'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号', 'type' => 'string', 'required' => true, 'example' => '7ce7022b23a340c7becd947487fad84c'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '27F9C50D-7EB4-5623-8472-45B3C7602C91'],
],
'description' => '',
],
],
],
'title' => '绑定签名密钥与API',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSignatureApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetSignatureApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27F9C50D-7EB4-5623-8472-45B3C7602C91\\"\\n}","type":"json"}]',
],
'SetTrafficControlApis' => [
'summary' => '添加指定流控策略与API的绑定。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94486',
'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'],
],
'parameters' => [
[
'name' => 'TrafficControlId',
'in' => 'query',
'schema' => ['description' => '指定要操作的流控策略ID', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '指定要操作API所属分组ID', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'ApiIds',
'in' => 'query',
'schema' => ['description' => '指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**:线上'."\n"
.'- **TEST**:测试', 'type' => 'string', 'required' => true, 'example' => 'RELEASE'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004'],
],
'description' => '',
],
],
],
'title' => '添加指定流控策略与API的绑定',
'description' => '- 此功能面向开放API的用户'."\n"
.'- 用于添加API与策略的绑定关系,支持多个API批量操作,最多100个',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTrafficControlApis'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetTrafficControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\r\\n","errorExample":""}]',
],
'SetVpcAccess' => [
'summary' => '创建VPC授权,开通反向访问。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94487',
'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义授权名称,需要保持唯一,不能重复', 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '专用网络ID,必须是同账户下可用的专用网络的ID', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf657qec7lx42paw3qxxx'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '专用网络中的实例ID(ECS/负载均衡)', 'type' => 'string', 'required' => true, 'example' => 'i-uf6bzcg1pr4oh5jjmxxx'],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => '实例对应的端口号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '80'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'VPC description'],
],
[
'name' => 'VpcTargetHostName',
'in' => 'query',
'schema' => ['description' => '后端授权的host', 'type' => 'string', 'required' => false, 'example' => 'iot.hu***ng.com'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定规则所适用的对象标签,可设置多个。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['description' => '标签的值', 'type' => 'string', 'required' => false, 'example' => '123'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'],
'VpcAccessId' => ['description' => 'Vpc授权ID', 'type' => 'string', 'example' => '4c68e061860f441ab72af7404137440e'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"VpcAccessId\\": \\"4c68e061860f441ab72af7404137440e\\"\\n}","type":"json"}]',
'title' => '添加 VPC 授权',
'description' => '- 此功能面向开放 API 的用户。'."\n"
.'- 授权 API 网关允许访问您的 VPC 实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVpcAccess'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/*'],
],
],
],
],
],
'SetWildcardDomainPatterns' => [
'summary' => '为绑定的自定义域名设置泛域名模板。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94488',
'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'],
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'API分组 ID,系统生成,全局唯一', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '自定义域名', 'type' => 'string', 'required' => true, 'example' => '*.prd.e-eir.com'],
],
[
'name' => 'WildcardDomainPatterns',
'in' => 'query',
'schema' => ['description' => '通配域名模式。', 'type' => 'string', 'required' => false, 'example' => '[\\"{svc}.prd.e-eir.com\\"]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F'],
],
'description' => '',
],
],
],
'title' => '设置通配符域名模式',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWildcardDomainPatterns'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetWildcardDomainPatterns',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0075BDA-8AED-5073-A70A-FE44E86AB20F\\"\\n}","type":"json"}]',
],
'SwitchApi' => [
'summary' => '指定历史版本切换掉指定环境中正在运行中的API定义,即用历史定义替换运行中定义。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'api分组编号', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '8dfec8759a6e4831bf73d8a982c20778'],
],
[
'name' => 'ApiId',
'in' => 'query',
'schema' => ['description' => 'API编号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b41f334843c445619bc3b85419895b3e'],
],
[
'name' => 'StageName',
'in' => 'query',
'schema' => ['description' => '指定要操作API的环境。'."\n"
."\n"
.'- **RELEASE**: 线上'."\n"
.'- **PRE**: 预发'."\n"
.'- **TEST**: 测试', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述,限200字以内', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'for_demo'],
],
[
'name' => 'HistoryVersion',
'in' => 'query',
'schema' => ['description' => '历史版本号', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20210305180312839'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'FB263467-7F5D-5A1B-88E8-06CB0228E0FE'],
],
'description' => '',
],
],
],
'title' => '切换指定环境中正在运行中的API定义',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchApi'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SwitchApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB263467-7F5D-5A1B-88E8-06CB0228E0FE\\"\\n}","type":"json"}]',
],
'TagResources' => [
'summary' => '创建标签资源关系(用户标签)。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94494',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型定义,目前分组,插件,应用接入了标签,API相关操作基于分组的标签:'."\n"
.'- **apiGroup**'."\n"
.'- **plugin**'."\n"
.'- **app**'."\n"
.'- **api**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源的标签值。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env'],
'Value' => ['description' => '标签值。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => '\' \''],
],
'required' => false,
'description' => '',
],
'required' => true,
'example' => '2021022811',
'maxItems' => 10000,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID。'."\n"
."\n"
.'n的取值范围为`[1, 50]`',
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => true,
'example' => '285bb759342649a1b70c2093a772e087',
'maxItems' => 10000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
'description' => '',
],
],
],
'title' => '创建标签资源关系(用户标签)',
'description' => '- 所有的Tag应用于所有的ResoureId的列表,即ResourceId.N是作用于所有的键值对。'."\n"
.'- 对于Tag.N.Key及Tag.N.Value中相同的N是一对键值对。'."\n"
.'- 批量标记资源,接口同成功同失败。'."\n"
.'- 除必填参数,传入Tag.1.Value,则入参必须有Tag.1.Key,否则报InvalidParameter.TagKey。也就是指定某个Tag.N.Value对应N的Key必须存在,但是可以为空字符串。'."\n"
.'- 当传入资源及Tag key,如果自定义Tag已经存在则覆盖之前的Tag value。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#ResourceId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\r\\n","errorExample":""}]',
],
'UntagResources' => [
'summary' => '删除用户标签和资源的关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94496',
'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型定义,目前分组,插件,应用接入了标签,API相关操作基于分组的标签:'."\n"
.'- **apiGroup**'."\n"
.'- **plugin**'."\n"
.'- **app**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup'],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => '是否全部删除。只针对**TagKey.N**为空时有效。取值范围:'."\n"
.'- **true**'."\n"
.'- **false**:默认值', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID。'."\n"
."\n"
.'n的取值范围为`[1, 50]`',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => true,
'example' => '285bb759342649a1b70c2093a772e087',
'maxItems' => 10000,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键。'."\n"
."\n"
.'n 的取值范围为 `[1, 20]`',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'example' => 'env',
'maxItems' => 10000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\r\\n","errorExample":""}]',
'title' => '删除用户标签和资源的关系',
'description' => '- 批量取消标记资源,接口同成功同失败。'."\n"
.'- 当传入ResourceId列表,没有传入TagKeys,同时All = true时,删除资源下所有资源标签关系。存在没有标签的资源,则不处理同时返回成功。'."\n"
.'- 当传入的ResourceId列表,没有传入TagKeys,同时All = false时,不处理接口返回成功。'."\n"
.'- 当TagKeys有值的时候,All是true/false都没有关系,这个字段无效。'."\n"
.'- 当传入多个资源及多个键值时,删除资源中存在的指定标签,资源中不存在的标签不处理。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#ResourceId}'],
],
],
],
],
],
'UpdatePrivateDNS' => [
'summary' => '修改内网域名解析',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'IntranetDomain',
'in' => 'query',
'schema' => ['description' => '内网域名', 'type' => 'string', 'required' => true, 'example' => 'api.demo.com'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '内网域名解析的类型'."\n"
.'- VPC:针对VPC授权解析,仅支持绑定传统类型专享实例;'."\n"
.'- A:支持创建A记录,仅支持绑定VPC融合类型专享实例',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'],
'example' => 'A',
],
],
[
'name' => 'Records',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '解析记录列表,仅Type取值为A时支持配置',
'type' => 'array',
'items' => [
'description' => '解析记录',
'type' => 'object',
'properties' => [
'Record' => ['description' => '解析记录值', 'type' => 'string', 'required' => false, 'example' => '192.168.0.2'],
'Weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
'required' => false,
],
'required' => true,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改内网域名解析',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateDNS'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:UpdatePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]',
],
'ValidateVpcConnectivity' => [
'summary' => '测试API网关到指定VPC授权中指定实例的指定端口的网络连通性。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'VpcAccessId',
'in' => 'query',
'schema' => ['description' => 'Vpc授权ID', 'type' => 'string', 'required' => true, 'example' => '5f1b3216f9********e2c1297b6741dc'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'API网关实例ID', 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-72bc18******'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1'],
'Connected' => ['description' => 'API网关实例到指定VPC授权网络是否连通'."\n"
.'- **true**:网络连通'."\n"
.'- **false**:网络不连通', 'type' => 'boolean', 'example' => 'True'],
'IpType' => ['description' => '当VPC授权中实例ID填写为IP时,表示IP的实例类型'."\n"
.'- **ECS**:IP对应的实例为ECS'."\n"
.'- **SLB**:IP对应的实例为ECS'."\n"
.'- **INVALID**:IP对应的实例类型非法', 'type' => 'string', 'example' => 'ECS'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1\\",\\n \\"Connected\\": true,\\n \\"IpType\\": \\"ECS\\"\\n}","type":"json"}]',
'title' => 'VPC授权连通性测试',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateVpcConnectivity'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ValidateVpcConnectivity',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-northeast-1.aliyuncs.com', 'endpoint' => 'apigateway.ap-northeast-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => '韩国(首尔)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-northeast-2.aliyuncs.com', 'endpoint' => 'apigateway.ap-northeast-2.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-southeast-1.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-southeast-3.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-3.aliyuncs.com', 'vpc' => 'apigateway-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-southeast-5.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-5.aliyuncs.com', 'vpc' => 'apigateway-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾(马尼拉)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-southeast-6.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-6.aliyuncs.com', 'vpc' => 'apigateway-vpc.ap-southeast-6.aliyuncs.com'],
['regionId' => 'ap-southeast-7', 'regionName' => '泰国(曼谷)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.ap-southeast-7.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-7.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-beijing.aliyuncs.com', 'endpoint' => 'apigateway.cn-beijing.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-chengdu.aliyuncs.com', 'endpoint' => 'apigateway.cn-chengdu.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-guangzhou.aliyuncs.com', 'endpoint' => 'apigateway.cn-guangzhou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-hangzhou.aliyuncs.com', 'endpoint' => 'apigateway.cn-hangzhou.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-heyuan', 'regionName' => '华南2(河源)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-heyuan.aliyuncs.com', 'endpoint' => 'apigateway.cn-heyuan.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-hongkong.aliyuncs.com', 'endpoint' => 'apigateway.cn-hongkong.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-huhehaote.aliyuncs.com', 'endpoint' => 'apigateway.cn-huhehaote.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-qingdao.aliyuncs.com', 'endpoint' => 'apigateway.cn-qingdao.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-shanghai.aliyuncs.com', 'endpoint' => 'apigateway.cn-shanghai.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-shenzhen.aliyuncs.com', 'endpoint' => 'apigateway.cn-shenzhen.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'apigateway.cn-wulanchabu.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'apigateway.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'apigateway.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'apigateway.us-west-1.aliyuncs.com', 'endpoint' => 'apigateway.us-west-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'apigateway.us-east-1.aliyuncs.com', 'endpoint' => 'apigateway.us-east-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'apigateway.eu-west-1.aliyuncs.com', 'endpoint' => 'apigateway.eu-west-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'apigateway.eu-central-1.aliyuncs.com', 'endpoint' => 'apigateway.eu-central-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'apigateway.me-east-1.aliyuncs.com', 'endpoint' => 'apigateway.me-east-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'me-central-1', 'regionName' => '沙特(利雅得)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'apigateway.me-central-1.aliyuncs.com', 'endpoint' => 'apigateway.me-central-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.me-central-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-north-2-gov-1.aliyuncs.com'],
['regionId' => 'cn-heyuan-acdr-1', 'regionName' => '河源专属云汽车合规', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-heyuan-acdr-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'apigateway.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'apigateway.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-beijing-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'CertificateKeyNotMatch', 'message' => 'The certificate private key does not match the public key.', 'http_code' => null, 'description' => '证书密钥不匹配,证书的公钥和私钥不匹配。'],
['code' => 'CertificateNotMatch', 'message' => 'The domain does not match the one in the certificate.', 'http_code' => null, 'description' => '证书不匹配,指定域名与证书内域名不匹配。'],
['code' => 'ExceedLimit%s', 'message' => 'The specified %s count exceeds the limit.', 'http_code' => null, 'description' => '超出个数限制,一般指用户账户下创建的 API、API 分组或者APP超出个数限制。'],
['code' => 'PrivateKeyEncrypted', 'message' => 'The certificate private key is encrypted, please upload the unencrypted version.', 'http_code' => null, 'description' => '密钥不能加密,证书私钥加密了,要求上传不加密的版本。'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuthorizedApps'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroups'],
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlugins'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogConfig'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApisAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatasetItem'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiConfiguration'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApiProductsAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceVpcAttributeForConsole'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSystemParameters'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrivateDNS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceNewConnections'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIntranetDomainPolicy'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateVpcInfoTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthToApiProduct'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachPlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackendModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeployApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginTemplates'],
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackendModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAbolishApiTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachApiProduct'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetItem'],
['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppsByApiProduct'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackend'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceSpec'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAbolishApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistories'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTrafficControlApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAllTrafficSpecialControl'],
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlLists'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbolishApi'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControlPolicyItem'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAttribute'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrafficControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainCertificate'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyVpcAccessAndUpdateApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeModels'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessControlList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficData'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'],
['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppCode'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiStageVariable'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySignature'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceLatency'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginGroups'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiQpsData'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceHttpCode'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppSecurity'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiProduct'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DryRunSwagger'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyLogConfig'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByIpControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByBackend'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisBySignature'],
['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInstanceAccessControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApisAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVpcAccess'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachPlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessControlList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignaturesByApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachGroupPlugin'],
['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppSecret'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTrafficSpecialControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployApi'],
['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainWebSocketStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropConnections'],
['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInstanceAccessControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppCode'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppKey'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficControls'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSignatureApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductsByApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlPolicyItem'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceTraffic'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceQps'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupQps'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDataset'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiStageVariable'],
['threshold' => '2', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CreateMonitorGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiMarketAttributes'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackend'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiSignatures'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControlPolicyItems'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportOAS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomain'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateInstanceWithPrivateDNS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeImportOASTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWildcardDomainPatterns'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateDNS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivateDNS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackend'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApiProductsAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControls'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomain'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIpControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiLatencyData'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupLatency'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRequestLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistory'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficSpecialControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSummaryData'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateVpcConnectivity'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachGroupPlugin'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupVpcWhitelist'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiGroup'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroups'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlListAttribute'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachApiProduct'],
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateInstanceWithPrivateDNS'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropPacket'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetIpControlApis'],
['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppAttributes'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupTraffic'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployApiTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAccessControlListEntry'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendList'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiDoc'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomainCertificate'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignatures'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppCode'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstancePackets'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByTrafficControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccess'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControl'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApps'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetItem'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSignatureApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIpControlPolicyItem'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDomain'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrivateDNS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControls'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportSwagger'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByAppForRegion'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppSecurities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppKey'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiIpControls'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateBackendTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAccessControlListEntry'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisWithStageNameIntegratedByApp'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMarketRemainsQuota'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIpControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginSchemas'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByVpcAccess'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccessAndAbolishApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupNetworkPolicy'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroupVpcWhitelist'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemInfo'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccessControlListAttribute'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControlsByApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApis'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportOAS'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAppsAuthorities'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogConfig'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReactivateDomain'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuthorizedApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTrafficControl'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLogConfig'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackendModel'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTrafficControlApis'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenApiGatewayService'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchApi'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVpcAccesses'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSlbConnect'],
],
'product' => ['code' => 'apigateway', 'title' => 'API 网关'],
],
'ram' => [
'productCode' => 'ApiGateway',
'productName' => 'API 网关',
'ramCodes' => ['apigateway', 'cloudapi'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeIpControls',
'description' => '查询IP访问控制列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeIpControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'],
],
],
],
[
'apiName' => 'DescribeAppsByApiProduct',
'description' => '根据API产品查询授权了的APP列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppsByApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiProductsByApp',
'description' => '根据APP查询有权限的API产品列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiProductsByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDatasetItem',
'description' => '修改数据集条目',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'DeleteApi',
'description' => '删除 API 定义',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ResetAppCode',
'description' => '重置应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ResetAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApp',
'description' => '查询可授权 APP 列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'ModifyIntranetDomainPolicy',
'description' => '修改分组内网VPC域名策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIntranetDomainPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeBackendInfo',
'description' => '查询后端服务的信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeBackendInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSignatures',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSignatures',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:secretkey/*'],
],
],
],
[
'apiName' => 'SetVpcAccess',
'description' => '添加 VPC 授权',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/*'],
],
],
],
[
'apiName' => 'CreateModel',
'description' => '创建模型',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteDomainCertificate',
'description' => '删除域名的SSL证书',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDomainCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribePluginGroups',
'description' => '查询插件绑定的分组列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'AddIpControlPolicyItem',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AddIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
[
'apiName' => 'OpenApiGatewayService',
'description' => '开通服务',
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:OpenApiGatewayService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBackendList',
'description' => '查询后端服务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeBackendList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/*'],
],
],
],
[
'apiName' => 'DescribeAccessControlListAttribute',
'description' => '查看访问控制策略详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAccessControlListAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetIpControlApis',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetIpControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDatasetItem',
'description' => '创建数据集条目',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'DescribeVpcAccesses',
'description' => '查询授权的VPC列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeVpcAccesses',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'],
],
],
],
[
'apiName' => 'ModifyInstanceAttribute',
'description' => '修改指定实例的信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DescribeApisWithStageNameIntegratedByApp',
'description' => '根据应用查询API列表,返回环境聚合的结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisWithStageNameIntegratedByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetAppsAuthorities',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetAppsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}'],
],
],
],
[
'apiName' => 'DescribePluginsByApi',
'description' => '查询API上绑定的插件',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginsByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddAccessControlListEntry',
'description' => '添加IP条目',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AddAccessControlListEntry',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
[
'apiName' => 'DescribePluginsByGroup',
'description' => '查询API分组绑定的插件',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginsByGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDeployApiTask',
'description' => '查询发布API任务进度',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployApiTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableInstanceAccessControl',
'description' => '关闭实例上的访问控制',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DisableInstanceAccessControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
[
'apiName' => 'SetDomain',
'description' => '给指定分组绑定自定义域名',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeInstanceHttpCode',
'description' => '获取实例HTTP代码',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceHttpCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ValidateVpcConnectivity',
'description' => 'VPC授权连通性测试',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ValidateVpcConnectivity',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyIpControlPolicyItem',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
[
'apiName' => 'ModifyVpcAccessAndUpdateApis',
'description' => '修改VPC授权信息,并且更新关联的API的元信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyVpcAccessAndUpdateApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAuthorizedApps',
'description' => '查询可访问APP列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAuthorizedApps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeImportOASTask',
'description' => '查询OAS导入API的任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeImportOASTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetachApiProduct',
'description' => '解除API与API产品的绑定关系',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DetachApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyApp',
'description' => '修改APP应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'ModifyApiGroupNetworkPolicy',
'description' => '修改api分组的网络策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupNetworkPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'AttachPlugin',
'description' => '绑定插件到API上',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AttachPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'DescribeInstances',
'description' => '查询实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'DescribeIpControlPolicyItems',
'description' => '查询IP访问控制策略列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeIpControlPolicyItems',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
[
'apiName' => 'EnableInstanceAccessControl',
'description' => '设置实例上的访问控制',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:EnableInstanceAccessControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
[
'apiName' => 'DescribeUpdateVpcInfoTask',
'description' => '查询VPC授权更新状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeUpdateVpcInfoTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ImportSwagger',
'description' => '通过 Swagger 创建 API',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:ImportSwagger',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ModifyDataset',
'description' => '修改数据集',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'DeployApi',
'description' => '发布 API',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DeployApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteAppKey',
'description' => '删除App的AppKey和AppSecret',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAppKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DescribeSummaryData',
'description' => '获取摘要数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSummaryData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAccessControlList',
'description' => '删除访问控制策略',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAccessControlList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDomainCertificate',
'description' => '为自定义域名添加SSL证书',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomainCertificate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteSignature',
'description' => '删除后端签名密钥',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteSignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetachGroupPlugin',
'description' => '解绑分组上绑定的插件',
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:DetachGroupPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'DeleteIpControl',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
[
'apiName' => 'ModifyApiConfiguration',
'description' => '修改API定义',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiDoc',
'description' => '查询API说明文档',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiDoc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeInstancePackets',
'description' => '获取实例的数据包数',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstancePackets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'SwitchApi',
'description' => '切换指定环境中正在运行中的API定义',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SwitchApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeStageModels',
'description' => '查询环境配置列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:DescribeStageModels',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetTrafficControlApis',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetTrafficControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeAppSecurity',
'description' => '查询指定 APP 的密钥信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppSecurity',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'CreateApi',
'description' => '创建 API',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SetAccessControlListAttribute',
'description' => '修改访问控制策略名称',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetAccessControlListAttribute',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
[
'apiName' => 'DescribeAbolishApiTask',
'description' => '查询API下线任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAbolishApiTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceSlbConnect',
'description' => '获取实例的Slb链接',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceSlbConnect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DescribeAuthorizedApis',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAuthorizedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DeleteMonitorGroup',
'description' => '删除监控分组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteMonitorGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeAppSecurities',
'description' => '查询App的密钥信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppSecurities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DescribeDatasetItemList',
'description' => '查询数据集条目列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetItemList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'SetDomainWebSocketStatus',
'description' => '设置域名WebSocket状态',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetDomainWebSocketStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApiLatencyData',
'description' => '查询API监控数据中对响应时间统计数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiLatencyData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeInstanceDropPacket',
'description' => '获取实例丢弃的数据数',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceDropPacket',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'CreateLogConfig',
'description' => '创建日志配置',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteApiGroup',
'description' => '删除 API 分组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteTrafficControl',
'description' => '删除指定的用户自定义流控策略',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
[
'apiName' => 'ModifyApiGroup',
'description' => '修改API分组的信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateBackend',
'description' => '创建后端服务',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteStageModel',
'description' => '删除环境配置',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteStageModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateIpControl',
'description' => '新增IP访问控制',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'],
],
],
],
[
'apiName' => 'DescribeAppAttributes',
'description' => '查询APP列表信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAppAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
[
'apiName' => 'DeleteInstance',
'description' => '删除实例',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ModifyTrafficControl',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
[
'apiName' => 'DescribeApiGroups',
'description' => '查询 API 分组列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
[
'apiName' => 'DescribeHistoryApis',
'description' => '查询API发布版本定义列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeHistoryApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeDatasetInfo',
'description' => '查询数据集信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '创建标签资源关系(用户标签)',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#ResourceId}'],
],
],
],
[
'apiName' => 'DescribePurchasedApis',
'description' => '获取购买的 API 列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeInstanceLatency',
'description' => '获取实例时延',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceLatency',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ModifyIpControl',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceTraffic',
'description' => '查询指定实例流量信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceTraffic',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DescribePurchasedApiGroups',
'description' => '获取购买的API分组列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApiGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
[
'apiName' => 'DescribeApps',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
[
'apiName' => 'DescribeApisBySignature',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisBySignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePrivateDNS',
'description' => '创建内网域名解析',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreatePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceNewConnections',
'description' => '查询实例的新连接数',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceNewConnections',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ModifySignature',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifySignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceQps',
'description' => '查询实例的QPS数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceQps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DescribeDeployedApi',
'description' => '查询API在指定环境中的定义',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployedApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SdkGenerateByAppForRegion',
'description' => '按应用生成SDK',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByAppForRegion',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DeleteApiProduct',
'description' => '删除API产品',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstanceSpec',
'description' => '网关实例变配',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceSpec',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAllTrafficSpecialControl',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAllTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribePlugins',
'description' => '查询插件列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePlugins',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'],
],
],
],
[
'apiName' => 'DescribeDatasetItemInfo',
'description' => '查询数据集条目信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetItemInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'RemoveIpControlPolicyItem',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveIpControlPolicyItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
],
],
],
[
'apiName' => 'DescribeApiTrafficControls',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiTrafficControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SetAppsAuthToApiProduct',
'description' => '批量授权多个APP给指定API产品',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SetAppsAuthToApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apiproduct/{#ApiProductId}'],
],
],
],
[
'apiName' => 'DescribePurchasedApiGroup',
'description' => '获取购买的 API 组',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePurchasedApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ExportOAS',
'description' => '导出OAS定义',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ExportOAS',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApi',
'description' => '查询 API 定义',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApisByBackend',
'description' => '根据后端查询 API 列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'DescribePluginSchemas',
'description' => '描述插件模式',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginSchemas',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveApiProductsAuthorities',
'description' => '批量移除API产品对指定APP的授权',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveApiProductsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DryRunSwagger',
'description' => '预检查swagger',
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:DryRunSwagger',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '用户查询标签接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
],
],
],
[
'apiName' => 'DeleteAppCode',
'description' => '删除App的AppCode',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'ImportOAS',
'description' => '通过OAS导入API',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:ImportOAS',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribePluginTemplates',
'description' => '获取插件模板列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyModel',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteBackendModel',
'description' => '删除后端模型',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'SdkGenerateByGroup',
'description' => '按分组生成SDK',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'BatchDeployApis',
'description' => '批量发布API',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:BatchDeployApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiSignatures',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiSignatures',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DissociateInstanceWithPrivateDNS',
'description' => '解除内网域名解析和专享实例的关联',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DissociateInstanceWithPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAppCode',
'description' => 'App添加AppCode',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAppCode',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DescribeApiGroup',
'description' => '查询 API 分组详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeTrafficControlsByApi',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeTrafficControlsByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'RemoveVpcAccess',
'description' => '撤销 VPC 授权',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSystemParameters',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSystemParameters',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDataset',
'description' => '删除数据集',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'DescribeUpdateBackendTask',
'description' => '查询后端服务更新任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeUpdateBackendTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiHistory',
'description' => '查询历史版本详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SdkGenerateByApp',
'description' => '按应用生成SDK',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SdkGenerateByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateStageModel',
'description' => '创建环境配置',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateStageModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveApisAuthorities',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveApisAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateSignature',
'description' => '创建签名密钥',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateSignature',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiQpsData',
'description' => '查询API监控数据中对QPS的统计数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiQpsData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApiProductApis',
'description' => '查询API产品绑定的API列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiProductApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceClusterList',
'description' => '查询专享实例集群',
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceClusterList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyBackend',
'description' => '修改后端服务',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'DescribeApisByApp',
'description' => '根据应用查询API列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DescribeMarketRemainsQuota',
'description' => '描述剩余配额',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeMarketRemainsQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AssociateInstanceWithPrivateDNS',
'description' => '关联内网域名解析到专享实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AssociateInstanceWithPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAccessControlLists',
'description' => '查询访问控制策略列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeAccessControlLists',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyApi',
'description' => '修改API定义',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApiHistories',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiHistories',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteApp',
'description' => '删除应用',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'SetWildcardDomainPatterns',
'description' => '设置通配符域名模式',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetWildcardDomainPatterns',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SetSignatureApis',
'description' => '绑定签名密钥与API',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetSignatureApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateAccessControlList',
'description' => '创建访问控制策略',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAccessControlList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAppKey',
'description' => 'App添加AppKey和AppSecret',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateAppKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
],
],
],
[
'apiName' => 'DeletePlugin',
'description' => '删除插件',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeletePlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'ResetAppSecret',
'description' => '重置 app 密钥',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ResetAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBackendModel',
'description' => '创建后端模型',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'DescribeApisByVpcAccess',
'description' => '通过Vpc授权信息查询绑定该VPC授权的API信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:DescribeApisByVpcAccess',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'VpcAccess', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'],
],
],
],
[
'apiName' => 'DescribeApiTrafficData',
'description' => '查询API监控数据中流量统计数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiTrafficData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ListPrivateDNS',
'description' => '查询内网域名解析',
'operationType' => 'list',
'ramAction' => [
'action' => 'apigateway:ListPrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddTrafficSpecialControl',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AddTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
[
'apiName' => 'DescribeDeployedApis',
'description' => '查询已发布 API 列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDeployedApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateApp',
'description' => '创建APP',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApp',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
],
],
],
[
'apiName' => 'DeleteTrafficSpecialControl',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteTrafficSpecialControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePlugin',
'description' => '创建API网关插件',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreatePlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'],
],
],
],
[
'apiName' => 'ModifyStageModel',
'description' => '修改环境配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyStageModel',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceDropConnections',
'description' => '获取实例的丢失链接',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceDropConnections',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'RemoveAppsAuthorities',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveAppsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}'],
],
],
],
[
'apiName' => 'RemoveIpControlApis',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveIpControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyApiGroupInstance',
'description' => '修改api分组所属的实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeApisByIpControl',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByIpControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceClusterInfo',
'description' => '查询专享实例集群信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeInstanceClusterInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePrivateDNS',
'description' => '删除内网域名解析',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeletePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDomain',
'description' => '查询自定义域名详情信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ReactivateDomain',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ReactivateDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'AbolishApi',
'description' => '下线 API',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:AbolishApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateDataset',
'description' => '创建数据集',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateDataset',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/*'],
],
],
],
[
'apiName' => 'BatchAbolishApis',
'description' => '批量下线API',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:BatchAbolishApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDatasetList',
'description' => '查询数据集列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeDatasetList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/*'],
],
],
],
[
'apiName' => 'RemoveTrafficControlApis',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveTrafficControlApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdatePrivateDNS',
'description' => '修改内网域名解析',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:UpdatePrivateDNS',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGroupLatency',
'description' => '查询分组的平均延迟',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupLatency',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'QueryRequestLogs',
'description' => '获取请求日志',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:QueryRequestLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDatasetItem',
'description' => '删除数据集条目',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDatasetItem',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
],
],
],
[
'apiName' => 'DescribeLogConfig',
'description' => '获取日志配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/{#LogType}'],
],
],
],
[
'apiName' => 'ModifyPlugin',
'description' => '修改插件',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'DescribeApis',
'description' => '查询定义中的 API 列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateMonitorGroup',
'description' => '创建监控报警分组',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateMonitorGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribePluginApis',
'description' => '查询插件绑定的API列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribePluginApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'CreateApiGroup',
'description' => '创建API分组',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApiGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
],
],
],
[
'apiName' => 'DeleteBackend',
'description' => '删除后端服务',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteBackend',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'ModifyLogConfig',
'description' => '修改日志配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateApiStageVariable',
'description' => '创建环境变量',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateApiStageVariable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteLogConfig',
'description' => '删除日志配置',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/{#LogType}'],
],
],
],
[
'apiName' => 'DescribeSignaturesByApi',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeSignaturesByApi',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApiMarketAttributes',
'description' => '获取API的属性',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiMarketAttributes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'AttachGroupPlugin',
'description' => '绑定插件到分组上',
'operationType' => 'none',
'ramAction' => [
'action' => 'apigateway:AttachGroupPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'CreateTrafficControl',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/*'],
],
],
],
[
'apiName' => 'RemoveVpcAccessAndAbolishApis',
'description' => '删除VPC授权',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveVpcAccessAndAbolishApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetApiProductsAuthorities',
'description' => '批量授权API产品给指定APP',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:SetApiProductsAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeApisByTrafficControl',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApisByTrafficControl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDomain',
'description' => '删除域名',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteModel',
'description' => '删除已有模型',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'SetApisAuthorities',
'description' => '给多个API添加APP访问权限',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:SetApisAuthorities',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ModifyApiGroupVpcWhitelist',
'description' => '修改API分组VPC白名单',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyApiGroupVpcWhitelist',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DeleteApiStageVariable',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:DeleteApiStageVariable',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateInstance',
'description' => '创建实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'DescribeApiGroupVpcWhitelist',
'description' => '查询分组VPC白名单',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiGroupVpcWhitelist',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeTrafficControls',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeTrafficControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
],
],
],
[
'apiName' => 'DescribeApiIpControls',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeApiIpControls',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'DescribeGroupTraffic',
'description' => '查询分组流量',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupTraffic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AttachApiProduct',
'description' => '将API绑定到指定API产品',
'operationType' => 'create',
'ramAction' => [
'action' => 'apigateway:AttachApiProduct',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetachPlugin',
'description' => '解绑API绑定的插件',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:DetachPlugin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
],
],
],
[
'apiName' => 'DescribeModels',
'description' => '获取已创建的模型',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeModels',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'RemoveAccessControlListEntry',
'description' => '删除IP条目',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:RemoveAccessControlListEntry',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
],
],
],
[
'apiName' => 'ModifyInstanceVpcAttributeForConsole',
'description' => '修改实例的客户端所在VPC',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyInstanceVpcAttributeForConsole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGroupQps',
'description' => '查询指定分组的 QPS 数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'apigateway:DescribeGroupQps',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
],
],
],
[
'apiName' => 'ModifyBackendModel',
'description' => '修改后端模型',
'operationType' => 'update',
'ramAction' => [
'action' => 'apigateway:ModifyBackendModel',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
],
],
],
[
'apiName' => 'RemoveSignatureApis',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'apigateway:RemoveSignatureApis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'],
['validationType' => 'always', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'],
['validationType' => 'always', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'],
['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'],
['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'],
['validationType' => 'always', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:secretkey/*'],
['validationType' => 'always', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/*'],
['validationType' => 'always', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'],
['validationType' => 'always', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'],
['validationType' => 'always', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/*'],
['validationType' => 'always', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'],
['validationType' => 'always', 'resourceType' => 'AccessControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrol/{#AclId}'],
['validationType' => 'always', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppIds}'],
['validationType' => 'always', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'],
['validationType' => 'always', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#ResourceId}'],
['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#ResourceId}'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'],
['validationType' => 'always', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'],
['validationType' => 'always', 'resourceType' => 'AccessControl', 'arn' => 'acs:cloudapi:{#regionId}:{#accountId}:accesscontrol/{#AclId}'],
['validationType' => 'always', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:signature/{#SignatureId}'],
['validationType' => 'always', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/*'],
['validationType' => 'always', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'],
['validationType' => 'always', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apiproduct/{#ApiProductId}'],
['validationType' => 'always', 'resourceType' => 'Backend', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}'],
['validationType' => 'always', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:signature/*'],
['validationType' => 'always', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/*'],
['validationType' => 'always', 'resourceType' => 'AccessControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrol/*'],
['validationType' => 'always', 'resourceType' => 'VpcAccess', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'],
['validationType' => 'always', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/*'],
['validationType' => 'always', 'resourceType' => 'LogConfig', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:logconfig/{#LogType}'],
['validationType' => 'always', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/*'],
],
],
];