diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/cloudapi/2016-07-14/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/cloudapi/2016-07-14/api-docs.php')
| -rw-r--r-- | data/en_us/cloudapi/2016-07-14/api-docs.php | 43048 |
1 files changed, 19578 insertions, 23470 deletions
diff --git a/data/en_us/cloudapi/2016-07-14/api-docs.php b/data/en_us/cloudapi/2016-07-14/api-docs.php index 5465f72..700c0c0 100644 --- a/data/en_us/cloudapi/2016-07-14/api-docs.php +++ b/data/en_us/cloudapi/2016-07-14/api-docs.php @@ -1,557 +1,444 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CloudAPI', - 'version' => '2016-07-14', - ], + 'info' => ['style' => 'RPC', 'product' => 'CloudAPI', 'version' => '2016-07-14'], 'directories' => [ [ - 'id' => 198578, - 'title' => 'Intranet domain name resolution', + 'children' => ['ListPrivateDNS'], 'type' => 'directory', - 'children' => [ - 'DissociateInstanceWithPrivateDNS', - 'DeletePrivateDNS', - 'AssociateInstanceWithPrivateDNS', - 'CreatePrivateDNS', - 'ListPrivateDNS', - 'UpdatePrivateDNS', - ], + 'title' => 'Private domain resolution', ], [ - 'id' => 141706, - 'title' => 'Instances', + 'children' => ['ModifyInstanceVpcAttributeForConsole', 'EnableInstanceAccessControl', 'DisableInstanceAccessControl'], 'type' => 'directory', - 'children' => [ - 'ModifyInstanceVpcAttributeForConsole', - 'CreateInstance', - 'DeleteInstance', - 'ModifyInstanceAttribute', - 'ModifyInstanceSpec', - 'EnableInstanceAccessControl', - 'DisableInstanceAccessControl', - 'DescribeInstances', - ], + 'title' => 'Instances', ], [ - 'id' => 141711, - 'title' => 'API groups', + 'children' => ['ModifyIntranetDomainPolicy', 'CreateApiGroup', 'DeleteApiGroup', 'ModifyApiGroup', 'DescribeApiGroup', 'DescribePurchasedApiGroup'], 'type' => 'directory', - 'children' => [ - 'ModifyIntranetDomainPolicy', - 'CreateApiGroup', - 'DeleteApiGroup', - 'ModifyApiGroup', - 'DescribeApiGroup', - 'DescribeApiGroups', - 'DescribePurchasedApiGroup', - 'DescribePurchasedApiGroups', - ], + 'title' => 'Groups', ], [ - 'id' => 141719, - 'title' => 'Domains', + 'children' => ['DeleteDomainCertificate', 'SetDomain', 'SetDomainCertificate', 'SetDomainWebSocketStatus', 'SetWildcardDomainPatterns', 'DescribeDomain', 'ReactivateDomain'], 'type' => 'directory', - 'children' => [ - 'DeleteDomain', - 'DeleteDomainCertificate', - 'SetDomain', - 'SetDomainCertificate', - 'SetDomainWebSocketStatus', - 'SetWildcardDomainPatterns', - 'DescribeDomain', - 'ReactivateDomain', - ], + 'title' => 'Domains', ], [ - 'id' => 141728, - 'title' => 'Monitor', + 'children' => ['CreateMonitorGroup', 'DeleteMonitorGroup', 'DescribeApiLatencyData', 'DescribeApiQpsData', 'DescribeApiTrafficControls', 'DescribeApiTrafficData', 'DescribeInstanceDropPacket', 'DescribeInstanceDropConnections', 'DescribeInstanceHttpCode', 'DescribeInstanceLatency', 'DescribeInstanceNewConnections', 'DescribeInstancePackets', 'DescribeInstanceQps', 'DescribeInstanceSlbConnect', 'DescribeInstanceTraffic', 'DescribeGroupQps'], 'type' => 'directory', - 'children' => [ - 'CreateMonitorGroup', - 'DeleteMonitorGroup', - 'DescribeApiLatencyData', - 'DescribeApiQpsData', - 'DescribeApiTrafficControls', - 'DescribeApiTrafficData', - 'DescribeInstanceDropPacket', - 'DescribeInstanceDropConnections', - 'DescribeInstanceHttpCode', - 'DescribeInstanceLatency', - 'DescribeInstanceNewConnections', - 'DescribeInstancePackets', - 'DescribeInstanceQps', - 'DescribeInstanceSlbConnect', - 'DescribeInstanceTraffic', - 'DescribeGroupQps', - ], + 'title' => 'Monitoring', ], [ - 'id' => 141735, - 'title' => 'API management', - 'type' => 'directory', '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', + 'CreateApi', 'CreateApiStageVariable', 'ImportOAS', 'ImportSwagger', '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', ], - ], - [ - 'id' => 141764, - 'title' => 'Applications', 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'DeleteApp', - 'ModifyApp', - 'DescribeApps', - 'DescribeAppAttributes', - 'DescribeAuthorizedApps', - 'DescribeApp', - 'DescribeAppSecurity', - 'ResetAppCode', - ], + 'title' => 'API management', ], [ - 'id' => 141774, - 'title' => 'VPC', + 'children' => ['DeleteApp', 'DescribeAppAttributes', 'DescribeAuthorizedApps', 'DescribeApp', 'DescribeAppSecurity', 'ResetAppCode'], 'type' => 'directory', - 'children' => [ - 'RemoveVpcAccess', - 'RemoveVpcAccessAndAbolishApis', - 'ModifyVpcAccessAndUpdateApis', - 'ModifyApiGroupVpcWhitelist', - 'SetVpcAccess', - 'DescribeApiGroupVpcWhitelist', - 'DescribeVpcAccesses', - 'DescribeUpdateVpcInfoTask', - 'ValidateVpcConnectivity', - ], + 'title' => 'Applications', ], [ - 'id' => 168793, - 'title' => 'Access control', + 'children' => ['RemoveVpcAccess', 'RemoveVpcAccessAndAbolishApis', 'ModifyVpcAccessAndUpdateApis', 'SetVpcAccess', 'DescribeApiGroupVpcWhitelist', 'DescribeVpcAccesses', 'DescribeUpdateVpcInfoTask'], 'type' => 'directory', - 'children' => [ - 'CreateAccessControlList', - 'DeleteAccessControlList', - 'SetAccessControlListAttribute', - 'AddAccessControlListEntry', - 'RemoveAccessControlListEntry', - 'DescribeAccessControlListAttribute', - 'DescribeAccessControlLists', - ], + 'title' => 'Virtual private clouds', ], [ - 'id' => 141782, - 'title' => 'Plugins', + 'children' => ['CreateAccessControlList', 'DeleteAccessControlList', 'SetAccessControlListAttribute', 'AddAccessControlListEntry', 'RemoveAccessControlListEntry', 'DescribeAccessControlListAttribute', 'DescribeAccessControlLists'], 'type' => 'directory', - 'children' => [ - 'DetachGroupPlugin', - 'AttachGroupPlugin', - 'DescribePluginsByGroup', - 'DescribePluginGroups', - 'CreatePlugin', - 'DeletePlugin', - 'AttachPlugin', - 'ModifyPlugin', - 'DetachPlugin', - 'DescribePluginApis', - 'DescribePluginsByApi', - 'DescribePluginSchemas', - 'DescribePluginTemplates', - 'DescribePlugins', - ], + 'title' => 'Access control policies', ], [ - 'id' => 172506, - 'title' => 'Custom datasets', + 'children' => ['DetachGroupPlugin', 'AttachGroupPlugin', 'DescribePluginsByGroup', 'DescribePluginGroups', 'CreatePlugin', 'DeletePlugin', 'AttachPlugin', 'ModifyPlugin', 'DetachPlugin', 'DescribePluginApis', 'DescribePluginsByApi', 'DescribePluginSchemas', 'DescribePluginTemplates', 'DescribePlugins'], 'type' => 'directory', - 'children' => [ - 'CreateDataset', - 'CreateDatasetItem', - 'DeleteDataset', - 'DeleteDatasetItem', - 'ModifyDataset', - 'ModifyDatasetItem', - 'DescribeDatasetInfo', - 'DescribeDatasetList', - 'DescribeDatasetItemInfo', - 'DescribeDatasetItemList', - ], + 'title' => 'Plugins', ], [ - 'id' => 141804, - 'title' => 'Models', + 'children' => ['CreateDatasetItem', 'DeleteDatasetItem', 'ModifyDataset', 'ModifyDatasetItem', 'DescribeDatasetInfo', 'DescribeDatasetList', 'DescribeDatasetItemInfo', 'DescribeDatasetItemList'], 'type' => 'directory', - 'children' => [ - 'CreateModel', - 'DeleteModel', - 'ModifyModel', - 'DescribeModels', - ], + 'title' => 'Custom datasets', ], [ - 'id' => 141809, - 'title' => 'Authorization', + 'children' => ['DescribeModels'], 'type' => 'directory', - 'children' => [ - 'SetApisAuthorities', - 'SetAppsAuthorities', - 'RemoveApisAuthorities', - 'RemoveAppsAuthorities', - 'ResetAppSecret', - ], + 'title' => 'Models', ], [ - 'id' => 141815, - 'title' => 'Tags', + 'children' => ['SetApisAuthorities', 'SetAppsAuthorities', 'RemoveApisAuthorities', 'RemoveAppsAuthorities', 'ResetAppSecret'], 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Permissions', ], [ - 'id' => 141819, - 'title' => 'Service', + 'children' => ['DescribeSummaryData', 'DescribeSystemParameters', 'OpenApiGatewayService'], 'type' => 'directory', - 'children' => [ - 'DescribeSummaryData', - 'DescribeRegions', - 'DescribeSystemParameters', - 'DescribeZones', - 'OpenApiGatewayService', - ], + 'title' => 'Services', ], [ - 'id' => 141824, - 'title' => 'Logs', + 'children' => ['CreateLogConfig', 'DeleteLogConfig', 'ModifyLogConfig', 'QueryRequestLogs', 'DescribeLogConfig'], 'type' => 'directory', - 'children' => [ - 'CreateLogConfig', - 'DeleteLogConfig', - 'ModifyLogConfig', - 'QueryRequestLogs', - 'DescribeLogConfig', - ], + 'title' => 'Logs', ], [ - 'id' => 141841, - 'title' => 'SDK', + 'children' => ['SdkGenerateByAppForRegion', 'SdkGenerateByApp', 'SdkGenerateByGroup'], 'type' => 'directory', - 'children' => [ - 'SdkGenerateByAppForRegion', - 'SdkGenerateByApp', - 'SdkGenerateByGroup', - ], + 'title' => 'SDK', ], [ - 'id' => 141854, - 'title' => 'Backends', + 'children' => ['CreateBackend', 'DeleteBackend', 'ModifyBackend', 'DescribeBackendList', 'DescribeBackendInfo', 'DescribeUpdateBackendTask'], 'type' => 'directory', - 'children' => [ - 'CreateBackend', - 'DeleteBackend', - 'ModifyBackend', - 'DescribeBackendList', - 'DescribeBackendInfo', - 'DescribeUpdateBackendTask', - ], + 'title' => 'Backends', ], [ - 'id' => 141861, - 'title' => 'Backend models', + 'children' => ['CreateBackendModel', 'DeleteBackendModel', 'ModifyBackendModel'], 'type' => 'directory', - 'children' => [ - 'CreateBackendModel', - 'DeleteBackendModel', - 'ModifyBackendModel', - ], + 'title' => 'Backend models', ], [ - 'id' => 141844, - 'title' => 'Signature plugin(Classic network instances)', + 'children' => ['CreateSignature', 'ModifySignature', 'SetSignatureApis', 'DescribeSignatures', 'DescribeApisBySignature', 'DescribeApiSignatures', 'DescribeSignaturesByApi', 'RemoveSignatureApis'], 'type' => 'directory', - 'children' => [ - 'CreateSignature', - 'DeleteSignature', - 'ModifySignature', - 'SetSignatureApis', - 'DescribeSignatures', - 'DescribeApisBySignature', - 'DescribeApiSignatures', - 'DescribeSignaturesByApi', - 'RemoveSignatureApis', - ], + 'title' => 'Signature plugins (classic network instances)', ], [ - 'id' => 141829, - 'title' => 'Traffic control plugin(Classic network instances)', + 'children' => ['AddTrafficSpecialControl', 'CreateTrafficControl', 'DeleteAllTrafficSpecialControl', 'DeleteTrafficSpecialControl', 'ModifyTrafficControl', 'SetTrafficControlApis', 'DescribeTrafficControls', 'DescribeTrafficControlsByApi', 'DescribeApisByTrafficControl', 'RemoveTrafficControlApis'], 'type' => 'directory', - 'children' => [ - 'AddTrafficSpecialControl', - 'CreateTrafficControl', - 'DeleteAllTrafficSpecialControl', - 'DeleteTrafficControl', - 'DeleteTrafficSpecialControl', - 'ModifyTrafficControl', - 'SetTrafficControlApis', - 'DescribeTrafficControls', - 'DescribeTrafficControlsByApi', - 'DescribeApisByTrafficControl', - 'RemoveTrafficControlApis', - ], + 'title' => 'Throttling plugins (classic network instances)', ], [ - 'id' => 141791, - 'title' => 'Access control plugin(Classic network instances)', + 'children' => ['AddIpControlPolicyItem', 'CreateIpControl', 'DeleteIpControl', 'ModifyIpControl', 'ModifyIpControlPolicyItem', 'SetIpControlApis', 'DescribeApiIpControls', 'DescribeIpControlPolicyItems', 'DescribeIpControls', 'DescribeApisByIpControl', 'RemoveIpControlApis', 'RemoveIpControlPolicyItem'], 'type' => 'directory', - 'children' => [ - 'AddIpControlPolicyItem', - 'CreateIpControl', - 'DeleteIpControl', - 'ModifyIpControl', - 'ModifyIpControlPolicyItem', - 'SetIpControlApis', - 'DescribeApiIpControls', - 'DescribeIpControlPolicyItems', - 'DescribeIpControls', - 'DescribeApisByIpControl', - 'RemoveIpControlApis', - 'RemoveIpControlPolicyItem', - ], + 'title' => 'Access control plugins (classic network instances)', ], [ - 'id' => 186390, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'DescribeApisWithStageNameIntegratedByApp', - 'DescribeGroupLatency', - 'DescribeGroupTraffic', - 'ModifyApiGroupInstance', - 'ModifyApiGroupNetworkPolicy', - 'DetachApiProduct', - 'SetApiProductsAuthorities', - 'DescribeApiProductsByApp', - 'DescribeApiProductApis', - 'DescribeAppsByApiProduct', - 'AttachApiProduct', - 'DeleteApiProduct', - 'RemoveApiProductsAuthorities', - 'SetAppsAuthToApiProduct', - 'DescribeApisByVpcAccess', - 'DeleteAppCode', - 'DeleteAppKey', - 'CreateAppCode', - 'CreateAppKey', - 'DescribeInstanceClusterInfo', - 'DescribeInstanceClusterList', - 'DescribeAppSecurities', - 'ExportOAS', + 'DescribeApisWithStageNameIntegratedByApp', 'DescribeGroupLatency', 'DescribeGroupTraffic', 'ModifyApiGroupInstance', 'ModifyApiGroupNetworkPolicy', 'DetachApiProduct', 'SetApiProductsAuthorities', 'DescribeApiProductsByApp', 'DescribeApiProductApis', 'DescribeAppsByApiProduct', 'RemoveApiProductsAuthorities', 'SetAppsAuthToApiProduct', 'DescribeApisByVpcAccess', 'DeleteAppCode', 'DeleteAppKey', 'CreateAppCode', 'CreateAppKey', 'DescribeInstanceClusterList', 'DescribeAppSecurities', 'ExportOAS', + 'AssociateInstanceWithPrivateDNS', 'AttachApiProduct', 'CreateApp', 'CreateDataset', 'CreateInstance', 'CreateModel', 'CreatePrivateDNS', 'CreateStageModel', 'DeleteApi', 'DeleteApiProduct', 'DeleteDataset', 'DeleteDomain', 'DeleteInstance', 'DeleteModel', 'DeletePrivateDNS', 'DeleteSignature', 'DeleteStageModel', 'DeleteTrafficControl', 'DescribeApiGroups', 'DescribeApps', + 'DescribeInstanceClusterInfo', 'DescribeInstances', 'DescribePurchasedApiGroups', 'DescribeRegions', 'DescribeStageModels', 'DescribeZones', 'DissociateInstanceWithPrivateDNS', 'ListTagResources', 'ModifyApiGroupVpcWhitelist', 'ModifyApp', 'ModifyInstanceAttribute', 'ModifyInstanceSpec', 'ModifyModel', 'ModifyStageModel', 'TagResources', 'UntagResources', 'UpdatePrivateDNS', 'ValidateVpcConnectivity', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DissociateInstanceWithPrivateDNS' => [ - 'summary' => 'Disassociates an internal domain name resolution from a dedicated instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AbolishApi' => [ + 'summary' => 'Unpublishes a specified API from a specified runtime environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the specified API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-hz-ead4f4b0bac8', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'AbolishApi', + 'description' => '- This operation is intended for API providers and is the opposite of DeployApi.'."\n" + ."\n" + .'- An API can be unpublished from a specified runtime environment in under 5 seconds.'."\n" + ."\n" + .'- An unpublished API cannot be called in the specified runtime environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbolishApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'IntranetDomains', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The internal domain names included in the resolution.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api.demo.com', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:AbolishApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], - 'required' => true, - 'minItems' => 1, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', + ], + 'AddAccessControlListEntry' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the access control list (ACL).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp1ohqkonqybecf4llbrc', 'title' => ''], + ], + [ + 'name' => 'AclEntrys', + 'in' => 'query', + 'schema' => ['description' => 'The ACL settings.'."\n" + ."\n" + .'- entry: the entries that you want to add to the ACL. You can add CIDR blocks. Separate multiple CIDR blocks with commas (,).'."\n" + ."\n" + .'- comment: the description of the ACL.'."\n" + ."\n" + .'> You can add at most 50 IP addresses or CIDR blocks to an ACL in each call. If the IP address or CIDR block that you want to add to an ACL already exists, the IP address or CIDR block is not added. The entries that you add must be CIDR blocks.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{\'entry\': \'192.168.1.0/24\', \'comment\': \'test\'}]', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', - 'title' => 'DissociateInstanceWithPrivateDNS', - ], - 'DeletePrivateDNS' => [ - 'summary' => 'Deletes an internal domain name resolution.', - 'methods' => [ - 'post', + 'title' => 'AddAccessControlListEntry', + 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAccessControlListEntry'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'https', + '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' => 'Adds a policy to an existing ACL.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'create', + 'abilityTreeCode' => '94246', + 'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'], ], 'parameters' => [ [ - 'name' => 'IntranetDomain', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'api.demo.com', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'AppId', 'in' => 'query', + 'schema' => ['description' => 'The restriction policy on app IDs for a specific policy. You can restrict app IDs only for whitelists. The IpControlType values of whitelists are ALLOW.'."\n" + ."\n" + .'- You can add only one app ID restriction policy at a time.'."\n" + ."\n" + .'- If this parameter is empty, no restriction is imposed on the app IDs.'."\n" + ."\n" + .'- If this parameter is not empty, there is restriction not only on IP addresses, but also on apps.'."\n" + ."\n" + .'- Please note that if this parameter is not empty and the security authentication method of the API is No Authentication, all API calls are restricted.'."\n" + ."\n" + .'- If this parameter is not empty for a blacklist, API Gateway automatically skips this parameter and sets only restriction on IP addresses. The IpControlType value of a blacklist is REFUSE.', 'type' => 'string', 'required' => false, 'example' => '1111111', 'title' => ''], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => ['description' => 'The IP addresses or CIDR blocks involved in the policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can specify a maximum of 10 IP addresses or CIDR blocks.', 'type' => 'string', 'required' => true, 'example' => '113.125.1.101;101.11.1.1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The internal domain name resolution type. Valid values:'."\n" - ."\n" - .'* VPC: resolution for virtual private cloud (VPC) access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" - .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'A' => 'A', - 'VPC' => 'VPC', + 'type' => 'object', + 'properties' => [ + 'PolicyItemId' => ['description' => 'The ID of the policy. The ID is unique.', 'type' => 'string', 'example' => 'P151617000829241', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], - 'example' => 'A', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'AddIpControlPolicyItem', + 'description' => 'When you call this operation, note that:'."\n" + ."\n" + .'- This operation is intended for API providers.'."\n" + ."\n" + .'- An added policy immediately takes effect on all APIs that are bound to the access control list (ACL).'."\n" + ."\n" + .'- A maximum of 100 policies can be added to an ACL.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIpControlPolicyItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to force delete the resolution.'."\n" - ."\n" - .'* true: force deletes the resolution if the resolution is associated with an instance.'."\n" - .'* false: does not force delete the resolution if the resolution is associated with an instance.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:AddIpControlPolicyItem', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyItemId\\": \\"P151617000829241\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'AddTrafficSpecialControl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94247', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the specified throttling policy.', 'type' => 'string', 'required' => true, 'example' => 'tf123456', 'title' => ''], + ], + [ + 'name' => 'SpecialType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the special throttling policy. Valid values:'."\n" + ."\n" + .'- **APP**'."\n" + ."\n" + .'- **USER**', 'type' => 'string', 'required' => true, 'example' => 'APP', 'title' => ''], + ], + [ + 'name' => 'SpecialKey', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the app or Alibaba Cloud account. Specify this parameter based on the value of the **SpecialType** parameter. You can view your account ID on the [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3f053654YpMPwo#/secure) page.', 'type' => 'string', 'required' => true, 'example' => '3382463', 'title' => ''], + ], + [ + 'name' => 'TrafficValue', + 'in' => 'query', + 'schema' => ['description' => 'The special throttling value.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10000', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'AddTrafficSpecialControl', + 'summary' => 'Adds a custom special policy to a specified throttling policy.', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- If the input SpecialKey already exists, the previous configuration is overwritten. Use caution when calling this operation.'."\n" + ."\n" + .'- Special throttling policies must be added to an existing throttling policy, and can take effect on all the APIs to which the throttling policy is bound.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTrafficSpecialControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', - 'title' => 'DeletePrivateDNS', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', ], 'AssociateInstanceWithPrivateDNS' => [ 'summary' => 'Associates an internal domain name resolution with a dedicated instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -559,21 +446,12 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-hz-ead4f4b0bac8'."\n", - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-ead4f4b0bac8'."\n", 'title' => ''], ], [ 'name' => 'IntranetDomains', @@ -582,14 +460,11 @@ 'schema' => [ 'description' => 'The internal domain names included in the resolution.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api.demo.com', - ], + 'items' => ['description' => 'The internal domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'api.demo.com', 'title' => ''], 'required' => true, 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], @@ -600,495 +475,476 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB999B529\\"\\n}","type":"json"}]', 'title' => 'AssociateInstanceWithPrivateDNS', 'description' => 'An internal domain name resolution can be associated only with a dedicated instance, not with a shared instance or shared instance cluster.'."\n", - ], - 'CreatePrivateDNS' => [ - 'summary' => 'Creates an internal domain name resolution and adds a resolution record.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateInstanceWithPrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:AssociateInstanceWithPrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AttachApiProduct' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IntranetDomain', + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'api.demo.com', - ], + 'schema' => ['description' => 'The ID of the API product.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'Apis', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The internal domain name resolution type. Valid values:'."\n" - ."\n" - .'* VPC: resolution for VPC access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" - .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'A' => 'A', - 'VPC' => 'VPC', - ], - 'example' => 'A', - ], - ], - [ - 'name' => 'Records', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The resolution records. This parameter is valid only when Type is set to A.'."\n", + 'description' => 'The APIs to be attached.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about the resolution record.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'Record' => [ - 'description' => 'The resolution record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1', - ], - 'Weight' => [ - 'description' => 'The weight of the record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'ApiId' => ['description' => 'The API ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '551877242a4b4f3a84a56b7c3570e4a7', 'title' => ''], + 'StageName' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**: the production environment'."\n" + .'* **PRE**: the staging environment'."\n" + .'* **TEST**: the test environment'."\n", 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], 'required' => false, + 'title' => '', ], - 'required' => false, - 'minItems' => 1, + 'required' => true, + 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]', - 'title' => 'CreatePrivateDNS', - 'description' => 'An internal domain name resolution of the virtual private cloud (VPC) type can be bound only to traditional dedicated instances. An internal domain name resolution of the A type can be bound only to VPC integration dedicated instances.'."\n", - ], - 'ListPrivateDNS' => [ - 'summary' => 'Queries internal domain name resolutions by domain name or resolution type.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\"\\n}","type":"json"}]', + 'title' => 'AttachApiProduct', + 'summary' => 'Attaches APIs to an API product. If the API product does not exist, the system automatically creates the API product.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachApiProduct'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:AttachApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AttachGroupPlugin' => [ + 'summary' => 'Attach plugin to API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215588', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'IntranetDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api.demo.com', - ], - ], - [ - 'name' => 'Type', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The internal domain name resolution type. Valid values:'."\n" - ."\n" - .'* VPC: resolution for virtual private cloud (VPC) access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" - .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'A' => 'A', - 'VPC' => 'VPC', - ], - 'example' => 'A', - ], + 'schema' => ['description' => 'The ID of the plug-in to be bound.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The environment in which the API is requested. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PrivateDNSList' => [ - 'description' => 'The internal domain name resolutions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The internal domain name resolution.'."\n", - 'type' => 'object', - 'properties' => [ - 'IntranetDomain' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'example' => 'api.demo.com', - ], - 'Type' => [ - 'description' => 'The internal domain name resolution type. Valid values:'."\n" - ."\n" - .'* VPC: resolution for VPC access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" - .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'A' => 'A', - 'VPC' => 'VPC', - ], - 'example' => 'A', - ], - 'CreatedTime' => [ - 'description' => 'The time when the resolution was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-05-10T08:17:00Z', - ], - 'Records' => [ - 'description' => 'The resolution records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the resolution record.'."\n", - 'type' => 'object', - 'properties' => [ - 'Record' => [ - 'description' => 'The resolution record.'."\n", - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'Weight' => [ - 'description' => 'The weight of the record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - ], - 'BindInstances' => [ - 'description' => 'The instances that are associated with the resolution.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'apigateway-hz-ead4f4b0bac8', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'ListPrivateDNS', - ], - 'UpdatePrivateDNS' => [ - 'summary' => 'Modifies an internal domain name resolution.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Attach plugin to group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachGroupPlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'https', + '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' => 'Binds a plug-in to an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '94249', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'IntranetDomain', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The internal domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'api.demo.com', - ], + 'schema' => ['description' => 'The ID of the plug-in to be bound.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9a3f1a5279434f2ba74ccd91c295af9f ', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group that contains the API to which the plug-in is to be bound.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '285bb759342649a1b70c2093a772e087', 'title' => ''], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => ['description' => 'The number of the API to be operated. Separate multiple numbers with commas (,). A maximum of 100 numbers can be entered.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'StageName', 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE: the pre-release environment**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['description' => 'The number of the API to be bound.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '8afff6c8c4c6447abb035812e4d66b65 ', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The internal domain name resolution type. Valid values:'."\n" - ."\n" - .'* VPC: resolution for virtual private cloud (VPC) access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" - .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'A' => 'A', - 'VPC' => 'VPC', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], ], - 'example' => 'A', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'AttachPlugin', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- You can only bind plug-ins to published APIs.'."\n" + ."\n" + .'- The plug-in takes effect immediately after it is bound to an API.'."\n" + ."\n" + .'- If you bind a different plug-in to an API, this plug-in takes effect immediately.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachPlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'Records', - 'in' => 'formData', - 'style' => 'json', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + ], + 'BatchAbolishApis' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Api', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The resolution records. This parameter is valid only when Type is set to A.'."\n", + 'description' => 'The APIs that you want to operate.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the resolution record.'."\n", 'type' => 'object', 'properties' => [ - 'Record' => [ - 'description' => 'The resolution record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.2', - ], - 'Weight' => [ - 'description' => 'The weight of the record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'StageId' => ['description' => 'The ID of the environment.', 'type' => 'string', 'required' => false, 'example' => '979fd16250644d5b82173534f465ac77', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => 'ced5ab777f7b440398ea70e4470124de', 'title' => ''], + 'ApiUid' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'example' => '994f72dcdaf04af0b38022c65fdbd1ac', 'title' => ''], + 'StageName' => ['description' => 'The name of the environment.', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, - 'minItems' => 1, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], + 'OperationId' => ['description' => 'The ID of the operation.', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', - 'title' => 'UpdatePrivateDNS', - ], - 'ModifyInstanceVpcAttributeForConsole' => [ - 'summary' => 'Modify instance client VPC config.', - 'methods' => [ - 'post', - 'get', + 'title' => 'BatchAbolishApis', + 'summary' => 'Unpublishes multiple published APIs at a time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAbolishApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:BatchAbolishApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', + ], + 'BatchDeployApis' => [ + 'summary' => 'Publishes multiple APIs at a time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94442', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayAQG9N5', - ], - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-bj-f28baxxxxb51', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**'."\n" + ."\n" + .'- PRE: the pre-release environment', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the VPC.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vpc-8vbnnd66xxxx2xb5oig4f', - ], + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Token', + 'name' => 'Api', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The token of the request.'."\n", - 'type' => 'string', + 'description' => 'The APIs that you want to publish.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => true, 'example' => 'b4f5c342b8bc4ef88ccda0332402****', 'title' => ''], + 'ApiUid' => ['description' => 'The API ID.', 'type' => 'string', 'required' => true, 'example' => '2b35dd68345b472f8051647306a1****', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '505959c38776d9324945dbff709582', + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'VpcOwnerId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1121011712128923', + 'type' => 'object', + 'properties' => [ + 'OperationId' => ['description' => 'The ID of the operation.', 'type' => 'string', 'example' => '2a322599-8e38-428a-a306-9b21ea2129bf', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'BatchDeployApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeployApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'VswitchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'vsw-bj9e2i8w3wz7shkvnuj9a', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:BatchDeployApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"2a322599-8e38-428a-a306-9b21ea2129bf\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', + ], + 'CreateAccessControlList' => [ + 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Creates an Access Control List (ACL). Each user is allowed to create five ACLs in each region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeleteVpcAccess', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'AclName', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether delete instance client VPC.'."\n" - .'- FALSE: set or modify instance client VPC'."\n" - .'- TRUE: delete instance client VPC', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The name of the ACL. The name must be 1 to 30 characters in length, and can contain letters, digits, periods (.), hyphens (-), forward slashes (/), and underscores (\\_). The name must be unique within the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAcl', 'title' => ''], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => ['description' => 'The IP protocol version of the ACL. Valid values:'."\n" + ."\n" + .'- **IPv4**'."\n" + ."\n" + .'- **IPv6**', 'type' => 'string', 'example' => 'ipv4', 'default' => 'ipv4', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -1096,265 +952,355 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D08741CF-BE59-5DA6-B06F-BB65173110C0', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'AclId' => ['description' => 'The ACL ID.', 'type' => 'string', 'example' => 'acl-bp1uqwgwmkbutnzq2r59z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D08741CF-BE59-5DA6-B06F-BB65173110C0\\"\\n}","type":"json"}]', - 'title' => 'Modify instance client VPC config', - ], - 'CreateInstance' => [ - 'summary' => 'Creates an API Gateway instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateAccessControlList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessControlList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"AclId\\": \\"acl-bp1uqwgwmkbutnzq2r59z\\"\\n}","type":"json"}]', + ], + 'CreateApi' => [ + 'summary' => 'Creates an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ChargeType', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the instance. Valid values: PostPaid (pay-as-you-go) and PrePaid (subscription).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PostPaid'."\n" - .'PrePaid', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], ], [ - 'name' => 'InstanceName', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance Name', - 'type' => 'string', - 'required' => true, - 'example' => 'ApigatewayInstance', - ], + 'schema' => ['description' => 'The name of the API that you want to create. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ApiName', 'title' => ''], ], [ - 'name' => 'InstanceSpec', + 'name' => 'Visibility', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance specifications', - 'type' => 'string', - 'required' => true, - 'example' => 'api.s1.small', - ], + 'schema' => ['description' => 'Specifies whether to make the API public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" + ."\n" + .'- **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PUBLIC', 'title' => ''], ], [ - 'name' => 'ZoneId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The zone in which you want to create the instance. This parameter is required for a conventional dedicated instance and optional for a virtual private cloud (VPC) integration instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-MAZ3(c,e)', - ], + 'schema' => ['description' => 'The description of the API. The description can be up to 180 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'Api description', 'title' => ''], ], [ - 'name' => 'HttpsPolicy', + 'name' => 'AuthType', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTPS policy.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'HTTPS2_TLS1_2', - ], + 'schema' => ['description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [RequestConfig](~~43985~~).', 'type' => 'string', 'required' => false, 'example' => 'APP', 'title' => ''], ], [ - 'name' => 'Duration', + 'name' => 'RequestConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration of the instance.'."\n" - ."\n" - .'* If PricingCycle is set to **Month**, set this parameter to an integer ranges from **1** to **9**.'."\n" - .'* If PricingCycle is set to **Year**, set this parameter to an integer ranges from **1** to **3**.'."\n" - ."\n" - .'> This parameter is valid and required only if the ChargeType parameter is set to **PrePaid**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The configuration items of API requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceConfig](~~43987~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}', 'title' => ''], ], [ - 'name' => 'PricingCycle', + 'name' => 'ServiceConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the subscription duration of the subscription instance. Valid values:'."\n" - ."\n" - .'* **year**'."\n" - .'* **month**'."\n" - ."\n" - .'> This parameter is required if the ChargeType parameter is set to Prepaid.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - 'default' => 'month', - ], + 'schema' => ['description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [RequestParameter](~~43986~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'RequestParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The common parameters of APIs in JSON format.', '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" + .']', 'title' => ''], + ], + [ + 'name' => 'SystemParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters of the API.', 'type' => 'string', 'required' => false, 'example' => '[{\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaDomain\\",\\"serviceParameterName\\":\\"host\\"}]', 'title' => ''], + ], + [ + 'name' => 'ConstantParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceParameter](~~43988~~).', 'type' => 'string', 'example' => '[{\\"ConstantValue\\":\\"123\\",\\"Description\\":\\"Constant parameter\\",\\"Location\\":\\"HEAD\\",\\"ServiceParameterName\\":\\"test\\"}]', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ServiceParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceParameterMap](~~43989~~).', '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" + .']', 'title' => ''], + ], + [ + 'name' => 'ServiceParametersMap', + 'in' => 'formData', + 'schema' => ['description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.', '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" + .']', 'title' => ''], + ], + [ + 'name' => 'ResultType', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to automatically pay when renewing. Value:'."\n" - ."\n" - .'- True: Automatic payment. Please ensure that your account has sufficient balance.'."\n" - .'- False: Console manual payment. The specific operation is to log in to the console, select Expenses in the upper right corner, enter the Expense Center, and find the target order in Order Management to make payment.'."\n" - ."\n" - .'Default value: False.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The sample response from the backend service.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HTML', 'title' => ''], ], [ - 'name' => 'Token', + 'name' => 'ResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'An example of a response returned by the backend service. This value is used only to generate documentation. The actually returned result shall prevail.(Support up to 32KB)', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'FailResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'The sample error codes returned by the backend service.'."\n" + ."\n" + .'For more information, see [ErrorCodeSample](~~44392~~).(Support up to 16KB)', 'type' => 'string', 'required' => false, 'example' => '{\\"requestId\\":\\"3b9b8b31-93c3-489e-8ebb-cab35a1aee51\\",\\"errCode\\":500,\\"errMsg\\":\\"connection refused\\"}', 'title' => ''], + ], + [ + 'name' => 'ErrorCodeSamples', + 'in' => 'formData', + 'schema' => ['description' => 'The return description of the API.', 'type' => 'string', 'required' => false, 'example' => '[{\\"Code\\":\\"400\\",\\"Message\\":\\"Login failed\\",\\"Description\\":\\"Invalid user name or password\\"}]', 'title' => ''], + ], + [ + 'name' => 'ResultDescriptions', + 'in' => 'formData', + 'schema' => ['description' => 'The switch status of ACL. Valid values:- **on** and **off**.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'OpenIdConnectConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'Passwords are used to prevent duplicate requests from being submitted, please do not reuse them.', - 'type' => 'string', - 'required' => true, - 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', - ], + 'schema' => ['description' => 'If the **AuthType** is **APP** authentication, you need to pass this value to specify the signature algorithm. If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => '{\\"openIdApiType\\":null,\\"idTokenParamName\\":null,\\"publicKeyId\\":null,\\"publicKey\\":null}', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'AllowSignatureMethod', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to add to the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The type of the two-way communication API.'."\n" + ."\n" + .'- **COMMON**: normal APIs'."\n" + ."\n" + .'- **REGISTER**: registered APIs'."\n" + ."\n" + .'- **UNREGISTER**: unregistered APIs'."\n" + ."\n" + .'- **NOTIFY**: downstream notification APIs', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'WebSocketApiType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the dedicated instance. Valid values:'."\n" - ."\n" - .'* vpc_connect: a VPC integration instance'."\n" - .'* normal: a conventional dedicated instance'."\n" - ."\n" - .'> This parameter is in invitational preview and not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc_connect', - ], + 'schema' => ['description' => 'The return description of the API.', 'type' => 'string', 'required' => false, 'example' => 'COMMON', 'title' => ''], ], [ - 'name' => 'InstanceCidr', + 'name' => 'ResultBodyModel', 'in' => 'query', - 'schema' => [ - 'description' => 'The CIDR block of the VPC integration instance.'."\n" - ."\n" - .'* 192.168.0.0/16'."\n" - .'* 172.16.0.0/12'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning** The VPC integration instance is connected to the specified CIDR block. Plan your CIDR block carefully to prevent overlaps with the private IP addresses of cloud services.'."\n" - ."\n" - .'> This parameter is in invitational preview and not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '172.16.0.0/12'."\n", - ], + 'schema' => ['description' => '- Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'UserVpcId', + 'name' => 'ForceNonceCheck', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user\'s VPC to be connected by the VPC integration instance.'."\n" - ."\n" - .'> This parameter is in invitational preview and not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg'."\n", - ], + 'schema' => ['description' => '- Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" + ."\n" + .'- If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ZoneVSwitchSecurityGroup', + 'name' => 'DisableInternet', + 'in' => 'query', + 'schema' => ['description' => 'If **AuthType** is set to **APP**, the valid values are:'."\n" + ."\n" + .'- **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is used.'."\n" + ."\n" + .'- **DISABLE**: The authentication is disabled.'."\n" + ."\n" + .'- **HEADER**: AppCode can be placed in the Header parameter for authentication.'."\n" + ."\n" + .'- **HEADER\\_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AppCodeAuthType', + 'in' => 'query', + 'schema' => ['description' => 'The IDof the backend service', 'type' => 'string', 'required' => false, 'example' => 'HEADER', 'title' => ''], + ], + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable backend services.', 'type' => 'string', 'required' => false, 'example' => 'a0305308908c4740aba9cbfd63ba99b7', 'title' => ''], + ], + [ + 'name' => 'BackendEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable backend services.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The network information when the instance is a VPC integration instance, such as the zone, vSwitch, and security group.'."\n" - ."\n" - .'> This parameter is in invitational preview and not available for public use.'."\n", + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing-c', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-0xi349n11cxogmvm866tb', - ], - 'CidrBlock' => [ - 'description' => 'The IPv4 CIDR block for the vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.9.0/24', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group. Services in the same security group can access each other.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-2ze2ql9nozv8q7kmlt6e', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 3, - 'minItems' => 1, + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -1363,39 +1309,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TagStatus' => [ - 'description' => 'Indicates whether the tag exists. Valid values: **true** and **false**.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'InstanceId' => [ - 'description' => 'Instance ID', - 'type' => 'string', - 'example' => 'apigateway-hz-b3c5dadd5***', - ], - 'RequestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', - ], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '8afff6c8c4c6447abb035812e4d66b65', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagStatus\\": true,\\n \\"InstanceId\\": \\"apigateway-hz-b3c5dadd5***\\",\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', - 'title' => 'CreateInstance', - ], - 'DeleteInstance' => [ - 'summary' => 'Deletes an API Gateway instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"8afff6c8c4c6447abb035812e4d66b65\\",\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', + 'title' => 'CreateApi', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- The name of an API must be unique within an API group.'."\n" + ."\n" + .'- A request path must be unique within an API group.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateApiGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1404,53 +1363,53 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94291', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayAQG9N5', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94264', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The group name. It must be unique and can contain only letters, digits, underscores, and Chinese characters. It must start with a letter or Chinese character. Its length must be 4 to 50 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Weather', 'title' => ''], + ], + [ + 'name' => 'BasePath', + 'in' => 'query', + 'schema' => ['description' => 'The root path for APIs in this group.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '/qqq', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'A description of the API group. It can be up to 180 characters long.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'The weather informations.', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-sh-ae502ee79ef8', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", + 'description' => 'The object tags to which the rule applies. You can specify multiple tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'example' => 'Key, Value', 'maxItems' => 500, + 'title' => '', ], ], ], @@ -1459,300 +1418,238 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', - ], + 'TagStatus' => ['description' => 'Indicates whether the tag exists. Valid values:- **true**: The tag exists.- **false**: The tag does not exist.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'BasePath' => ['description' => 'The root path for APIs in this group.', 'type' => 'string', 'example' => '/qqq', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', 'title' => ''], + 'Description' => ['description' => 'The description of the API group.', 'type' => 'string', 'example' => 'The weather informations', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'Weather', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and is globally unique.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7xx', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain assigned to the group by the system. Use it to test API calls.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com', 'title' => ''], + 'InstanceType' => ['description' => 'The type of the instance.<br>- CLASSIC\\_SHARED: Shared instance in classic network<br>- VPC\\_SHARED: Shared instance in a VPC<br>- VPC\\_DEDICATED: Dedicated instance in a VPC<br><br><br>'."\n" + ."\n" + .'- CLASSIC\\_SHARED: Shared instance (Classic Network)'."\n" + ."\n" + .'- VPC\\_SHARED: Shared instance (VPC)'."\n" + ."\n" + .'- VPC\\_DEDICATED: Dedicated instance (VPC)', 'type' => 'string', 'example' => 'VPC_SHARED', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA4B3261-F14A-5E33-8608-F75A1DF27AD4\\"\\n}","type":"json"}]', - 'title' => 'DeleteInstance', - ], - 'ModifyInstanceAttribute' => [ - 'summary' => 'Modifies the properties of an API Gateway instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateApiGroup', + 'summary' => 'Create an API group.', + 'description' => 'You must create an API group before you create APIs. The group is a required property of each API.'."\n" + ."\n" + .'- This feature is for API providers.'."\n" + ."\n" + .'- Each user can create up to 100 groups per region.'."\n" + ."\n" + .'- The system automatically assigns a second-level domain to each group for API testing.'."\n" + ."\n" + .'- Groups are associated with a region. When you select a group for an API, you also select its region. To reduce network latency, choose a region that matches your backend service region.'."\n" + ."\n" + .'- After you create a group, attach a custom domain name with an ICP filing to it.'."\n" + ."\n" + .'- The QPS limit for this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateApiGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateApiStageVariable' => [ + 'summary' => 'Adds a variable to an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94438', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94265', + 'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-ht-8xxxxxxxxx', - ], - ], - [ - 'name' => 'InstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Instance Name', - 'type' => 'string', - 'required' => false, - 'example' => 'apigatewayInstance', - ], - ], - [ - 'name' => 'HttpsPolicy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTPS policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS2_TLS1_0', - ], - ], - [ - 'name' => 'IPV6Enabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'If enable inbound IPv6 Traffic.', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'EgressIpv6Enable', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'If enable outbound IPv6 Traffic.', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'VpcSlbIntranetEnable', + 'name' => 'StageId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the self-calling domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the runtime environment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], ], [ - 'name' => 'Token', + 'name' => 'VariableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The token of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', - ], + 'schema' => ['description' => 'The name of the variable to be added. This parameter is case-sensitive.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serverName', 'title' => ''], ], [ - 'name' => 'IntranetSegments', + 'name' => 'SupportRoute', 'in' => 'query', - 'schema' => [ - 'description' => 'Custom private CIDR block.', - 'type' => 'string', - 'required' => false, - 'example' => '172.0.0.1/24', - ], + 'schema' => ['description' => 'Specifies whether routing is supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'MaintainStartTime', + 'name' => 'VariableValue', 'in' => 'query', - 'schema' => [ - 'description' => 'Maintainable start time.', - 'type' => 'string', - 'required' => false, - 'example' => '18:00Z', - ], + 'schema' => ['description' => 'The value of the variable.', 'type' => 'string', 'required' => false, 'example' => 'api.domain.com', 'title' => ''], ], [ - 'name' => 'MaintainEndTime', + 'name' => 'StageRouteModel', 'in' => 'query', - 'schema' => [ - 'description' => 'Maintainable end time.', - 'type' => 'string', - 'required' => false, - 'example' => '23:00Z', - ], + 'schema' => ['description' => 'The routing model of the environment.', '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" + .'}', 'title' => ''], ], - [ - 'name' => 'ToConnectVpcIpBlock', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The information about the CIDR block that API Gateway can use to access the virtual private cloud (VPC) of the backend service.'."\n", 'type' => 'object', 'properties' => [ - 'VswitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-wz94cqvaoe1ipxxxxxx', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-a', - ], - 'CidrBlock' => [ - 'description' => 'The CIDR block of the VSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '172.16.0.0/16', - ], - 'Customized' => [ - 'description' => 'Specifies whether the CIDR block is a custom CIDR block.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DeleteVpcIpBlock', - 'in' => 'query', - 'schema' => [ - 'description' => 'If delete VPC Ip block.', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + ], + 'title' => 'CreateApiStageVariable', + 'description' => '- This operation is intended for API providers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiStageVariable'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX', - ], + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX\\"\\n}","type":"json"}]', - 'title' => 'ModifyInstanceAttribute', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB999B529\\"\\n}","type":"json"}]', ], - 'ModifyInstanceSpec' => [ - 'summary' => 'Upgrades or downgrades the configurations of an API Gateway instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94441', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayAQG9N5', - ], + 'operationType' => 'create', + 'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], + 'schema' => ['description' => 'The name of the application. The name must be 4 to 26 characters in length. The name can contain letters, digits, and underscores (\\_), and must start with a letter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CreateAppTest', 'title' => ''], ], [ - 'name' => 'InstanceSpec', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'api.s1.small', - ], + 'schema' => ['description' => 'The description of the application. The description can be up to 180 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether payment is automatically made during renewal. Valid values:'."\n" - ."\n" - .'* **True**: Automatic payment is enabled. Make sure that your Alibaba Cloud account has adequate balance.'."\n" - .'* **False**: Automatic payment is disabled. You have to manually pay in the console. Log on to the console. In the upper-right corner, choose **Expenses > User Center**. In the left-side navigation pane, click **Orders**. On the page that appears, find your order and complete the payment.'."\n" - ."\n" - .'Default value: **False**.'."\n", - 'type' => 'boolean', + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n" + ."\n" + .'Valid values of n: `[1, 20]`.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n" + ."\n" + .'Valid values of n: `[1, 20]`. If the parameter has a value, you must specify a value for the tag key with the same N as tag.N.Key. Otherwise, an error is reported.', 'type' => 'string', 'required' => false, 'example' => '\' \'', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], [ - 'name' => 'Token', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b5845042-2f2f-4e96-bd5c-36c6e5c2a68c', - ], + 'schema' => ['description' => 'The key of the application that is used to make an API call.', 'type' => 'string', 'required' => false, 'example' => '60030986', 'title' => ''], ], [ - 'name' => 'ModifyAction', + 'name' => 'AppSecret', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to upgrade or downgrade the instance. Valid values:'."\n" - ."\n" - .'* **UPGRADE**'."\n" - .'* **DOWNGRADE**'."\n" - ."\n" - .'Default value: **UPGRADE**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UPGRADE', - ], + 'schema' => ['description' => 'The password of the application.', 'type' => 'string', 'required' => false, 'example' => 'nzyNqFkRWB2uLw86', 'title' => ''], ], [ - 'name' => 'SkipWaitSwitch', + 'name' => 'AppCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to skip the Waiting for Traffic Switchover state. During the upgrade or downgrade, a new outbound IP address may be added to the API Gateway instance. The Waiting for Traffic Switchover state is used to remind users of adding the new outbound IP address to the whitelist. If you set the SkipWaitSwitch parameter to true, the instance does not enter the Waiting for Traffic Switchover state when a new outbound IP address is available. Instead, the system sends internal messages to the user.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The AppCode of the application.', 'type' => 'string', 'required' => false, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', 'title' => ''], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => ['description' => 'The extended information.', 'type' => 'string', 'required' => false, 'example' => '110210264071', 'title' => ''], ], ], 'responses' => [ @@ -1760,29 +1657,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', - ], + 'TagStatus' => ['description' => 'Indicates whether the tag exists. If the value is **true**, the tag exists. If the value is **false**, the tag does not exist.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550', 'title' => ''], + 'AppId' => ['description' => 'The unique ID of the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36BBBAD4-1CFB-489F-841A-8CA52EEA787E\\"\\n}","type":"json"}]', - 'title' => 'ModifyInstanceSpec', - ], - 'EnableInstanceAccessControl' => [ - 'summary' => 'This feature provides instance-level access control capabilities for dedicated API Gateway instances. Specifies the access control policy of an instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateApp', + 'summary' => 'Creates an app for API Gateway.', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- Each application has a key-value pair which is used for identity verification when you call an API.'."\n" + ."\n" + .'- An application must be authorized to call an API.'."\n" + ."\n" + .'- Each application has only one key-value pair, which can be reset if the pair is leaked.'."\n" + ."\n" + .'- A maximum of 1,000 applications can be created for each Alibaba Cloud account.'."\n" + ."\n" + .'- Allows up to 50 calls per second per account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagStatus\\": false,\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\",\\n \\"AppId\\": 20112314518278\\n}","type":"json"}]', + ], + 'CreateAppCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1791,53 +1716,20 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', + 'abilityTreeCode' => '207738', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'AclId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-bp11escro2et2tioscy52', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], - ], - [ - 'name' => 'AclType', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ACL type. Valid values:'."\n" - ."\n" - .'* black: blacklist'."\n" - .'* white: whitelist'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'black', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111203109', 'title' => ''], ], [ - 'name' => 'AddressIPVersion', + 'name' => 'AppCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP version. Valid values: **ipv4** and **ipv6**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4', - ], + 'schema' => ['description' => 'The application AppCode.', 'type' => 'string', 'required' => false, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', 'title' => ''], ], ], 'responses' => [ @@ -1845,28 +1737,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]', - 'title' => 'EnableInstanceAccessControl', - ], - 'DisableInstanceAccessControl' => [ - 'summary' => 'This feature provides instance-level access control capabilities for dedicated API Gateway instances. Disables access control on an instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateAppCode', + 'summary' => 'Adds an AppCode to an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppCode'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Adds an AppKey and AppSecret pair to an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1875,42 +1781,25 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'create', + 'abilityTreeCode' => '207737', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'AclId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-grgqc0mnuhkqciwtam', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111053351', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], + 'schema' => ['description' => 'The application AppKey.', 'type' => 'string', 'required' => false, 'example' => '204203237', 'title' => ''], ], [ - 'name' => 'AddressIPVersion', + 'name' => 'AppSecret', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP version. Valid values: **ipv4** and **ipv6**.', - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4', - ], + 'schema' => ['description' => 'The application AppSecret.', 'type' => 'string', 'required' => false, 'example' => '6f0a4ad7918a4b41a57fc087d5b066d0', 'title' => ''], ], ], 'responses' => [ @@ -1918,121 +1807,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D524309-6BED-5BB4-A735-F7D9F98B7B88', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', - 'title' => 'DisableInstanceAccessControl', - ], - 'DescribeInstances' => [ - 'summary' => 'Queries the details of instances in a region. The instances include shared instances and dedicated instances.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateAppKey', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppKey'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Creates a backend service in API Gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94370', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayAQG9N5', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'BackendName', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. If you do not specify this parameter, all instances are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api-shared-vpc-001', - ], + 'schema' => ['description' => 'The name of the backend service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testBackendService', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'BackendType', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which you want the description of the system policy to be returned. Valid values:'."\n" - ."\n" - .'* en: English'."\n" - .'* zh: Chinese'."\n" - .'* ja: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The type of the backend service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'HTTP', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'Description', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'VPC_SHARED', - 'VPC_DEDICATED', - ], - ], + 'schema' => ['description' => 'The description.', 'type' => 'string', 'example' => 'HTTP backend', 'required' => false, 'docRequired' => false, 'title' => ''], ], [ - 'name' => 'EnableTagAuthorization', + 'name' => 'CreateEventBridgeServiceLinkedRole', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether tag authorization is enabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies to create a EventBridge service-linked role.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'CreateSlr', + 'in' => 'query', + 'schema' => ['description' => 'Specifies to create a service-linked role.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag that is bound to the instance.'."\n", + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 500, + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -2041,429 +1906,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Instances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'InstanceAttribute' => [ - 'description' => 'The information about the instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The instance status.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'VpcSlbIntranetEnable' => [ - 'description' => 'Indicates whether virtual private cloud (VPC) Server Load Balancer (SLB) is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ClassicEgressAddress' => [ - 'description' => 'The egress IP address.'."\n", - 'type' => 'string', - 'example' => '10.0.0.1', - ], - 'ZoneLocalName' => [ - 'description' => 'The zone.'."\n", - 'type' => 'string', - 'example' => 'Multi-Availability Zone 3(b,c,a)', - ], - 'UserVpcId' => [ - 'description' => 'The user VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-t***hx****yu9****t0g4', - ], - 'VpcIntranetEnable' => [ - 'description' => 'Indicates whether VPC access is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'VpcOwnerId' => [ - 'description' => 'The ID of the account to which the VPC-based instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1408453217640291****', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'api-shared-vpc-020', - ], - 'InstanceRpsLimit' => [ - 'description' => 'The requests per second (RPS) limit on the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'InstanceType' => [ - 'description' => 'The instance type. Valid values:'."\n" - ."\n" - .'* VPC_SHARED: shared instance (VPC)'."\n" - .'* VPC_DEDICATED: dedicated instance (VPC)'."\n", - 'type' => 'string', - 'example' => 'VPC_SHARED', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'InstanceSpec' => [ - 'description' => 'The instance specification.'."\n", - 'type' => 'string', - 'example' => 'api.s1.small', - ], - 'InstanceChargeType' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* PrePaid: subscription'."\n" - .'* PayAsYouGo: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'PrePaid', - ], - 'HttpsPolicies' => [ - 'description' => 'The HTTPS security policy.'."\n", - 'type' => 'string', - 'example' => 'HTTPS2_TLS1_2', - ], - 'VpcEgressAddress' => [ - 'description' => 'The VPC egress CIDR block.'."\n", - 'type' => 'string', - 'example' => '100.104.254.0/26', - ], - 'NewVpcEgressAddress' => [ - 'type' => 'string', - 'description' => 'The new VPC egress CIDR block.', - 'example' => '100.104.253.0/26', - ], - 'EgressIpv6Enable' => [ - 'description' => 'Indicates whether outbound IPv6 traffic is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ExpiredTime' => [ - 'description' => 'The time when the instance expires.'."\n", - 'type' => 'string', - 'example' => '1659801600000', - ], - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-MAZ5(g,h)', - ], - 'SupportIpv6' => [ - 'description' => 'Indicates whether IPv6 traffic is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'InternetEgressAddress' => [ - 'description' => 'The outbound public IP address.'."\n", - 'type' => 'string', - 'example' => '47.241.89.244', - ], - 'CreatedTime' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2021-10-22 15:36:53.0', - ], - 'InstanceSpecAttributes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SpecAttribute' => [ - 'description' => 'The instance specification details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The variable value.'."\n", - 'type' => 'string', - 'example' => '99.95%', - ], - 'LocalName' => [ - 'description' => 'The variable name.'."\n", - 'type' => 'string', - 'example' => 'SLA', - ], - ], - ], - ], - ], - ], - 'UserVswitchId' => [ - 'description' => 'The user vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-t4***eh****d7q****i2f', - ], - 'AclName' => [ - 'description' => 'The name of the access control list (ACL).'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AclType' => [ - 'description' => 'The ACL type. Valid values:'."\n" - ."\n" - .'* black: blacklist'."\n" - .'* white: whitelist'."\n", - 'type' => 'string', - 'example' => 'white', - ], - 'AclStatus' => [ - 'description' => 'Indicates whether the ACL is enabled. Valid values:'."\n" - ."\n" - .'* **on**'."\n" - .'* **off**'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'AclId' => [ - 'description' => 'The ACL ID.'."\n", - 'type' => 'string', - 'example' => 'acl-uf6f9zfxfxtp5j9ng3yv4', - ], - 'IntranetSegments' => [ - 'description' => 'The internal CIDR block that is allowed to access the API Gateway instance.'."\n", - 'type' => 'string', - 'example' => '[\\"172.36.0.0/16\\",\\"172.31.16.0/20\\"]', - ], - 'IPV6AclName' => [ - 'description' => 'The name of the IPv6 ACL.'."\n", - 'type' => 'string', - 'example' => 'testIPV6', - ], - 'IPV6AclId' => [ - 'description' => 'The ID of the IPv6 ACL.'."\n", - 'type' => 'string', - 'example' => 'acl-124resFfs235', - ], - 'IPV6AclType' => [ - 'description' => 'The type of the IPv6 ACL. Valid values:'."\n" - ."\n" - .'* black: blacklist'."\n" - .'* white: whitelist'."\n", - 'type' => 'string', - 'example' => 'black', - ], - 'IPV6AclStatus' => [ - 'description' => 'Indicates whether the IPv6 ACL is enabled. Valid values:'."\n" - ."\n" - .'* **on**'."\n" - .'* **off**'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'DedicatedInstanceType' => [ - 'description' => 'The type of the dedicated instance. Valid values:'."\n" - ."\n" - .'* vpc_connect: VPC integration instance'."\n" - .'* normal: conventional dedicated instance'."\n", - 'type' => 'string', - 'example' => 'vpc_connect', - ], - 'InstanceCidrBlock' => [ - 'description' => 'The CIDR block of the dedicated instance.'."\n" - ."\n" - .'* 172.16.0.0/12'."\n" - .'* 192.168.0.0/16'."\n", - 'type' => 'string', - 'example' => '192.168.0.0/16', - ], - 'ConnectVpcId' => [ - 'description' => 'The ID of the user\'s VPC if the instance is a VPC integration instance.'."\n", - 'type' => 'string', - 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg', - ], - 'NetworkInterfaceAttributes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'NetworkInterfaceAttribute' => [ - 'description' => 'The network information of the user\'s VPC if the instance is a VPC integration instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VswitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-2zeqals6rbj51bhjn8b89', - ], - 'SecurityGroupId' => [ - 'description' => 'The security group ID. Services in the same security group can access each other.'."\n", - 'type' => 'string', - 'example' => 'sg-2zeehz13zcyj1kfk3o85', - ], - 'CidrBlock' => [ - 'description' => 'The CIDR block of the vSwitch.'."\n", - 'type' => 'string', - 'example' => '192.168.17.0/24', - ], - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen-d', - ], - ], - ], - ], - ], - ], - 'InstanceClusterId' => [ - 'description' => 'The ID of the cluster to which the dedicated instance cluster belongs.'."\n", - 'type' => 'string', - 'example' => 'apigateway-cluster-sh-1523cafbgffd', - ], - 'MaintainStartTime' => [ - 'description' => 'The start time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '22:00Z', - ], - 'MaintainEndTime' => [ - 'description' => 'The end time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '01:00Z', - ], - 'ConnectCidrBlocks' => [ - 'description' => 'The internal CIDR block of the user\'s VPC that can be accessed if the instance is a VPC integration instance.'."\n", - 'type' => 'string', - 'example' => '[\\"172.16.0.0/24\\",\\"172.16.1.0/24\\"]', - ], - 'PrivateDnsList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PrivateDns' => [ - 'description' => 'The private DNS list.', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The private DNS.', - 'example' => 'www.private.com', - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagInfo' => [ - 'description' => 'The tags of the instance.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'description' => 'The tag key of the instance.'."\n", - 'example' => 'Cookie', - ], - 'Value' => [ - 'type' => 'string', - 'description' => 'The tag value of the instance.'."\n", - 'example' => '240', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'BackendId' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'example' => '0d105f80a8f340408bd34954d4e4ff22', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '66D84355-164D-53ED-81FF-03DCF181DE24', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"多可用区 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' => 'DescribeInstances', - ], - 'ModifyIntranetDomainPolicy' => [ - 'summary' => 'Modifies the VPC domain name policy of an API group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackendId\\": \\"0d105f80a8f340408bd34954d4e4ff22\\",\\n \\"RequestId\\": \\"66D84355-164D-53ED-81FF-03DCF181DE24\\"\\n}","type":"json"}]', + 'title' => 'CreateBackend', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackend'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateBackend', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateBackendModel' => [ + 'summary' => 'Creates a backend service configuration for an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '192821', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'Backend ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '34e94fcd3e2e47a49824a89b8f92cb5e', 'title' => ''], ], [ - 'name' => 'VpcIntranetEnable', + 'name' => 'BackendType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the VPC domain name. Valid values:'."\n" - ."\n" - .'* TRUE'."\n" - .'* FALSE'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'Backend type', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'Specify the environment where you want to manage the API.'."\n" + ."\n" + .'- **RELEASE**: Production'."\n" + ."\n" + .'- **PRE**: Pre-release'."\n" + ."\n" + .'- **TEST**: Test', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], + ], + [ + 'name' => 'BackendModelData', + 'in' => 'query', + 'schema' => ['description' => 'Backend model data', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{\\"ServiceAddress\\":\\"http://apigateway.alicloudapi.com:8080\\"}', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Backend model description', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'model description', 'title' => ''], ], ], 'responses' => [ @@ -2471,29 +1988,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'BackendModelId' => ['description' => 'Backend model ID', 'type' => 'string', 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', - 'title' => 'ModifyIntranetDomainPolicy', - ], - 'CreateApiGroup' => [ - 'summary' => 'Creates an API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateBackendModel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackendModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Creates a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2503,83 +2033,55 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '94264', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREapigatewayE6KZ22'], ], 'parameters' => [ [ - 'name' => 'GroupName', + 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Weather', - ], + 'schema' => ['description' => 'Dataset name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DatasetName', 'title' => ''], ], [ - 'name' => 'BasePath', + 'name' => 'DatasetType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '/qqq', - ], + 'schema' => ['description' => 'Dataset type. Valid values:'."\n" + ."\n" + .'- JWT\\_BLOCKING: JWT blacklist'."\n" + ."\n" + .'- IP\\_WHITELIST\\_CIDR: IP address whitelist'."\n" + ."\n" + .'- PARAMETER\\_ACCESS: parameter access control', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'JWT_BLOCKING', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'The weather informations.', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'Object tags to which the rule applies. You can specify multiple tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'Tag key', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 500, + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -2588,126 +2090,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TagStatus' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'BasePath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/qqq', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FF3B7D81-66AE-47E0-BF69-157DCF187514', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The weather informations', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Weather', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726c2a7xx', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], - 'SubDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VPC_SHARED', - ], + 'DatasetId' => ['description' => 'Dataset ID', 'type' => 'string', 'example' => 'a25a6589b2584ff490e891cc********', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A96********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<SubDomain>523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com</SubDomain>\\n<GroupName>Weather</GroupName>\\n<Description>The weather informations</Description>\\n<RequestId>FF3B7D81-66AE-47E0-BF69-157DCF187514</RequestId>\\n<InstanceId>apigateway-cn-v6419k43xxxxx</InstanceId>\\n<InstanceType>VPC_SHARED</InstanceType>\\n<GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>","errorExample":""}]', - 'title' => 'CreateApiGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteApiGroup' => [ - 'summary' => 'Deletes an API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Create a data item for a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94285', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'Dataset ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'Value', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'value', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 500, - ], + 'schema' => ['description' => 'Data value. Enter the corresponding data value based on the dataset type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '106.43.XXX.XXX', 'title' => ''], + ], + [ + 'name' => 'ExpiredTime', + 'in' => 'query', + 'schema' => ['description' => 'Data item expiration time. Format: **yyyy-MM-ddTHH:mm:ssZ (UTC time)**. If empty, the item never expires.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-09-22T12:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Description, up to 180 characters.', 'type' => 'string', 'example' => 'Description', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -2715,229 +2161,195 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', - ], + 'DatasetItemId' => ['description' => 'Dataset item ID', 'type' => 'string', 'example' => '5045****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '8A5E2053-4D9F-5280-B7A9-D357********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99\\"\\n}","type":"json"}]', - 'title' => 'DeleteApiGroup', - 'description' => '* This operation is intended for API providers.'."\n" - .'* An API group that contains APIs cannot be deleted. To delete the API group, you must first delete its APIs.'."\n" - .'* After an API group is deleted, the second-level domain name bound to the API group is automatically invalidated.'."\n" - .'* If the specified API group does not exist, a success response is returned.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyApiGroup' => [ - 'summary' => 'Modifies the name, description, or basepath of an existing API group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"RequestId\\": \\"8A5E2053-4D9F-5280-B7A9-D357********\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetItem', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateDatasetItem', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateInstance' => [ + 'summary' => 'Creates an API Gateway instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94431', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The API group name must be globally unique. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\\_). If this parameter is not specified, the group name is not modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NewWeather', - ], - ], - [ - 'name' => 'BasePath', + 'name' => 'ChargeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The root path of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/eeee', - ], + 'schema' => ['description' => 'The billing method of the instance. Valid values: PostPaid (pay-as-you-go) and PrePaid (subscription).', 'type' => 'string', 'example' => 'PostPaid', 'required' => true, 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The API group description that you want to specify, which cannot exceed 180 characters. If this parameter is not specified, the group description is not modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'New weather informations.', - ], + 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ApigatewayInstance', 'title' => ''], ], [ - 'name' => 'UserLogConfig', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The user log configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"requestBody\\":false,\\"responseBody\\":false,\\"queryString\\":\\"\\",\\"requestHeaders\\":\\"\\",\\"responseHeaders\\":\\"\\",\\"jwtClaims\\":\\"\\"}', - ], + 'schema' => ['description' => 'The instance type.', 'type' => 'string', 'required' => true, 'example' => 'api.s1.small', 'title' => ''], ], [ - 'name' => 'CustomTraceConfig', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom trace configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}', - ], + 'schema' => ['description' => 'The zone where the instance is deployed. This parameter is required for classic network-type dedicated instances. This parameter is optional for VPC-connected dedicated instances.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-MAZ3(c,e)', 'title' => ''], ], [ - 'name' => 'CompatibleFlags', + 'name' => 'HttpsPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of associated tags. Separate multiple tags with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'depart:dep1', - ], + 'schema' => ['description' => 'The HTTPS policy.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTTPS2_TLS1_2', 'title' => ''], ], [ - 'name' => 'CustomerConfigs', + 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => 'The data of custom configuration items.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'removeResponseServerHeader', - ], + 'schema' => ['description' => 'The subscription duration of the instance. Valid values:'."\n" + ."\n" + .'- If PricingCycle is set to **Month**, the valid values are **1** to **9**.'."\n" + ."\n" + .'- If PricingCycle is set to **Year**, the valid values are **1** to **3**.'."\n" + ."\n" + .'> This parameter is required and takes effect only if you set ChargeType to **PrePaid**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PassthroughHeaders', + 'name' => 'PricingCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to pass headers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eagleeye-rpcid,x-b3-traceid,host', - ], + 'schema' => ['description' => 'The billing cycle of the subscription instance. Valid values:'."\n" + ."\n" + .'- **year**'."\n" + ."\n" + .'- **month**'."\n" + ."\n" + .'> This parameter is required if you set ChargeType to PrePaid.', 'type' => 'string', 'required' => false, 'default' => 'month', 'example' => 'Month', 'title' => ''], ], [ - 'name' => 'DefaultDomain', + 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'description' => 'The default domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mkt.api.gaore.com', - ], + 'schema' => ['description' => 'Specifies whether to enable auto-payment for renewals. Valid values:'."\n" + ."\n" + .'- **True**: Auto-payment is enabled. Make sure that your account has a sufficient balance.'."\n" + ."\n" + .'- False: Manual payment is required. To pay for an order, log on to the console. In the upper-right corner, choose **Billing** > **User Center**. On the **Order Management** page, find the order and complete the payment.'."\n" + ."\n" + .'Default value: **False**.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'RpcPattern', + 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => 'The RPC mode.', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'A security token used to prevent duplicate requests. Do not reuse the token. The gateway automatically removes leading and trailing spaces from the token string.', 'type' => 'string', 'required' => true, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", + 'description' => 'A list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tags that are attached to the resources.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'uat', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 500, - 'example' => 'Key, Value', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SupportSSE', + 'name' => 'InstanceType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'If support SSE.', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The type of the dedicated instance.'."\n" + ."\n" + .'- vpc\\_connect: a VPC-connected dedicated instance'."\n" + ."\n" + .'- normal: a classic network-type dedicated instance'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'This parameter is available only for invitational preview and is not publicly available.'."\n" + ."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'vpc_connect', 'title' => ''], ], [ - 'name' => 'FilterAppCodeForBackend', + 'name' => 'InstanceCidr', 'in' => 'query', - 'schema' => [ - 'description' => 'If filter AppCode for backend.', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The CIDR block of the instance if the instance is a VPC-connected dedicated instance.'."\n" + ."\n" + .'- 192.168.0.0/16'."\n" + ."\n" + .'- 172.16.0.0/12'."\n" + ."\n" + .'><warning>The VPC-connected dedicated instance connects to the specified CIDR block. To prevent IP address conflicts, make sure that the CIDR block does not overlap with the private IP addresses of your Alibaba Cloud services.></warning>'."\n" + .'><notice>This parameter is available only for invitational preview and is not publicly available.></notice>', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/12', 'title' => ''], ], [ - 'name' => 'CustomAppCodeConfig', + 'name' => 'UserVpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom appcode configuration.', - 'type' => 'string', - 'required' => false, - 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}', - ], + 'schema' => ['description' => 'The ID of the user VPC to which you want to connect. This parameter is required if the instance is a VPC-connected dedicated instance. ><notice>This parameter is available only for invitational preview and is not publicly available.></notice>', 'type' => 'string', 'required' => false, 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg'."\n", 'title' => ''], ], [ - 'name' => 'RpsLimitForServerless', + 'name' => 'ZoneVSwitchSecurityGroup', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The zone, vSwitch, and security group information required for network connectivity. This parameter is required if the instance is a VPC-connected dedicated instance. ><notice>This parameter is available only for invitational preview and is not publicly available.></notice>', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-c', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-0xi349n11cxogmvm866tb', 'title' => ''], + 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => '192.168.9.0/24', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group. Services in the same security group can access each other.', 'type' => 'string', 'required' => false, 'example' => 'sg-2ze2ql9nozv8q7kmlt6e', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 3, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], @@ -2946,115 +2358,115 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4CF287C6-CE5B-477B-BE27-C48F99EADBC8', - ], - 'BasePath' => [ - 'description' => 'The root path of the API.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which an API belongs.'."\n", - 'type' => 'string', - 'example' => 'NewWeather', - ], - 'Description' => [ - 'description' => 'The description of the API group.'."\n", - 'type' => 'string', - 'example' => 'New weather informations.', - ], - 'SubDomain' => [ - 'description' => 'The second-level domain name automatically assigned to the API group.'."\n", - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com', - ], + 'TagStatus' => ['description' => 'Indicates whether the tag exists. Valid values are \\`true\\` and \\`false\\`.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'apigateway-hz-b3c5dadd5***', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<ModifyApiGroupResponse>\\r\\n <RequestId>4CF287C6-CE5B-477B-BE27-C48F99EADBC8</RequestId>\\r\\n <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>\\r\\n <GroupName>NewWeather</GroupName>\\r\\n <SubDomain>523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>New weather informations.</Description>\\r\\n</ModifyApiGroupResponse>","errorExample":""}]', - 'title' => 'ModifyApiGroup', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApiGroup' => [ - 'summary' => 'You can call this operation to query details about an API group, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagStatus\\": true,\\n \\"InstanceId\\": \\"apigateway-hz-b3c5dadd5***\\",\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', + 'title' => 'CreateInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateIpControl' => [ + 'summary' => 'Creates an access control list (ACL) in a region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94311', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94273', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'IpControlName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'The name of the ACL. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (\\_). The name cannot start with an underscore (\\_).\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'controlNameTest', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'IpControlType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the ACL. Valid values:'."\n" + ."\n" + .'- **ALLOW**: an IP address whitelist'."\n" + ."\n" + .'- **REFUSE**: an IP address blacklist', 'type' => 'string', 'required' => true, 'example' => 'ALLOW', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description. The description can be up to 200 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'IpControlPolicys', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", + 'description' => 'The information about the policies. The information is an array of ipcontrolpolicys data.', 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appname', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_app', - ], + 'AppId' => ['description' => 'The ID of the application that is restricted by the policy. You can configure the AppId parameter only when the value of the IpControlType parameter is ALLOW.'."\n" + ."\n" + .'- You can add only one application ID at a time.'."\n" + ."\n" + .'- If this parameter is empty, no applications are restricted.'."\n" + ."\n" + .'- If this parameter is not empty, not only IP addresses but also applications are restricted.'."\n" + ."\n" + .'- If this parameter is not empty and no security authentication method is specified for the API, all API calls are restricted.'."\n" + ."\n" + .'- If the value of the IpControlType parameter is REFUSE and the AppId parameter is not empty, API Gateway automatically ignores the AppId parameter and restricts only the IP addresses.'."\n" + ."\n" + .'- Valid values of N in IpControlPolicys.N: `[1,100]`.', 'type' => 'string', 'required' => false, 'example' => '11111', 'title' => ''], + 'CidrIp' => ['description' => 'The IP address or CIDR block involved in a policy.'."\n" + ."\n" + .'- If you want to specify a policy when you create an ACL, this parameter is required.'."\n" + ."\n" + .'- The IP address or CIDR block that is defined in each policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks.'."\n" + ."\n" + .'- Valid values of N in IpControlPolicys.N: `[1,100]`.', 'type' => 'string', 'required' => false, 'example' => '114.1.1.0/24', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 500, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -3063,486 +2475,191 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the API group.'."\n" - ."\n" - .'* **NORMAL**: The API group is normal.'."\n" - .'* **DELETE**: The API group is deleted.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'CompatibleFlags' => [ - 'description' => 'The list of associated tags. Separate multiple tags with commas (,).'."\n", - 'type' => 'string', - 'example' => 'depart:dep1', - ], - 'BasePath' => [ - 'description' => 'The root path of the API.'."\n", - 'type' => 'string', - 'example' => '/qqq', - ], - 'Ipv6Status' => [ - 'description' => 'The IPv6 status.'."\n", - 'type' => 'string', - 'example' => 'UNBIND', - ], - 'UserLogConfig' => [ - 'description' => 'The user log settings.'."\n", - 'type' => 'string', - 'example' => '{\\"requestBody\\":true,\\"responseBody\\":true,\\"queryString\\":\\"test\\",\\"requestHeaders\\":\\"test\\",\\"responseHeaders\\":\\"test\\",\\"jwtClaims\\":\\"test\\"}', - ], - 'CustomerConfigs' => [ - 'description' => 'The list of custom configuration items.'."\n", - 'type' => 'string', - 'example' => 'removeResponseServerHeader', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519', - ], - 'Description' => [ - 'description' => 'The description of the API group.'."\n", - 'type' => 'string', - 'example' => 'New weather informations.', - ], - 'HttpsPolicy' => [ - 'description' => 'The HTTPS policy.'."\n", - 'type' => 'string', - 'example' => 'HTTPS2_TLS1_0', - ], - 'SubDomain' => [ - 'description' => 'The second-level domain name automatically assigned to the API group.'."\n", - 'type' => 'string', - 'example' => '27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the API group.'."\n", - 'type' => 'string', - 'example' => '2016-08-01T06:53:02Z', - ], - 'DefaultDomain' => [ - 'description' => 'The default domain name.'."\n", - 'type' => 'string', - 'example' => 'mkt.api.gaore.com', - ], - 'CmsMonitorGroup' => [ - 'description' => 'The CloudMonitor application group.'."\n", - 'type' => 'string', - 'example' => '217008423', - ], - 'BillingStatus' => [ - 'description' => 'The billing status of the API group.'."\n" - ."\n" - .'* **NORMAL**: The API group is normal.'."\n" - .'* **LOCKED**: The API group is locked due to overdue payments.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'TrafficLimit' => [ - 'description' => 'The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'PassthroughHeaders' => [ - 'description' => 'Specifies whether to pass headers.'."\n", - 'type' => 'string', - 'example' => 'eagleeye-rpcid,x-b3-traceid', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'apigateway-cn-v6419k43xxxxx', - ], - 'VpcDomain' => [ - 'description' => 'The VPC domain name.'."\n", - 'type' => 'string', - 'example' => 'e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com', - ], - 'InstanceType' => [ - 'description' => 'The type of the instance.'."\n" - ."\n" - .'* CLASSIC_SHARED: shared instance that uses the classic network configuration'."\n" - .'* VPC_SHARED: shared instance that uses VPC'."\n" - .'* VPC_DEDICATED: dedicated instance that uses VPC'."\n", - 'type' => 'string', - 'example' => 'VPC_SHARED', - ], - 'CustomTraceConfig' => [ - 'description' => 'The custom trace configuration.'."\n", - 'type' => 'string', - 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}', - ], - 'RegionId' => [ - 'description' => 'The region to which the API group belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the API group.'."\n", - 'type' => 'string', - 'example' => '2016-08-01T06:54:32Z', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'NewWeather', - ], - 'IllegalStatus' => [ - 'description' => 'The validity status of the API group. Valid values:'."\n" - ."\n" - .'* **NORMAL**: The API group is normal.'."\n" - .'* **LOCKED**: The API group is locked because it is not valid.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'VpcSlbIntranetDomain' => [ - 'description' => 'The VPC SLB domain name.'."\n", - 'type' => 'string', - 'example' => '257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com', - ], - 'CustomDomains' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DomainItem' => [ - 'description' => 'The details about the custom domain name.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom domain name information.'."\n", - 'type' => 'object', - 'properties' => [ - 'BindStageName' => [ - 'description' => 'The environment in which the associated API group runs.'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'DomainLegalStatus' => [ - 'description' => 'The validity status of the domain name. Valid values:'."\n" - ."\n" - .'* **NORMAL**: The domain name is valid.'."\n" - .'* **ABNORMAL**: The domain name is invalid. This status affects API calls and needs to be rectified as soon as possible.'."\n", - 'type' => 'string', - 'example' => 'ABNORMAL', - ], - 'CertificateName' => [ - 'description' => 'The name of the SSL certificate.'."\n", - 'type' => 'string', - 'example' => 'myCertificate', - ], - 'CustomDomainType' => [ - 'description' => 'The type of the custom domain name.'."\n", - 'type' => 'string', - 'example' => 'intranet', - ], - 'DomainCNAMEStatus' => [ - 'description' => 'The domain name resolution status. Valid values:'."\n" - ."\n" - .'* **RESOLVED**'."\n" - .'* **UNRESOLVED**'."\n", - 'type' => 'string', - 'example' => 'RESOLVED', - ], - 'WildcardDomainPatterns' => [ - 'description' => 'The wildcard domain name mode.'."\n", - 'type' => 'string', - 'example' => '[\\"{test}.test.com\\"]', - ], - 'DomainBindingStatus' => [ - 'description' => 'The binding status of the custom domain name. Valid values:'."\n" - ."\n" - .'* **BINDING**: The domain name is bound.'."\n" - .'* **BOUND**: The domain name is not bound.'."\n", - 'type' => 'string', - 'example' => 'BINDING', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'api.demo.com', - ], - 'DomainRemark' => [ - 'description' => 'Remarks about the domain name, such as the cause of an exception.'."\n", - 'type' => 'string', - 'example' => 'Indicates that the domain name does not have an ICP filing.'."\n", - ], - 'DomainWebSocketStatus' => [ - 'description' => 'The status of the domain that uses the WebSocket feature.'."\n", - 'type' => 'string', - 'example' => 'CLOSE', - ], - 'CertificateId' => [ - 'description' => 'The SSL certificate ID, which is automatically generated by the system.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'IsHttpRedirectToHttps' => [ - 'description' => 'Indicates whether to redirect HTTP requests to HTTPS.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CertificateValidStart' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1689043476000', - ], - 'CertificateValidEnd' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2635123476000', - ], - 'BindStageAlias' => [ - 'description' => 'The alias of the associated environment.'."\n", - 'type' => 'string', - 'example' => 'TEST1', - ], - 'SslVerifyDepth' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SslOcspEnable' => [ - 'type' => 'boolean', - ], - 'SslOcspCacheEnable' => [ - 'type' => 'boolean', - ], - 'ClientCertSDnPassThrough' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'StageItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'StageInfo' => [ - 'description' => 'The runtime environment information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime environment information.'."\n", - 'type' => 'object', - 'properties' => [ - 'StageId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => '123e8dc7bbe01613b5b1d726c2a7888e', - ], - 'StageName' => [ - 'description' => 'The environment name.'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'Description' => [ - 'description' => 'The environment description.'."\n", - 'type' => 'string', - 'example' => 'MYTEST', - ], - ], - ], - ], - ], - ], - 'CloudMarketCommodity' => [ - 'description' => 'The products on Alibaba Cloud Marketplace.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DedicatedInstanceType' => [ - 'description' => 'The type of exclusive instance where the group is located'."\n" - ."\n" - .'- VPC fusion type exclusive instance: vpc_connect'."\n" - .'- Traditional type exclusive instance: normal', - 'type' => 'string', - 'example' => 'normal', - ], - 'MigrationStatus' => [ - 'description' => 'Group migration instance task status'."\n" - ."\n" - .'- Running'."\n" - .'- Success'."\n" - .'- Failed', - 'type' => 'string', - 'example' => 'Fail', - ], - 'MigrationError' => [ - 'description' => 'The reason for the failure of the group migration instance task. When the value of the MigrationStatus parameter is Failed, it is not empty.', - 'type' => 'string', - 'example' => 'The current instance conflicts with the target instance.', - ], - 'DisableInnerDomain' => [ - 'description' => 'Indicates whether access over the public second-level domain name is enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CustomAppCodeConfig' => [ - 'type' => 'string', - 'description' => 'The custom appcode configuration.', - 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}', - ], + 'IpControlId' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"该域名未备案\\",\\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":"<DescribeApiGroupResponse>\\r\\n <RequestId>03442A3D-3B7D-434C-8A95-A5FEB989B519</RequestId>\\r\\n <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>\\r\\n <GroupName>NewWeather</GroupName>\\r\\n <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>New weather informations.</Description>\\r\\n <CreatedTime>2016-08-01T06:53:02Z</CreatedTime>\\r\\n <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <Status>NORMAL</Status>\\r\\n <BillingStatus>NORMAL</BillingStatus>\\r\\n <IllegalStatus>NORMAL</IllegalStatus>\\r\\n <TrafficLimit>500</TrafficLimit>\\r\\n <CustomDomains>\\r\\n <CustomDomain>\\r\\n <DomainName>api.demo.com</DomainName>\\r\\n <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>\\r\\n <CertificateName>myCertificate</CertificateName>\\r\\n <DomainNameResolution>RESOLVED</DomainNameResolution>\\r\\n <DomainStatus>BINDING</DomainStatus>\\r\\n <DomainLegalStatus>ABNORMAL</DomainLegalStatus>\\r\\n <DomainRemark>该域名未备案</DomainRemark>\\r\\n </CustomDomain>\\r\\n </CustomDomains>\\r\\n <StageItems>\\r\\n <StageInfo>\\r\\n <StageId>123e8dc7bbe01613b5b1d726c2a7887e</StageId>\\r\\n <StageName>RELEASE</StageName>\\r\\n <Description>MYRELEASE</Description>\\r\\n </StageInfo>\\r\\n <StageInfo>\\r\\n <StageId>123e8dc7bbe01613b5b1d726c2a7888e</StageId>\\r\\n <StageName>TEST</StageName>\\r\\n <Description>MYTEST</Description>\\r\\n </StageInfo>\\r\\n </StageItems>\\r\\n</DescribeApiGroupResponse>","errorExample":""}]', - 'title' => 'DescribeApiGroup', - 'description' => '* This operation is intended for API providers.'."\n", + 'title' => 'CreateIpControl', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- An ACL must be bound to an API to take effect. After an ACL is bound to an API, the ACL takes effect on the API immediately.'."\n" + ."\n" + .'- You can add policies to an ACL when you create the ACL.'."\n" + ."\n" + .'- If an ACL does not have any policy, the ACL is ineffective.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApiGroups' => [ - 'summary' => 'Queries existing API groups and their basic information.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIpControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateIpControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpControlId\\": \\"7ea91319a34d48a09b5c9c871d9768b1\\",\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]', + ], + 'CreateLogConfig' => [ + 'summary' => 'Creates a Simple Log Service configuration for an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94313', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94274', + 'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'SlsProject', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164', - ], + 'schema' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'rec-lq-sls', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'SlsLogStore', + 'in' => 'query', + 'schema' => ['description' => 'slslogstore', 'type' => 'string', 'required' => true, 'example' => 'api-gateway', 'title' => ''], + ], + [ + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => 'The keyword that can be specified in the name of the API group.'."\n", + 'description' => 'The log type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- PROVIDER', 'type' => 'string', 'required' => false, - 'example' => 'Traffic', + 'default' => 'PROVIDER', + 'enum' => ['PROVIDER'], + 'example' => 'PROVIDER', + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'CreateSlr', 'in' => 'query', + 'schema' => ['description' => 'Specifies to create a service-linked role.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CreateLogConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLogConfig'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 50. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', + ], + 'CreateModel' => [ + 'summary' => 'Creates a model for an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableTagAuth', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94275', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], + ], + 'parameters' => [ + [ + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable tag verification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the model. The name must be unique within the group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'apigateway-cn-v6419k43245xx', - ], + 'schema' => ['description' => 'The ID of the API group to which the model belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], ], [ - 'name' => 'Sort', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The order. Valid values: asc and desc. Default value: desc.'."\n" - ."\n" - .'* asc: The API groups are displayed in ascending order of modification time.'."\n" - .'* desc: The API groups are displayed in descending order of modification time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The definition of the model in 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"}}}', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the model definition.', 'type' => 'string', 'required' => false, 'example' => 'Model Description', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The values of the tag.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'BasePath', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The root path of the API.'."\n", - 'example' => ' /edmdgp/service20250116management01/v1', + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -3551,193 +2668,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The number of pages to return the results on.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ApiGroupAttributes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiGroupAttribute' => [ - 'description' => 'The returned group set.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BasePath' => [ - 'description' => 'The basepath.'."\n", - 'type' => 'string', - 'example' => '/v2/', - ], - 'BillingStatus' => [ - 'description' => 'The billing status of the API group. Valid values:'."\n" - ."\n" - .'* **NORMAL**: The instance is normal.'."\n" - .'* **LOCKED**: The API group is locked due to overdue payments.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'TrafficLimit' => [ - 'description' => 'The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'apigateway-cn-v6419k43245xx', - ], - 'InstanceType' => [ - 'description' => 'The type of the instance.'."\n", - 'type' => 'string', - 'example' => 'VPC_SHARED', - ], - 'RegionId' => [ - 'description' => 'The region to which the API group belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the API group.'."\n", - 'type' => 'string', - 'example' => '2016-08-01T08:45:15Z', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'Traffic', - ], - 'Description' => [ - 'description' => 'Group Description'."\n", - 'type' => 'string', - 'example' => 'TrafficInformations.', - ], - 'IllegalStatus' => [ - 'description' => 'The validity status of the API group. Valid values:'."\n" - ."\n" - .'* **NORMAL**: The instance is normal.'."\n" - .'* **LOCKED**: The API group is locked because it is not valid.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'HttpsPolicy' => [ - 'description' => 'The HTTPS security policy'."\n", - 'type' => 'string', - 'example' => 'HTTPS2_TLS1_0', - ], - 'SubDomain' => [ - 'description' => 'The second-level domain name that corresponds to the API group and is used by the CNAME of the custom domain name.'."\n", - 'type' => 'string', - 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the API group.'."\n", - 'type' => 'string', - 'example' => '2016-08-01T08:45:15Z', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagInfo' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'ModifiedTime' => ['description' => 'The time when the model is last modified.', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', 'title' => ''], + 'Description' => ['description' => 'The description of the created model.', 'type' => 'string', 'example' => 'Model Description', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group to which the created model belongs.', 'type' => 'string', 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], + 'Schema' => ['description' => 'The definition of the created model.', 'type' => 'string', 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', 'title' => ''], + 'ModelName' => ['description' => 'The name of the created model.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the model was created.', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z', 'title' => ''], + 'ModelId' => ['description' => 'The ID of the created model.', 'type' => 'string', 'example' => '766c0b9538a04bdf974953b5576783ba', 'title' => ''], + 'RegionId' => ['description' => 'The region to which the created model belongs.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'ModelRef' => ['description' => 'The URI of the created model.', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiGroupsResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n <TotalCount>2</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiGroupAttributes>\\r\\n <ApiGroupAttribute>\\r\\n <GroupId>be6d2abcc0dd4f749fc2d2edd6567164</GroupId>\\r\\n <GroupName>Traffic</GroupName>\\r\\n <SubDomain>be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>TrafficInformations.</Description>\\r\\n <CreatedTime>2016-08-01T08:45:15Z</CreatedTime>\\r\\n <ModifiedTime>2016-08-01T08:45:15Z</ModifiedTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <TrafficLimit>500</TrafficLimit>\\r\\n <BillingStatus>NORMAL</BillingStatus>\\r\\n <IllegalStatus>NORMAL</IllegalStatus>\\r\\n </ApiGroupAttribute>\\r\\n <ApiGroupAttribute>\\r\\n <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>\\r\\n <GroupName>NewWeather</GroupName>\\r\\n <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>NewWeatherInformations.</Description>\\r\\n <CreatedTime>2016-08-01T06:54:32Z</CreatedTime>\\r\\n <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <TrafficLimit>500</TrafficLimit>\\r\\n <BillingStatus>NORMAL</BillingStatus>\\r\\n <IllegalStatus>NORMAL</IllegalStatus>\\r\\n </ApiGroupAttribute>\\r\\n </ApiGroupAttributes>\\r\\n</DescribeApiGroupsResponse>","errorExample":""}]', - 'title' => 'DescribeApiGroups', - 'description' => '* This operation is intended for API providers.'."\n", + 'title' => 'CreateModel', + 'description' => '- For more information about the model definition, see [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04?spm=a2c4g.11186623.2.10.2e977ff7p4BpQd).'."\n" + ."\n" + .'- JSON Schema supports only element attributes of the Object type.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribePurchasedApiGroup' => [ - 'summary' => 'Queries the details about an API group purchased from Alibaba Cloud Marketplace.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'CreateMonitorGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94387', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94276', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '102b631ae1094e33a77c45312226184e', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6735211ab9094c818f32f27bc545b6c8', 'title' => ''], + ], + [ + 'name' => 'RawMonitorGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the monitoring group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '166636221', 'title' => ''], + ], + [ + 'name' => 'Auth', + 'in' => 'query', + 'schema' => ['description' => 'The caller authentication status of the API. Valid values: **ok**: The authentication is successful. **mismatch**: The request is redirected. **servicenotfound**: A request error occurred. **Unknown**: An unknown error occurred.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -3745,117 +2750,123 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the API group.'."\n" - ."\n" - .'* **NORMAL**: The API group is normal.'."\n" - .'* **DELETE**: The API group is deleted.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'PurchasedTime' => [ - 'description' => 'The time when the API group was purchased.'."\n", - 'type' => 'string', - 'example' => '2021-12-19T00:00:00', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '48977d7b96074966a7c9c2a8872d7e06', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'Weather', - ], - 'Description' => [ - 'description' => 'The description of the API group.'."\n", - 'type' => 'string', - 'example' => 'api group description', - ], - 'RegionId' => [ - 'description' => 'The region where the API group is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Domains' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DomainItem' => [ - 'description' => 'The list of domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of domain names.'."\n", - 'type' => 'object', - 'properties' => [ - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'test_domain.com', - ], - ], - ], - ], - ], - ], + 'MonitorGroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and is unique globally.', 'type' => 'integer', 'format' => 'int64', 'example' => '187421794', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5D7136F7-9D67-5D4D-8418-6A512CCEE3A2', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribePurchasedApiGroup', - ], - 'DescribePurchasedApiGroups' => [ - 'summary' => 'Queries the API groups purchased from Alibaba Cloud Marketplace.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateMonitorGroup', + 'summary' => 'Enables CloudMonitor alerting for a specified API group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2', 'countWindow' => 5, 'regionId' => '*', 'api' => 'CreateMonitorGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94388', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94278', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'PluginName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). However, it cannot start with an underscore.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NewCors', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PluginType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the plug-in. Valid values:'."\n" + ."\n" + .'- **ipControl: IP address-based access control**'."\n" + ."\n" + .'- **trafficControl: throttling**'."\n" + ."\n" + .'- **backendSignature: backend signature**'."\n" + ."\n" + .'- **jwtAuth** :JWT (OpenId Connect) authentication'."\n" + ."\n" + .'- **cors** :cross-origin resource sharing (CORS)'."\n" + ."\n" + .'- **caching**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cors', 'title' => ''], + ], + [ + 'name' => 'PluginData', + 'in' => 'query', + 'schema' => ['description' => 'The plug-in definition. Supported formats: JSON and 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', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the plug-in. The description can contain a maximum of 200 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'createPlugin', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => '\' \'', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '20', + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], ], @@ -3864,230 +2875,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PurchasedApiGroupAttributes' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PurchasedApiGroupAttribute' => [ - 'description' => 'The attributes of the API group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The attributes of the API group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the API group.'."\n" - ."\n" - .'* **NORMAL**: The API group is normal.'."\n" - .'* **DELETE**: The API group is deleted.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'PurchasedTime' => [ - 'description' => 'The time when the API group was purchased.'."\n", - 'type' => 'string', - 'example' => '2021-12-19T00:00:00', - ], - 'ExpireTime' => [ - 'description' => 'The time when the API group expires.'."\n", - 'type' => 'string', - 'example' => '2021-12-19T00:00:00', - ], - 'Description' => [ - 'description' => 'The description of the API group.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'group1', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '8e91f23f88f94348855b82c9a73209f3', - ], - 'InvokeTimesMax' => [ - 'description' => 'The maximum number of calls.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'InvokeTimesNow' => [ - 'description' => 'The current number of calls.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'BillingType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'POSTPAID', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the API group is located.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - ], - ], - ], - ], - ], + 'PluginId' => ['description' => 'The ID of the plug-in.', 'type' => 'string', 'example' => '1f3bde29b43d4d53989248327ff737f2', 'title' => ''], + 'TagStatus' => ['description' => 'Indicates whether the plug-in is successfully marked.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribePurchasedApiGroups', - ], - 'DeleteDomain' => [ - 'summary' => 'Unbinds a custom domain name from an API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreatePlugin', + 'summary' => 'Creates a plug-in.', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- The number of plug-ins of the same type that each user can create is limited. Different limits apply to different plug-in types.'."\n" + ."\n" + .'- The plug-in definitions for advanced features are restricted.'."\n" + ."\n" + .'- Plug-ins must be bound to APIs to take effect. After a plug-in is bound, it takes effect on that API immediately.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'summary' => 'Creates an internal domain name resolution and adds a resolution record.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94289', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => ['description' => 'The internal domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'api.demo.com', 'title' => ''], + ], + [ + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the API group to which the domain name to be unbound is bound. This ID is generated by the system and globally unique.'."\n", + 'description' => 'The internal domain name resolution type. Valid values:'."\n" + ."\n" + .'* VPC: resolution for VPC access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" + .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', + 'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'], + 'example' => 'A', + 'title' => '', ], ], [ - 'name' => 'DomainName', - 'in' => 'query', + 'name' => 'Records', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', + 'description' => 'The resolution records. This parameter is valid only when Type is set to A.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resolution record.'."\n", + 'type' => 'object', + 'properties' => [ + 'Record' => ['description' => 'The resolution record.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.1', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDomainResponse>\\r\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\r\\n</DeleteDomainResponse>","errorExample":""}]', - 'title' => 'DeleteDomain', - 'description' => '* This operation is intended for API providers.'."\n" - .'* If the specified domain name does not exist, a successful response will still appear.'."\n" - .'* Unbinding a domain name from an API group will affect access to the APIs in the group. Exercise caution when using this operation.'."\n", - ], - 'DeleteDomainCertificate' => [ - 'summary' => 'Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]', + 'title' => 'CreatePrivateDNS', + 'description' => 'An internal domain name resolution of the virtual private cloud (VPC) type can be bound only to traditional dedicated instances. An internal domain name resolution of the A type can be bound only to VPC integration dedicated instances.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreatePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateSignature' => [ + 'summary' => 'Creates a backend signature key.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94290', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIX31M', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94280', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'SignatureName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], + 'schema' => ['description' => 'The displayed name of the key. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'backendsignature', 'title' => ''], ], [ - 'name' => 'DomainName', + 'name' => 'SignatureKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', - ], + 'schema' => ['description' => 'The Key value of the key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'qwertyuiop', 'title' => ''], ], [ - 'name' => 'CertificateId', + 'name' => 'SignatureSecret', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the SSL certificate that you want to delete. The ID is automatically generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c621720d1eb34843822b7fb5148e6926', - ], + 'schema' => ['description' => 'The Secret value of the key. The value must be 6 to 30 characters in length and can contain letters, digits, and special characters. Special characters include underscores (\\_), at signs (@), number signs (#), exclamation points (!), and asterisks (\\*). The value must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'asdfghjkl', 'title' => ''], ], ], 'responses' => [ @@ -4095,117 +3057,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'SignatureId' => ['description' => 'The ID of the back-end signature key.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'SignatureName' => ['description' => 'The name of the back-end signature key.', 'type' => 'string', 'example' => 'backendsignature', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]', - 'title' => 'DeleteDomainCertificate', - ], - 'SetDomain' => [ - 'summary' => 'Binds a custom domain name to a specified API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateSignature', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The API operation only creates a key policy. You must call the binding operation to bind the key to an API.'."\n" + ."\n" + .'- After the key is bound to the API, requests sent from API Gateway to the backend service contain signature strings. You can specify whether your backend service verifies these signature strings.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateSignature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","type":"json"}]', + ], + 'CreateStageModel' => [ + 'summary' => 'Creates a stage model.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94479', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], + 'operationType' => 'create', + 'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', - ], - ], - [ - 'name' => 'BindStageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment which you can access by using the domain name. If you do not specify this parameter, the domain name can be used to access all environments.'."\n" - ."\n" - .'If you specify an environment, the domain name can be used to access only the specified environment. Valid values:'."\n" - ."\n" - .'* TEST'."\n" - .'* PRE'."\n" - .'* RELEASE'."\n" - ."\n" - .'If you want to use the domain name to access all environments, set this parameter to an empty string ("").'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'RELEASE', - ], - ], - [ - 'name' => 'CustomDomainType', + 'name' => 'StageAlias', 'in' => 'query', - 'schema' => [ - 'description' => 'The network type of the domain name to be bound. Default value: INTERNET. Valid values:'."\n" - ."\n" - .'* INTERNET'."\n" - .'* INTRANET. If you set this parameter to this value, the domain name cannot be used on the Internet.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'INTERNET', - ], + 'schema' => ['description' => 'The stage alias.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '生产环境', 'title' => ''], ], [ - 'name' => 'IsForce', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether this binding relationship takes precedence over the binding relationships between the domain name and other API groups. If you set this parameter to true, this binding relationship takes precedence, and the domain name is automatically unbound from other API groups. This operation brings risks. Proceed with caution.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The stage name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'IsHttpRedirectToHttps', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to redirect HTTP requests to HTTPS requests.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The stage description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Model Description', 'title' => ''], ], ], 'responses' => [ @@ -4213,70 +3133,31 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231', - ], - 'DomainLegalStatus' => [ - 'description' => 'The validity status of the domain name. Valid values:'."\n" - ."\n" - .'* **NORMAL**: The domain name is valid.'."\n" - .'* **ABNORMAL**: The domain name is invalid. This status affects API calls and must be resolved as soon as possible.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '927d50c0f2e54b359919923d908bb015', - ], - 'SubDomain' => [ - 'description' => 'The second-level domain name assigned to the API group. This domain name is used to test API calls.'."\n", - 'type' => 'string', - 'example' => 'xxx-cn-hangzhou.alicloudapi.com', - ], - 'DomainName' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'example' => 'api.demo.com', - ], - 'DomainBindingStatus' => [ - 'description' => 'The binding status of the custom domain name. Valid values:'."\n" - ."\n" - .'* **BINDING**: The domain name has been bound.'."\n" - .'* **BOUND**: The domain name has not been bound.'."\n", - 'type' => 'string', - 'example' => 'BINDING', - ], - 'DomainRemark' => [ - 'description' => 'The remarks on the domain name, such as the cause of an exception.'."\n", - 'type' => 'string', - 'example' => 'None'."\n", - ], - 'DomainWebSocketStatus' => [ - 'description' => 'The status of the domain name that uses the WebSocket feature.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], + 'StageModelId' => ['description' => 'The stage model ID.', 'type' => 'string', 'example' => '39sdfjsd8fudsfxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708xxxx', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'SetDomain', - ], - 'SetDomainCertificate' => [ - 'summary' => 'Uploads an SSL certificate for a specified custom domain name.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'CreateStageModel', + 'description' => '- The model definition conforms to [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04?spm=a2c4g.11186623.2.10.2e977ff7p4BpQd).'."\n" + ."\n" + .'- The JSON schema supports only properties of the object type.', + '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' => 'Creates a custom throttling policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4284,117 +3165,48 @@ ], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94480', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIX31M', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94281', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', - ], - ], - [ - 'name' => 'CertificateName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the SSL certificate.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_cert', - ], - ], - [ - 'name' => 'CertificateBody', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'For more information, see the following request examples'."\n", - ], - ], - [ - 'name' => 'CertificatePrivateKey', + 'name' => 'TrafficControlName', 'in' => 'query', - 'schema' => [ - 'description' => 'The private key of the SSL certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'For more information, see the following request examples'."\n", - ], + 'schema' => ['description' => 'The name of the throttling policy. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It cannot start with an underscore.', 'type' => 'string', 'example' => 'Throttling test', 'required' => true, 'title' => ''], ], [ - 'name' => 'CaCertificateBody', + 'name' => 'TrafficControlUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the CA certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Content of the CA certificate'."\n", - ], + 'schema' => ['description' => 'The unit to be used in the throttling policy. Valid values:'."\n" + ."\n" + .'- **SECOND**'."\n" + ."\n" + .'- **MINUTE**'."\n" + ."\n" + .'- **HOUR**'."\n" + ."\n" + .'- **DAY**', 'type' => 'string', 'required' => true, 'example' => 'MINUTE', 'title' => ''], ], [ - 'name' => 'SslVerifyDepth', + 'name' => 'ApiDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate verification depth.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The default throttling value for each API.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'SslOcspEnable', + 'name' => 'UserDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'If enable ssl OCSP.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], + 'schema' => ['description' => 'The default throttling value for each user.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'SslOcspCacheEnable', + 'name' => 'AppDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'If enable ssl OCSP cache.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], + 'schema' => ['description' => 'The default throttling value for each app.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ClientCertSDnPassThrough', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'If pass ssl_client_s_dn of the cert to backend header \'X-Client-S-Dn\'.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'True', - ], + 'schema' => ['description' => 'The description of the throttling policy.', 'type' => 'string', 'example' => 'Throttling test description', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -4402,90 +3214,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], + 'TrafficControlId' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'example' => 'tf123456', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<SetDomainCertificateResponse>\\r\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\r\\n</SetDomainCertificateResponse>","errorExample":""}]', - 'title' => 'SetDomainCertificate', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The SSL certificate must match the custom domain name.'."\n" - .'* After the SSL certificate is bound, HTTPS-based API services become available.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetDomainWebSocketStatus' => [ - 'summary' => 'Enables or disables WebSocket for a custom domain name.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TrafficControlId\\": \\"tf123456\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + 'title' => 'CreateTrafficControl', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- Throttling policies must be bound to APIs to take effect. After a policy is bound to an API, it goes into effect on that API immediately.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrafficControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateTrafficControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DeleteAccessControlList' => [ + 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Deletes an access control policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94481', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIX31M', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cf976e63b70c4993807e7bb9345d4695', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ac.fluvet.cn', - ], - ], - [ - 'name' => 'ActionValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The action.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN', - ], - ], - [ - 'name' => 'WSSEnable', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'If enable WSS.', - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-uf6fpfdg3b5muska7uqem', 'title' => ''], ], ], 'responses' => [ @@ -4493,71 +3276,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61A16D46-EC04-5288-8A18-811B0F536CC2\\"\\n}","type":"json"}]', - 'title' => 'SetDomainWebSocketStatus', - ], - 'SetWildcardDomainPatterns' => [ - 'summary' => 'Specifies a wildcard domain name template for a bound custom domain name.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteAccessControlList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessControlList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + ], + 'DeleteAllTrafficSpecialControl' => [ + 'summary' => 'Deletes all custom special policies of a specified throttling policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94488', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*.prd.e-eir.com', - ], - ], - [ - 'name' => 'WildcardDomainPatterns', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The wildcard domain name mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[\\"{svc}.prd.e-eir.com\\"]', - ], + 'schema' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'required' => true, 'example' => 'tf123456', 'title' => ''], ], ], 'responses' => [ @@ -4565,64 +3330,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0075BDA-8AED-5073-A70A-FE44E86AB20F\\"\\n}","type":"json"}]', - 'title' => 'SetWildcardDomainPatterns', - ], - 'DescribeDomain' => [ - 'summary' => 'Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [], + 'title' => 'DeleteAllTrafficSpecialControl', + 'description' => '- This API is intended for API providers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAllTrafficSpecialControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteAllTrafficSpecialControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'DeleteApi' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94353', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], + 'schema' => ['description' => 'The ID of the API group.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], ], [ - 'name' => 'DomainName', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', - ], + 'schema' => ['description' => 'The ID of the API.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', 'title' => ''], ], ], 'responses' => [ @@ -4630,143 +3390,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CertificatePrivateKey' => [ - 'description' => 'The private key of the SSL certificate.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'DomainName' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'example' => 'api.demo.com', - ], - 'DomainBindingStatus' => [ - 'description' => 'The binding status of the custom domain name. Valid values:'."\n" - ."\n" - .'* BINDING: The domain name has been bound.'."\n" - .'* BOUND: The domain name has not been bound.'."\n", - 'type' => 'string', - 'example' => 'BINDING', - ], - 'DomainRemark' => [ - 'description' => 'Remarks about the domain name, such as the cause of an exception.'."\n", - 'type' => 'string', - 'example' => 'The domain name does not have an ICP filing.'."\n", - ], - 'CertificateId' => [ - 'description' => 'The unique ID of the SSL certificate, which is automatically generated by the system.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'DomainWebSocketStatus' => [ - 'description' => 'The status of the domain name that uses WebSocket.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], - 'CertificateName' => [ - 'description' => 'The name of the SSL certificate.'."\n", - 'type' => 'string', - 'example' => 'myCertificate', - ], - 'DomainLegalStatus' => [ - 'description' => 'The validity status of the domain name. Valid values:'."\n" - ."\n" - .'* NORMAL'."\n" - .'* ABNORMAL: This status affects API calls and must be resolved as soon as possible.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '927d50c0f2e54b359919923d908bb015', - ], - 'CertificateBody' => [ - 'description' => 'The content of the certificate.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'SubDomain' => [ - 'description' => 'The second-level domain name that is automatically assigned to the API group.'."\n", - 'type' => 'string', - 'example' => 'xxx-cn-hangzhou.alicloudapi.com', - ], - 'DomainCNAMEStatus' => [ - 'description' => 'The domain name resolution status. Valid values:'."\n" - ."\n" - .'* RESOLVED: The domain name has been resolved.'."\n" - .'* UNRESOLVED: The domain name has not been resolved.'."\n", - 'type' => 'string', - 'example' => 'RESOLVED', - ], - 'CertificateValidStart' => [ - 'description' => '证书生效时间戳(毫秒)', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672502400000', - ], - 'CertificateValidEnd' => [ - 'description' => '证书失效时间戳(毫秒)', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1704038400000', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ017', 'title' => ''], ], 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertificatePrivateKey\\": \\"xxx\\",\\n \\"DomainName\\": \\"api.demo.com\\",\\n \\"DomainBindingStatus\\": \\"BINDING\\",\\n \\"DomainRemark\\": \\"该域名未备案\\",\\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' => 'DescribeDomain', - ], - 'ReactivateDomain' => [ - 'summary' => 'Reactivates a custom domain name whose validity status is Abnormal.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ017\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ017</RequestId> \\r\\n</DeleteApiResponse>","errorExample":""}]', + 'title' => 'DeleteApi', + 'summary' => 'Deletes the definition of a specified API.', + 'description' => '* This operation is intended for API providers and cannot be undone after it is complete.'."\n" + .'* An API that is running in the runtime environment must be unpublished before you can delete the API.****'."\n" + .'* The QPS limit on this operation is 50 per user.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94457', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayJWZLU8', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94285', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'DomainName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'api.demo.com', + 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => true, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], ], @@ -4775,80 +3475,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<ReactivateDomainResponse>\\r\\n <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\r\\n</ReactivateDomainResponse>","errorExample":""}]', - 'title' => 'ReactivateDomain', - 'description' => '* This operation is intended for API providers.'."\n" - .'* You must solve the problem that is mentioned in the domain name exception prompt before you can reactivate the domain name.'."\n" - .'* A typical reason why a custom domain name becomes abnormal is that the domain name does not have an ICP filing or the domain name is included in a blacklist by the administration. When a custom domain name is abnormal, users cannot use it to call APIs.'."\n" - .'* You can call this operation to reactivate the domain name to resume normal access.'."\n", - ], - 'CreateMonitorGroup' => [ - 'summary' => 'Enables CloudMonitor alerting for a specified API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteApiGroup', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- An API group that contains APIs cannot be deleted. To delete the API group, you must first delete its APIs.'."\n" + ."\n" + .'- After an API group is deleted, the second-level domain name bound to the API group is automatically invalidated.'."\n" + ."\n" + .'- If the specified API group does not exist, a success response is returned.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94276', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6735211ab9094c818f32f27bc545b6c8', - ], - ], - [ - 'name' => 'RawMonitorGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the monitoring group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '166636221', - ], - ], - [ - 'name' => 'Auth', + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The caller authentication status of the API. Valid values: **ok**: The authentication is successful. **mismatch**: The request is redirected. **servicenotfound**: A request error occurred. **Unknown**: An unknown error occurred.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the API product.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], ], 'responses' => [ @@ -4856,67 +3540,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'MonitorGroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and is unique globally.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '187421794', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5D7136F7-9D67-5D4D-8418-6A512CCEE3A2', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', 'title' => ''], ], 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MonitorGroupId\\": 187421794,\\n \\"RequestId\\": \\"5D7136F7-9D67-5D4D-8418-6A512CCEE3A2\\"\\n}","type":"json"}]', - 'title' => 'CreateMonitorGroup', - ], - 'DeleteMonitorGroup' => [ - 'summary' => 'Deletes a CloudMonitor application group corresponding to an API group.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\"\\n}","type":"json"}]', + 'title' => 'DeleteApiProduct', + 'summary' => 'Deletes an API product. Deleting an API product causes the association between APIs and the deleted API product to be deleted as well. Exercise caution when you delete an API product. If any API in the API product is associated with an application, the API product fails to be deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiProduct'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteApiStageVariable' => [ + 'summary' => 'Deletes a specified variable in a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', + 'abilityTreeCode' => '94286', + 'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '42925e7f5209438186d5560239af5286', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'RawMonitorGroupId', + 'name' => 'StageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the monitoring group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '166636221', - ], + 'schema' => ['description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], + ], + [ + 'name' => 'VariableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the variable to be deleted. This parameter is case-sensitive.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serverName', 'title' => ''], ], ], 'responses' => [ @@ -4924,98 +3608,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C7E2CBAA-47FF-569F-AF12-B14B80E25422', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB969B529', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7E2CBAA-47FF-569F-AF12-B14B80E25422\\"\\n}","type":"json"}]', - 'title' => 'DeleteMonitorGroup', - ], - 'DescribeApiLatencyData' => [ - 'summary' => 'Queries the response time statistics of an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteApiStageVariable', + 'description' => '- This operation is intended for API providers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiStageVariable'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB969B529\\"\\n}","type":"json"}]', + ], + 'DeleteApp' => [ + 'summary' => 'Deletes a specified app.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94318', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T08:28:48Z', - ], + 'schema' => ['description' => 'The ID of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110840611', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T09:28:48Z', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**'."\n", - 'type' => 'string', + 'description' => 'The tags. Up to 20 tags are allowed.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => true, 'example' => 'appname', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'testapp', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'RELEASE', + 'example' => 'test2', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -5024,129 +3690,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', - ], - 'CallLatencys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The returned information about API call latency. It is an array consisting of MonitorItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value corresponding to the monitoring metric.'."\n", - 'type' => 'string', - 'example' => '15', - ], - 'ItemTime' => [ - 'description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2016-07-28T08:20:00Z', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiLatencyDataResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>\\r\\n <CallLatencys>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:20:00Z</ItemTime>\\r\\n <ItemValue>15</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:22:00Z</ItemTime>\\r\\n <ItemValue>30</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:24:00Z</ItemTime>\\r\\n <ItemValue>24</ItemValue>\\r\\n </MonitorItem>\\r\\n </CallLatencys>\\r\\n</DescribeApiLatencyDataResponse>","errorExample":""}]', - 'title' => 'DescribeApiLatencyData', - 'description' => 'You can call this operation to query the latency metrics in milliseconds for a specified API.'."\n" + 'title' => 'DeleteApp', + 'description' => '- This operation is intended for API callers.'."\n" ."\n" - .'* This API is intended for API providers.'."\n" - .'* Only statistics for API calls made in the release environment are collected by default.'."\n", - ], - 'DescribeApiQpsData' => [ - 'summary' => 'Queries the QPS statistics of an API.', - 'methods' => [ - 'post', - 'get', + .'- After an application is deleted, the application and its API authorization cannot be restored.'."\n" + ."\n" + .'- Allows up to 50 calls per second per account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]', + ], + 'DeleteAppCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94320', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '207739', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T08:28:48Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T09:28:48Z', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '111265074', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'AppCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The application AppCode.', 'type' => 'string', 'required' => true, 'example' => '0d13f021c5cd4997831a9717e75b0663', 'title' => ''], ], ], 'responses' => [ @@ -5154,156 +3761,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', - ], - 'CallSuccesses' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The returned information about successful API calls. It is an array consisting of MonitorItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value corresponding to the monitoring metric.'."\n", - 'type' => 'string', - 'example' => '650', - ], - 'ItemTime' => [ - 'description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2016-07-28T08:24:00Z', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'CallFails' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The returned information about failed API calls. It is an array consisting of MonitorItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value corresponding to the monitoring metric.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ItemTime' => [ - 'description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2016-07-28T08:20:00Z', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiQpsDataResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>\\r\\n <CallSuccesses>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:20:00Z</ItemTime>\\r\\n <ItemValue>670</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:22:00Z</ItemTime>\\r\\n <ItemValue>770</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:24:00Z</ItemTime>\\r\\n <ItemValue>650</ItemValue>\\r\\n </MonitorItem>\\r\\n </CallSuccesses>\\r\\n <CallFails>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:20:00Z</ItemTime>\\r\\n <ItemValue>0</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:22:00Z</ItemTime>\\r\\n <ItemValue>0</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:24:00Z</ItemTime>\\r\\n <ItemValue>1</ItemValue>\\r\\n </MonitorItem>\\r\\n </CallFails>\\r\\n</DescribeApiQpsDataResponse>","errorExample":""}]', - 'title' => 'DescribeApiQpsData', - 'description' => '* This API is intended for API providers.'."\n" - .'* Only statistics for API calls made in the release environment are collected by default.'."\n", - ], - 'DescribeApiTrafficControls' => [ - 'summary' => 'Queries the throttling policies bound to all members of an API group in a specified environment.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteAppCode', + 'summary' => 'Deletes the AppCode of an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppCode'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes the AppKey and AppSecret of an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94333', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '207740', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The runtime environment of the API. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'ApiIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123,234', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '110840611', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'The AppKey of the application. The AppKey is used for calling an API.', 'type' => 'string', 'required' => true, 'example' => '203708622', 'title' => ''], ], ], 'responses' => [ @@ -5311,160 +3826,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ApiTrafficControls' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiTrafficControlItem' => [ - 'description' => 'The returned throttling policy information. It is an array consisting of ApiTrafficControlItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The binding time of the throttling policy.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '46fbb52840d146f186e38e8e70fc8c90', - ], - 'TrafficControlId' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'TrafficControlName' => [ - 'description' => 'The name of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'backendsignature', - ], - 'ApiName' => [ - 'description' => 'API operation'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '79EF055D-AC00-5161-8F35-6A36AAED7422', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiTrafficControlsResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiTrafficControls>\\r\\n <ApiTrafficControlItem>\\r\\n <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>\\r\\n <ApiName>testapi</ApiName> \\r\\n <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>\\r\\n <TrafficControlName>backendsignature</TrafficControlName>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiTrafficControlItem>\\r\\n </ApiTrafficControls>\\r\\n</DescribeApiTrafficControlsResponse>","errorExample":""}]', - 'title' => 'DescribeApiTrafficControls', - 'description' => '* This API is intended for API providers.'."\n" - .'* The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.'."\n", - ], - 'DescribeApiTrafficData' => [ - 'summary' => 'Queries the statistics on the traffic of an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteAppKey', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppKey'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes a backend service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94334', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T08:28:48Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2016-07-23T09:28:48Z', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**: the test environment'."\n" - .'* PRE: the pre-release environment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '27be0dd9ebbc467b9e86c0d250d0b92e', 'title' => ''], ], ], 'responses' => [ @@ -5472,142 +3881,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', - ], - 'CallUploads' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The returned uplink traffic data of API calls. It is an array consisting of MonitorItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value corresponding to the monitoring metric.'."\n", - 'type' => 'string', - 'example' => '670', - ], - 'ItemTime' => [ - 'description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2016-07-28T08:20:00Z', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'CallDownloads' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The returned downlink traffic data of API calls. It is an array consisting of MonitorItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value corresponding to the monitoring metric.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ItemTime' => [ - 'description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2016-07-28T08:20:00Z', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiTrafficDataResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>\\r\\n <CallUploads>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:20:00Z</ItemTime>\\r\\n <ItemValue>670</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:22:00Z</ItemTime>\\r\\n <ItemValue>770</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:24:00Z</ItemTime>\\r\\n <ItemValue>650</ItemValue>\\r\\n </MonitorItem>\\r\\n </CallUploads>\\r\\n <CallDownloads>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:20:00Z</ItemTime>\\r\\n <ItemValue>0</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:22:00Z</ItemTime>\\r\\n <ItemValue>0</ItemValue>\\r\\n </MonitorItem>\\r\\n <MonitorItem>\\r\\n <ItemTime>2016-07-28T08:24:00Z</ItemTime>\\r\\n <ItemValue>1</ItemValue>\\r\\n </MonitorItem>\\r\\n </CallDownloads>\\r\\n</DescribeApiTrafficDataResponse>","errorExample":""}]', - 'title' => 'DescribeApiTrafficData', - 'description' => '* This API is intended for API providers.'."\n" - .'* Only statistics for API calls made in the release environment are collected by default.'."\n", - ], - 'DescribeInstanceDropPacket' => [ - 'summary' => 'Queries the number of dropped packets within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteBackend', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackend'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes the definition of a backend service in an environment. After the definition is deleted, the API that uses the backend service and is published to this environment will be unpublished.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94364', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-09-06T04:00:36Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'BackendModelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-12-16T02:04:36Z', - ], + 'schema' => ['description' => 'The ID of the backend model.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-v641b9dxc00p', - ], + 'schema' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'required' => false, 'example' => '20bcdc9453524b78a8beb1f6de21edb7', 'title' => ''], ], [ - 'name' => 'SbcName', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical metric. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Maximum', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -5615,120 +3951,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', - ], - 'InstanceDropPacket' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of dropped packets in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of dropped packets in the instance.'."\n", - 'type' => 'string', - 'example' => '0.0', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-09-06T04:00:36Z'."\n", - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* InstanceDropPacketRX: the number of inbound packets dropped in the instance per second.'."\n" - .'* InstanceDropPacketTX: the number of outbound packets dropped in the instance per second.'."\n", - 'type' => 'string', - 'example' => 'InstanceDropPacketRX', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', 'title' => ''], + 'OperationId' => ['description' => 'The ID of the operation.', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceDropPacket', - ], - 'DescribeInstanceDropConnections' => [ - 'summary' => 'Queries the number of lost connections to a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteBackendModel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackendModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94363', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-01-31T06:00:09Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-01-31T07:00:09Z', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dedicated instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-n6w1v1234501', - ], - ], - [ - 'name' => 'SbcName', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical metric. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Maximum', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********', 'title' => ''], ], ], 'responses' => [ @@ -5736,112 +4007,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], - 'InstanceDropConnections' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of dropped connections in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of dropped packets in the instance.'."\n", - 'type' => 'string', - 'example' => '0.0', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2023-01-31T01:11:00Z', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '048C8EFB-528F-5E97-8A3D-D17B********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceDropConnections', - ], - 'DescribeInstanceHttpCode' => [ - 'summary' => 'Queries the distribution of HTTP status codes of requests to a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes a data entry from a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94365', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-04-14T02:12:10Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-07-21T06:05:52Z', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API is requested. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'."\n", 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DatasetItemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-m7r227yy2004', - ], + 'schema' => ['description' => 'The ID of the data entry.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5045****', 'title' => ''], ], ], 'responses' => [ @@ -5849,113 +4067,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', - ], - 'InstanceHttpCode' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The HTTP status codes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The corresponding value.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ItemTime' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => '404', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FF433E09-663A-5F5D-9DBA-A611********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceHttpCode', - ], - 'DescribeInstanceLatency' => [ - 'summary' => 'Queries the average latency of a dedicated instance over a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteDatasetItem', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Unbinds a custom domain name from an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94366', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94289', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-09-15T11:07:05Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-09-06T02:05:13Z', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API is requested. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the API group to which the domain name to be unbound is bound. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-v641jf5tt01v', - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], ], ], 'responses' => [ @@ -5963,120 +4129,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'InstanceLatency' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of average latencies in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The value of the average latency.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-09-06T02:05:13Z'."\n", - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* gatewayLatency API: the processing latency of API Gateway'."\n" - .'* latency: the processing latency of the backend service.'."\n", - 'type' => 'string', - 'example' => 'latency', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceLatency', - ], - 'DescribeInstanceNewConnections' => [ - 'summary' => 'Queries the number of new connections to a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteDomain', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- If the specified domain name does not exist, a successful response will still appear.'."\n" + ."\n" + .'- Unbinding a domain name from an API group will affect access to the APIs in the group. Exercise caution when using this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomain'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","type":"json"}]', + ], + 'DeleteDomainCertificate' => [ + 'summary' => 'Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94367', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94290', + 'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-10-01T02:08:00Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-10-08T02:08:00Z', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-2r426lavr001', - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], ], [ - 'name' => 'SbcName', + 'name' => 'CertificateId', 'in' => 'query', - 'schema' => [ - 'description' => 'The statistical metric. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Maximum', - ], + 'schema' => ['description' => 'The ID of the SSL certificate that you want to delete. The ID is automatically generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c621720d1eb34843822b7fb5148e6926', 'title' => ''], ], ], 'responses' => [ @@ -6084,111 +4201,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'InstanceNewConnections' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of new connections in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of new connections in the instance.'."\n", - 'type' => 'string', - 'example' => '16', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-10-08T02:08:00Z'."\n", - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceNewConnections', - ], - 'DescribeInstancePackets' => [ - 'summary' => 'Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteDomainCertificate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomainCertificate'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'summary' => 'Deletes an API Gateway instance. You can use this operation only to delete pay-as-you-go instances. To delete subscription instances, use the console.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94368', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94291', + 'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-05-18T01:14:26Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-05-24T10:14:53Z', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-2r426lavr001', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-sh-ae502ee79ef8', 'title' => ''], ], [ - 'name' => 'SbcName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The statistical metric. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Maximum', + 'description' => 'The object tags that apply to the rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => true, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], ], @@ -6197,120 +4284,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'InstancePackets' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of inbound and outbound data packets in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of inbound and outbound data packets in the instance.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-05-24T10:14:53Z'."\n", - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* InstancePacketRX: inbound data packets'."\n" - .'* InstancePacketTX: outbound data packets'."\n", - 'type' => 'string', - 'example' => 'InstancePacketRX', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of this request.', 'type' => 'string', 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstancePackets', - ], - 'DescribeInstanceQps' => [ - 'summary' => 'Queries the number of requests to a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA4B3261-F14A-5E33-8608-F75A1DF27AD4\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'DeleteIpControl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94369', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94292', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-02-10T06:03:47Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-03-29T06:25:00Z', - ], - ], - [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API is requested. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-bj-6c219f1fd5d4', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], ], 'responses' => [ @@ -6318,111 +4340,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'InstanceQps' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of requests sent to the APIs in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of requests sent to the APIs in the instance.'."\n", - 'type' => 'string', - 'example' => '500', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-03-29T06:25:00Z'."\n", - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceQps', - ], - 'DescribeInstanceSlbConnect' => [ - 'summary' => 'Queries the number of concurrent connections to a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteIpControl', + 'summary' => 'Deletes an access control list (ACL).', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- If the ACL is bound to an API, you must unbind the ACL from the API before you can delete the ACL. Otherwise, an error is returned.'."\n" + ."\n" + .'- If you call this operation on an ACL that does not exist, a success message is returned.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIpControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'DeleteLogConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94371', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94293', + 'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-09-01T02:09:33Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-09-15T15:07:06Z', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-sz-1574cc7c5a31', - ], - ], - [ - 'name' => 'SbcName', + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => 'The statistical metric. Valid values:'."\n" - ."\n" - .'* Maximum'."\n" - .'* Minimum'."\n" - .'* Average'."\n", + 'description' => 'The log type. Valid values: **log** and **survey**.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'Maximum', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => ['PROVIDER'], + 'example' => 'log', + 'title' => '', ], ], ], @@ -6431,121 +4414,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', - ], - 'InstanceSlbConnect' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The list of concurrent connections in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of concurrent connections in the instance.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-09-15T15:07:06Z'."\n", - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* InstanceMaxConnection: the maximum number of connections'."\n" - .'* InstanceInactiveConnection: the number of inactive connections'."\n" - .'* InstanceActiveConnection: the number of active connections'."\n", - 'type' => 'string', - 'example' => 'InstanceActiveConnection', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceSlbConnect', - ], - 'DescribeInstanceTraffic' => [ - 'summary' => 'Queries the request traffic and response traffic of a dedicated instance within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteLogConfig', + 'summary' => 'Deletes a log configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogConfig'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes a model.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94372', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94294', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-03-31T03:42:00Z', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-04-01T06:34:03Z', - ], + 'schema' => ['description' => 'The name of the model.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test', 'title' => ''], ], [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API runs. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST: the test environment**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-cn-2r426lavr001', - ], + 'schema' => ['description' => 'The ID of the API group to which the model belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], ], ], 'responses' => [ @@ -6553,120 +4478,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'InstanceTraffic' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The traffic consumed by the requests and responses in the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The amount of traffic consumed by the requests and responses in the instance.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'ItemTime' => [ - 'description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'example' => '2022-04-01T06:34:03Z'."\n", - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* inbound: traffic consumed by requests'."\n" - .'* outbound: traffic consumed by responses'."\n", - 'type' => 'string', - 'example' => 'inbound', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeInstanceTraffic', - ], - 'DescribeGroupQps' => [ - 'summary' => 'Queries the statistics on the number of requests directed to an API group within a period of time.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteModel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","type":"json"}]', + ], + 'DeleteMonitorGroup' => [ + 'summary' => 'Deletes a CloudMonitor application group corresponding to an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94359', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-08-12T06:09:52Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-08-23T07:27:44Z', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment to which the API group is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42925e7f5209438186d5560239af5286', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'RawMonitorGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '264c60db9f764345a13ac5c825b229b9', - ], + 'schema' => ['description' => 'The ID of the monitoring group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '166636221', 'title' => ''], ], ], 'responses' => [ @@ -6674,390 +4540,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], - 'GroupQps' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The number of requests directed to the API group.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The number of requests at the specified point in time.'."\n", - 'type' => 'string', - 'example' => '17', - ], - 'ItemTime' => [ - 'description' => 'The point in time.'."\n", - 'type' => 'string', - 'example' => '2023-08-02T09:15:00Z', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C7E2CBAA-47FF-569F-AF12-B14B80E25422', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeGroupQps', - ], - 'CreateApi' => [ - 'summary' => 'Creates an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteMonitorGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMonitorGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Deletes a plug-in.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', + 'abilityTreeCode' => '94295', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], - ], - [ - 'name' => 'ApiName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API that you want to create. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ApiName', - ], - ], - [ - 'name' => 'Visibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to make the API public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PUBLIC', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the API. The description can be up to 180 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Api description', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestConfig](~~43985~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'APP', - ], - ], - [ - 'name' => 'RequestConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration items of API requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceConfig](~~43987~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}', - ], - ], - [ - 'name' => 'ServiceConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestParameter](~~43986~~).'."\n", - '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' => 'The common parameters of APIs in JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\[{\\\\"demoValue\\\\":\\\\"12345678\\\\",\\\\"description\\\\":\\\\"ConsumerAppKey\\\\",\\\\"location\\\\":\\\\"HEAD\\\\",\\\\"parameterName\\\\":\\\\"CaAppKey\\\\",\\\\"serviceParameterName\\\\":\\\\"X-Ca-Key\\\\"}]'."\n", - ], - ], - [ - 'name' => 'SystemParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"demoValue\\":\\"12345678\\",\\"description\\":\\"ConsumerAppKey\\",\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaAppKey\\",\\"serviceParameterName\\":\\"X-Ca-Key\\"}]', - ], - ], - [ - 'name' => 'ConstantParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameter](~~43988~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]'."\n", - ], - ], - [ - 'name' => 'ServiceParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameterMap](~~43989~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]', - ], - ], - [ - 'name' => 'ServiceParametersMap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]', - ], - ], - [ - 'name' => 'ResultType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sample response from the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'HTML', - ], - ], - [ - 'name' => 'ResultSample', - 'in' => 'formData', - 'schema' => [ - 'description' => 'An example of a response returned by the backend service. This value is used only to generate documentation. The actually returned result shall prevail.(Support up to 32KB)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '200', - ], - ], - [ - 'name' => 'FailResultSample', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n" - ."\n" - .'For more information, see [ErrorCodeSample](~~44392~~).(Support up to 16KB)', - 'type' => 'string', - 'required' => false, - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', - ], - ], - [ - 'name' => 'ErrorCodeSamples', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\[]'."\n", - ], - ], - [ - 'name' => 'ResultDescriptions', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The switch status of ACL. Valid values:- **on** and **off**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], - ], - [ - 'name' => 'OpenIdConnectConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'If the **AuthType** is **APP** authentication, you need to pass this value to specify the signature algorithm. If you do not specify this parameter, the default value HmacSHA256 is used. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"openIdApiType\\":null,\\"idTokenParamName\\":null,\\"publicKeyId\\":null,\\"publicKey\\":null}', - ], - ], - [ - 'name' => 'AllowSignatureMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the two-way communication API.'."\n" - ."\n" - .'* **COMMON**: normal APIs'."\n" - .'* **REGISTER**: registered APIs'."\n" - .'* **UNREGISTER**: unregistered APIs'."\n" - .'* **NOTIFY**: downstream notification APIs', - 'type' => 'string', - 'required' => false, - 'example' => 'HmacSHA256', - ], - ], - [ - 'name' => 'WebSocketApiType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'COMMON', - ], - ], - [ - 'name' => 'ResultBodyModel', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ForceNonceCheck', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" - .'* If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DisableInternet', - 'in' => 'query', - 'schema' => [ - 'description' => 'If **AuthType** is set to **APP**, the valid values are:'."\n" - ."\n" - .'* **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is used.'."\n" - .'* **DISABLE**: The authentication is disabled.'."\n" - .'* **HEADER**: AppCode can be placed in the Header parameter for authentication.'."\n" - .'* **HEADER_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AppCodeAuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDof the backend service'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HEADER', - ], - ], - [ - 'name' => 'BackendId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable backend services.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a0305308908c4740aba9cbfd63ba99b7', - ], - ], - [ - 'name' => 'BackendEnable', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable backend services.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the plug-in to be deleted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => '\' \'', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], ], @@ -7066,365 +4626,140 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '8afff6c8c4c6447abb035812e4d66b65', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"8afff6c8c4c6447abb035812e4d66b65\\",\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', - 'title' => 'CreateApi', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The name of an API must be unique within an API group.'."\n" - .'* A request path must be unique within an API group.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", + 'title' => 'DeletePlugin', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- You must first unbind the plug-in from the API. Otherwise, an error is reported when you delete the plug-in.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateApiStageVariable' => [ - 'summary' => 'Adds a variable to an environment.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', + ], + 'DeletePrivateDNS' => [ + 'summary' => 'Deletes an internal domain name resolution.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94265', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayN14L0I', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - ], - [ - 'name' => 'StageId', + 'name' => 'IntranetDomain', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the runtime environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], + 'schema' => ['description' => 'The internal domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'api.demo.com', 'title' => ''], ], [ - 'name' => 'VariableName', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the variable to be added. This parameter is case-sensitive.'."\n", + 'description' => 'The internal domain name resolution type. Valid values:'."\n" + ."\n" + .'* VPC: resolution for virtual private cloud (VPC) access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" + .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'serverName', - ], - ], - [ - 'name' => 'SupportRoute', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether routing is supported.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'VariableValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api.domain.com', + 'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'], + 'example' => 'A', + 'title' => '', ], ], [ - 'name' => 'StageRouteModel', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => 'The routing model of the environment.'."\n", - '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" - .'}', - ], + 'schema' => ['description' => 'Specifies whether to force delete the resolution.'."\n" + ."\n" + .'* true: force deletes the resolution if the resolution is associated with an instance.'."\n" + .'* false: does not force delete the resolution if the resolution is associated with an instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB999B529\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateApiStageVariableResponse>\\r\\n <RequestId>03442A3D-3B7D-434C-8A95-A5FEB999B529</RequestId>\\r\\n</CreateApiStageVariableResponse>","errorExample":""}]', - 'title' => 'CreateApiStageVariable', - 'description' => '* This operation is intended for API providers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ImportOAS' => [ - 'summary' => 'Imports OpenAPI Specification (OAS)-compliant data to create an API.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + 'title' => 'DeletePrivateDNS', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeletePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteSignature' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', + 'abilityTreeCode' => '94298', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], - ], - [ - 'name' => 'Data', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The OAS-compliant text file or OSS object URL.'."\n", - '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' => 'Specifies whether to overwrite an existing API.'."\n" - ."\n" - .'If an existing API has the same HTTP request type and backend request path as the API to be imported, the existing API is overwritten.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'IgnoreWarning', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to ignore alerts.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'SkipDryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to directly import the API without performing a precheck.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'OASVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The OAS version.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'OAS2', - ], - ], - [ - 'name' => 'BackendName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testBackendService', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The security authentication method of the API. Valid values:'."\n" - ."\n" - .'* **APP: Only authorized applications can call the API.**'."\n" - ."\n" - .'* **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" - ."\n" - .' * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'APP', - ], - ], - [ - 'name' => 'RequestMode', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The request mode. Valid values:'."\n" - ."\n" - .'* MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" - .'* PASSTHROUGH: Parameters are passed through.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'PASSTHROUGH', - ], + 'schema' => ['description' => 'The ID of the key to be deleted.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], ], 'responses' => [ @@ -7432,279 +4767,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OperationId' => [ - 'description' => 'The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status of the API import task.'."\n", - 'type' => 'string', - 'example' => 'c16a1880f5164d779f6a54f64d997cd9', - ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', - 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', - ], - 'ErrorMessages' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error messages that appear due to the invalid data in the imported file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The error message that appears due to the invalid data in the imported file.'."\n", - 'type' => 'string', - 'example' => 'Invalid extensions:x-aliyun-apigateway-auth-type. Option value [ANONYMOUS, APP].', - ], - ], - ], - ], - 'WarningMessages' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'WarningMessage' => [ - 'description' => 'The warning messages that appear due to the invalid data in the imported file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The warning message that appears due to the invalid data in the imported file.'."\n", - 'type' => 'string', - 'example' => 'There is no valid api definition in your file.', - ], - ], - ], - ], - 'SuccessApis' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SuccessApi' => [ - 'description' => 'The information about the APIs that have passed the precheck.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the API that has passed the precheck.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when you created the API.'."\n", - 'type' => 'string', - 'example' => '/st1', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when you created the API.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '92af1abffc2443eaa2b815fdbd9c13f1', - ], - 'ApiOperation' => [ - 'description' => 'Indicates that the operation is CREATE or MODIFY.'."\n", - 'type' => 'string', - 'example' => 'CREATE', - ], - ], - ], - ], - ], - ], - 'FailedApis' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'FailedApi' => [ - 'description' => 'The APIs that failed to pass the precheck.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The API that failed to be pass the precheck.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when you created the API.'."\n", - 'type' => 'string', - 'example' => '/st1', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when you created the API.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid Api Definition.', - ], - ], - ], - ], - ], - ], - 'FailedModels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'FailedModel' => [ - 'description' => 'The information about the models that failed to pass the precheck.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the model that failed to pass the precheck.'."\n", - 'type' => 'object', - 'properties' => [ - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid Model Definition.', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '2c1bc62e19614cc68c6b0b484bc9c5db', - ], - ], - ], - ], - ], - ], - 'SuccessModels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SuccessModel' => [ - 'description' => 'The information about the models that have passed the precheck.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the model that has passed the precheck.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModelUid' => [ - 'description' => 'The UID of the model.'."\n", - 'type' => 'string', - 'example' => '1r4efwee19614cc68c6b0b484bc9c5dbs', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'feaccf67040643bcbdedb253e59eb527', - ], - 'ModelOperation' => [ - 'description' => 'The operation of the model. Valid values: CREATE and MODIFY.'."\n", - 'type' => 'string', - 'example' => 'CREATE', - ], - ], - ], - ], - ], + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + 'enumValueTitles' => [], + 'title' => '', ], ], 'description' => '', + 'title' => '', ], ], ], - '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"}]', - 'title' => 'ImportOAS', - ], - 'ImportSwagger' => [ - 'summary' => 'Creates an API by importing Swagger-compliant data.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSignatureResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteSignatureResponse>","errorExample":""}]', + 'title' => 'DeleteSignature', + 'summary' => 'Deletes a backend signature key.', + 'description' => '* This API is intended for API providers.'."\n" + .'* This API operation deletes an existing backend signature key.'."\n" + .'* You cannot delete a key that is bound to an API. To delete the key, you must unbind it first.'."\n" + .'* The QPS limit on this operation is 50 per user.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteSignature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteStageModel' => [ + 'summary' => 'Deletes a stage model.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Overwrite', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to overwrite the existing API.'."\n" - ."\n" - .'APIs with the same HTTP request type and backend request path are considered the same.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], - ], - [ - 'name' => 'GlobalCondition', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The global conditions.'."\n", - 'type' => 'object', - 'required' => false, - 'docRequired' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'DataFormat', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Swagger text format:'."\n" - ."\n" - .'* json'."\n" - .'* yaml'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'yaml', - ], - ], - [ - 'name' => 'Data', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Swagger text content.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"A Swagger API definition in YAML"', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group to which the Swagger is imported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'DryRun', + 'name' => 'StageModelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pre-inspection.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the stage configuration.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '3294sdufo3nenexxx', 'title' => ''], ], ], 'responses' => [ @@ -7712,199 +4832,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '647CEF05-404C-4125-B3D7-44792EB77392', - ], - 'Success' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportSwaggerSuccess' => [ - 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when the API is created.'."\n", - 'type' => 'string', - 'example' => '/http/get/mapping', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when the API is created.'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'ApiOperation' => [ - 'description' => 'Specifies whether the operation is CREATE or MODIFY.'."\n", - 'type' => 'string', - 'example' => 'CREATE', - ], - 'ApiUid' => [ - 'description' => 'The UID of the successfully imported API.'."\n", - 'type' => 'string', - 'example' => '8e274ec61cf6468e83b68371956831cb', - ], - ], - ], - ], - ], - ], - 'Failed' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportSwaggerFailed' => [ - 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when the API is created.'."\n", - 'type' => 'string', - 'example' => '/http/get/mapping', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when the API is created.'."\n", - 'type' => 'string', - 'example' => 'post', - ], - 'ErrorMsg' => [ - 'description' => 'The error message returned when the API is created.'."\n", - 'type' => 'string', - 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb', - ], - ], - ], - ], - ], - ], - 'ModelFailed' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportModelFailed' => [ - 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.'."\n", - 'type' => 'object', - 'properties' => [ - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'error msg', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'Region', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '36d4bcfaec1946e1870d90b2d7519710', - ], - ], - ], - ], - ], - ], - 'ModelSuccess' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportModelSuccess' => [ - 'description' => 'The models that were imported through the Swagger-compliant data this time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The models that were imported through the Swagger-compliant data this time.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModelUid' => [ - 'description' => 'The UID of the model.'."\n", - 'type' => 'string', - 'example' => 'd4bcfaec1946e1870d', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'NewInstance', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'b2d552ed90ca435b86f7bf8d45414793', - ], - 'ModelOperation' => [ - 'description' => 'The model operation'."\n", - 'type' => 'string', - 'example' => 'CREATE', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724xxx', 'title' => ''], ], - 'description' => '', + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], ], - '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":"<ImportSwaggerResponse>\\r\\n <RequestId>647CEF05-404C-4125-B3D7-44792EB77392</RequestId>\\r\\n <Failed>\\r\\n <ApiImportSwaggerFailed>\\r\\n <ErrorMsg>api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb</ErrorMsg>\\r\\n <HttpMethod>post</HttpMethod>\\r\\n <Path>/http/get/mapping</Path>\\r\\n </ApiImportSwaggerFailed>\\r\\n </Failed>\\r\\n <Success>\\r\\n <ApiImportSwaggerSuccess>\\r\\n <ApiOperation>CREATE</ApiOperation>\\r\\n <ApiUid>8e274ec61cf6468e83b68371956831cb</ApiUid>\\r\\n <HttpMethod>get</HttpMethod>\\r\\n <Path>/http/get/mapping</Path>\\r\\n </ApiImportSwaggerSuccess>\\r\\n </Success>\\r\\n</ImportSwaggerResponse>","errorExample":""}]', - 'title' => 'ImportSwagger', - 'description' => '* Alibaba Cloud supports extensions based on Swagger 2.0.'."\n" - .'* Alibaba Cloud supports Swagger configuration files in JSON and YAML formats.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteApi' => [ - 'summary' => 'Deletes the definition of a specified API.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DeleteStageModel', + 'description' => '- This API is for API providers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724xxx\\"\\n}","type":"json"}]', + ], + 'DeleteTrafficControl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', + 'abilityTreeCode' => '94299', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], - ], - [ - 'name' => 'ApiId', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', - ], + 'schema' => ['description' => 'The ID of the throttling policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tf123456', 'title' => ''], ], ], 'responses' => [ @@ -7912,32 +4875,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ017', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ017\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ017</RequestId> \\r\\n</DeleteApiResponse>","errorExample":""}]', - 'title' => 'DeleteApi', - 'description' => '* This operation is intended for API providers and cannot be undone after it is complete.'."\n" - .'* An API that is running in the runtime environment must be unpublished before you can delete the API.****'."\n" + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTrafficControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteTrafficControlResponse>","errorExample":""}]', + 'title' => 'DeleteTrafficControl', + 'summary' => 'Deletes a custom throttling policy and the special throttling rules in the policy.', + 'description' => '* This API is intended for API providers.'."\n" + .'* If the throttling policy you want to delete is bound to APIs, you need to unbind the policy first. Otherwise, an error is reported when you delete the policy.'."\n" .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'DeleteApiStageVariable' => [ - 'summary' => 'Deletes a specified variable in a specified environment.', - 'methods' => [ - 'post', - 'get', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -7945,44 +4922,28 @@ ], 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '94286', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayN14L0I', - ], + 'abilityTreeCode' => '94300', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'required' => true, 'example' => 'tf123456', 'title' => ''], ], [ - 'name' => 'StageId', + 'name' => 'SpecialType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', - ], + 'schema' => ['description' => 'The type of the special throttling policy. Valid values:'."\n" + ."\n" + .'- **APP**'."\n" + ."\n" + .'- **USER**', 'type' => 'string', 'required' => true, 'example' => 'APP', 'title' => ''], ], [ - 'name' => 'VariableName', + 'name' => 'SpecialKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the variable to be deleted. This parameter is case-sensitive.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'serverName', - ], + 'schema' => ['description' => 'The ID of the app or Alibaba Cloud account. You can view your account ID on the [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.343130a8sDi8cO#/secure) page.', 'type' => 'string', 'required' => true, 'example' => '3382463', 'title' => ''], ], ], 'responses' => [ @@ -7990,33 +4951,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '03442A3D-3B7D-434C-8A95-A5FEB969B529', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB969B529\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteApiStageVariableResponse>\\r\\n <RequestId>03442A3D-3B7D-434C-8A95-A5FEB969B529</RequestId>\\r\\n</DeleteApiStageVariableResponse>","errorExample":""}]', - 'title' => 'DeleteApiStageVariable', - 'description' => '* This operation is intended for API providers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyApiConfiguration' => [ - 'summary' => 'This API operation is used to modify the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you need to only specify the value of AuthType, which is APP.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteTrafficSpecialControl', + 'summary' => 'Deletes a custom special throttling policy.', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- You can obtain the input parameters required in this operation by calling other APIs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrafficSpecialControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteTrafficSpecialControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'DeployApi' => [ + 'summary' => 'Publishes an API to a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8025,757 +4998,195 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94302', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', - ], - ], - [ - 'name' => 'ApiName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testModifyApiName', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestModifyDescription'."\n", - ], - ], - [ - 'name' => 'Visibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to make the API public. Valid values:'."\n" - ."\n" - .'* **PUBLIC:** The API is public. If this parameter is set to PUBLIC, the API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE:** The API is private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'PUBLIC', - ], - ], - [ - 'name' => 'ForceNonceCheck', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to forcibly check X-Ca-Nonce. If the **ForceNonceCheck** parameter is set to **true**, X-Ca-Nonce is forcibly checked. X-Ca-Nonce is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If the **ForceNonceCheck** parameter is set to **false**, X-Ca-Nonce is not checked. If you do not modify this parameter when you modify an API, the original value is used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DisableInternet', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to call the API only in an internal network. If the **DisableInternet** parameter is set to **true**, the API can be called only in an internal network.'."\n" - .'* If the **DisableInternet** parameter is set to **false**, the API can be called over the Internet and in an internal network.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'AppCodeAuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'If the **AuthType** parameter is set to **APP**, the valid values are:'."\n" - ."\n" - .'* **DEFAULT**: The default value that is used if no other values are passed. This value indicates that the settings of the group are used.'."\n" - .'* **DISABLE**: The authentication is disabled.'."\n" - .'* **HEADER**: AppCode can be placed in the Header parameter for authentication.'."\n" - .'* **HEADER_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - ], - [ - 'name' => 'AllowSignatureMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'If the **AuthType** parameter is set to **APP**, you must include this parameter to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - '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' => 'The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - [ - 'name' => 'RequestHttpMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - ], - [ - 'name' => 'RequestPath', - 'in' => 'query', - 'schema' => [ - 'description' => 'The path of the API request. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the path of the API request is `/object/add`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test/api', - ], - ], - [ - 'name' => 'RequestMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The request mode. Valid values:'."\n" - ."\n" - .'* MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" - .'* PASSTHROUGH: Parameters are passed through.'."\n" - .'* MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MAPPING', - ], - ], - [ - 'name' => 'BodyFormat', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter takes effect only when the **RequestMode** parameter is set to **MAPPING**.'."\n" - ."\n" - .'The format in which data is transmitted to the server for POST and PUT requests. Valid values: **FORM** and **STREAM**. FORM indicates that data is transmitted in the key-value pair format. STREAM indicates that data is transmitted as byte streams.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STREAM', - ], - ], - [ - 'name' => 'PostBodyDescription', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the request body.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The description of the request body'."\n", - ], - ], - [ - 'name' => 'BodyModel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The body model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://apigateway.aliyun.com/models/f4e7333c****40dcbaf7c9da553ccd8d/3ab61f775b****d4bc35e993****87aa8', - ], - ], - [ - 'name' => 'ModelName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test', - ], - ], - [ - 'name' => 'BackendName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the backend service. This parameter takes effect only when the UseBackendService parameter is set to TRUE.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testBackendService', - ], - ], - [ - 'name' => 'ServiceProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol that is used to access backend services. Valid values:'."\n" - ."\n" - .'* Http: for backend services that use HTTP or HTTPS'."\n" - .'* Vpc: for backend services that use VPC'."\n" - .'* FC: for Function Compute'."\n" - .'* OSS: for Object Storage Service'."\n" - .'* Mock: for backend services that use the Mock mode'."\n" - .'* EventBridge: for EventBridge'."\n" - ."\n" - .'You must specify the config value for the corresponding backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - ], - ], - [ - 'name' => 'HttpConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"serviceAddress":"http://test.api.com","servicePath":"/test/api","serviceHttpMethod":"GET"}', - ], - ], - [ - 'name' => 'VpcConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The VPC configuration.'."\n", - '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' => 'The Function Compute configuration.'."\n", - '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' => 'The OSS configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"OssRegionId":"cn-hangzhou","Key":"/test.html","BucketName":"test-api-oss","Action":"GetObject"}', - ], - ], - [ - 'name' => 'MockConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Mock configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"MockResult":"test","MockHeaders":[{"HeaderName":"testHeader","HeaderValue":"testHeader"}],"MockStatusCode":"400"}', - ], - ], - [ - 'name' => 'ServiceTimeout', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timeout period of the backend service. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ContentTypeCategory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ContentType configuration of the backend request.'."\n" - ."\n" - .'* DEFAULT: the default configuration in API Gateway'."\n" - .'* CUSTOM: a custom configuration'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - ], - [ - 'name' => 'ContentTypeValue', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], ], [ - 'name' => 'RequestParameters', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestParameter](~~43986~~).'."\n", - '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"}]', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', 'title' => ''], ], [ - 'name' => 'ServiceParameters', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameter](~~43988~~).'."\n", - '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"}]', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'ServiceParametersMap', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameterMap](~~43989~~).'."\n", - '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"}]', - ], + 'schema' => ['description' => 'The publishing remarks.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'for_test1', 'title' => ''], ], - [ - 'name' => 'ResultType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. This value is used only to generate documents. It does not affect the returned result.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'JSON', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ResultSample', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sample response from the backend service. This value is used only to generate documents. It does not affect the returned result.'."\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}', - ], + ], + 'title' => 'DeployApi', + 'description' => '- This operation is intended for API providers. Only the API that you have defined and published to a runtime environment can be called.'."\n" + ."\n" + .'- An API is published to a cluster in under 5 seconds.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployApi'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'FailResultSample', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DeployApi', + '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-F876FF7BZ015\\"\\n}","type":"json"}]', + ], + 'DescribeAbolishApiTask' => [ + 'summary' => 'Queries the progress of an API unpublishing task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ErrorCodeSamples', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n" - ."\n" - .'For more information, see [ErrorCodeSample](~~44392~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94303', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], + ], + 'parameters' => [ [ - 'name' => 'UseBackendService', + 'name' => 'OperationUid', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to use the information about the created backend service. Valid values:'."\n" - ."\n" - .'* TRUE: uses the information about the created backend service.'."\n" - .'* FALSE: uses the information about the custom backend service.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'TRUE', - ], + 'schema' => ['description' => 'The ID of the unpublishing operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fc54****dd4c4***ad7edd7****39401', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', 'title' => ''], + 'ApiAbolishResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiAbolishResult' => [ + 'description' => 'The result returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result returned.', + 'type' => 'object', + 'properties' => [ + 'StageId' => ['description' => 'The ID of the runtime environment.', 'type' => 'string', 'example' => '0919f2854a88484c91dc9253347c78f9', 'title' => ''], + 'AbolishStatus' => ['description' => 'The unpublishing status.', 'type' => 'string', 'example' => 'OVER', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '160cb6505e1c43a6b84346856d74eb47', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'wb2022021401619286', 'title' => ''], + 'ApiUid' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '4e26cdbbb113416dba1f0285bed29979', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success. Request Success.', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'v2_page_consent', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', - 'title' => 'ModifyApiConfiguration', - ], - 'ModifyApi' => [ - 'summary' => 'Modifies the definition of an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeAbolishApiTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAbolishApiTask'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAbolishApiTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '142235', + 'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '927d50c0f2e54b359919923d908bb015', - ], - ], - [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8afff6c8c4c6447abb035812e4d66b65', - ], - ], - [ - 'name' => 'ApiName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ApiName', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the API. The description can be up to 180 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Api description', - ], - ], - [ - 'name' => 'Visibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PUBLIC', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'APP', - ], - ], - [ - 'name' => 'RequestConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration items of API requests sent by API Gateway to the backend service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}', - ], - ], - [ - 'name' => 'ServiceConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n", - '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' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestParameter](~~43986~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\[{\\\\"ParameterName\\\\": \\\\"CaAppId\\\\", \\\\"Location\\\\": \\\\"HEAD\\\\", \\\\"ServiceParameterName\\\\": \\\\"x-ca-appid\\\\"}]'."\n", - ], - ], - [ - 'name' => 'SystemParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The system parameters sent by API Gateway to the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"ParameterName\\": \\"CaAppId\\", \\"Location\\": \\"HEAD\\", \\"ServiceParameterName\\": \\"x-ca-appid\\"}]', - ], - ], - [ - 'name' => 'ConstantParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The constant parameters sent by API Gateway to the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"ServiceParameterName\\":\\"HOST\\",\\"ConstantValue\\":\\"uat-cgi.smarket.net.cn\\",\\"Location\\":\\"HEAD\\",\\"Description\\":\\"\\\\u540e\\\\u7aefVPC-HOST\\"}]', - ], - ], - [ - 'name' => 'ServiceParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters of API requests sent by API Gateway to the back-end service.'."\n" - ."\n" - .'For more information, see [ServiceParameter](~~43988~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ServiceParameterName":"age","Location":"Head","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"sex","Location":"Query","Type":"String","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"userId","Location":"Path","Type":"Number","ParameterCatalog":"REQUEST"},{"ServiceParameterName":"clientIp","Location":"Head","Type":"String","ParameterCatalog":"SYSTEM"},{"ServiceParameterName":"constance","Location":"Head","Type":"String","ParameterCatalog":"CONSTANT"}]', - ], - ], - [ - 'name' => 'ServiceParametersMap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the back-end service.'."\n" - ."\n" - .'For more information, see [ServiceParameterMap](~~43989~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ServiceParameterName":"age","RequestParameterName":"age"},{"ServiceParameterName":"sex","RequestParameterName":"sex"},{"ServiceParameterName":"userId","RequestParameterName":"userId"},{"ServiceParameterName":"clientIp","RequestParameterName":"CaClientIp"},{"ServiceParameterName":"constance","RequestParameterName":"constance"}]', - ], - ], - [ - 'name' => 'ResultType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sample response from the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'HTML', - ], - ], - [ - 'name' => 'ResultSample', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sample response that is returned from the backend service. This value is used only to generate documents. It does not affect the actually returned result.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '200', - ], - ], - [ - 'name' => 'FailResultSample', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', - ], - ], - [ - 'name' => 'ErrorCodeSamples', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n" - ."\n" - .'For more information, see [ErrorCodeSample](~~44392~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]', - ], - ], - [ - 'name' => 'ResultDescriptions', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The descriptions of API responses.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], - ], - [ - 'name' => 'OpenIdConnectConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client-side request signature method of the API. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"OpenIdApiType\\":\\"IDTOKEN\\",\\"PublicKey\\":\\"lzlj1573\\",\\"IdTokenParamName\\":\\"\\",\\"PublicKeyId\\":\\"lzljorders\\"}', - ], - ], - [ - 'name' => 'AllowSignatureMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the two-way communication API. Valid values:'."\n" - ."\n" - .'* **COMMON**: general APIs'."\n" - .'* **REGISTER**: registered APIs'."\n" - .'* **UNREGISTER**: unregistered APIs'."\n" - .'* **NOTIFY**: downstream notification'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HmacSHA256', - ], - ], - [ - 'name' => 'WebSocketApiType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The returned description of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'COMMON', - ], - ], - [ - 'name' => 'ResultBodyModel', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If you set **ForceNonceCheck** to **false**, the check is not performed. If you do not set this parameter, the original value is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'ForceNonceCheck', - 'in' => 'query', - 'schema' => [ - 'description' => '* Specifies whether to set DisableInternet to **true** to limit API calls to within the VPC.'."\n" - .'* If you set DisableInternet to **false**, the limit if lifted.'."\n" - ."\n" - .'> If you do not set this parameter, the original value is used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DisableInternet', - 'in' => 'query', - 'schema' => [ - 'description' => 'The AppCode authentication type supported. Valid values:'."\n" - ."\n" - .'* DEFAULT: supported after being made available in Alibaba Cloud Marketplace'."\n" - .'* DISABLE: not supported'."\n" - .'* HEADER : supported only in the Header parameter'."\n" - .'* HEADER_QUERY: supported in the Header or Query parameter'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'AppCodeAuthType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DEFAULT', - ], - ], - [ - 'name' => 'BackendId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable backend services.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0d105f80a8f340408bd34954d4e4ff22', - ], - ], - [ - 'name' => 'BackendEnable', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration Mode', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acl-3nsohdozz0ru8fi5onwz1', 'title' => ''], ], ], 'responses' => [ @@ -8783,38 +5194,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', + 'AclId' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'example' => 'acl-uf6fpfdg3b5muska7uqem', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'AclName' => ['description' => 'The name of the access control policy.', 'type' => 'string', 'example' => 'testAcl', 'title' => ''], + 'AclEntrys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AclEntry' => [ + 'description' => 'The information about the access control policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the access control policy.', + 'type' => 'object', + 'properties' => [ + 'AclEntryIp' => ['description' => 'The ACL entry.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''], + 'AclEntryComment' => ['description' => 'The entry description.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'AddressIPVersion' => ['description' => 'The IP protocol version. Valid values: **ipv4** and **ipv6**.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\r\\n</ModifyApiResponse>","errorExample":""}]', - 'title' => 'ModifyApi', - 'description' => '**This operation is intended for API providers.**'."\n" - ."\n" - .'* This API operation requires a full update. Updates of partial parameters are not supported.'."\n" - .'* When you modify an API name, make sure that the name of each API within the same group is unique.'."\n" - .'* When you modify the request path, make sure that each request path within the same group is unique.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApisByBackend' => [ - 'summary' => 'Queries APIs in the draft or published state that are created by using a specified backend service.', - 'methods' => [ - 'get', - 'post', + 'title' => 'DescribeAccessControlListAttribute', + 'summary' => 'This feature provides instance-level access control for dedicated instances. Queries an access control policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlListAttribute'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAccessControlListAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'This feature provides instance-level access control for dedicated instances. Queries access control policies.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8824,61 +5267,29 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '118586', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '142234', + 'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'], ], 'parameters' => [ [ - 'name' => 'BackendId', + 'name' => 'AclName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4ac69b7a17524781b275ed4c5eb25c54', - ], + 'schema' => ['description' => 'The name of the access control policy.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testAcl', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**'."\n" - .'* **TEST**'."\n" - ."\n" - .'If you do not specify this parameter, APIs in the draft state are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRE', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'AddressIPVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'IP Version,You can set it to **ipv4** or **ipv6**.', 'type' => 'string', 'required' => false, 'example' => 'ipv6', 'title' => ''], ], ], 'responses' => [ @@ -8886,98 +5297,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiInfoList' => [ + 'PageNumber' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Acls' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiInfo' => [ - 'description' => 'The information about the returned API list.'."\n", + 'Acl' => [ + 'description' => 'The ACLs.', + 'title' => '', 'type' => 'array', 'items' => [ + 'description' => 'The ACL.', 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '20bcdc9453524b78a8beb1f6de21edb7', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'testApiGroup', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '15bcdc9453524b7gs8beb1f6de21edb7', - ], - 'Path' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - 'Method' => [ - 'description' => 'The request method of the API.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'testApi', - ], + 'AclName' => ['description' => 'The name of the access control policy.', 'type' => 'string', 'example' => 'testAcl', 'title' => ''], + 'AclId' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'example' => 'acl-3nsohdozz0ru8fi5onwz1', 'title' => ''], + 'AddressIPVersion' => ['description' => 'of the access control policy group IP Version.'."\n" + ."\n" + .'- **IPv4**.'."\n" + ."\n" + .'- **IPv6**.', 'type' => 'string', 'example' => 'ipv4', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeApisByBackend', - ], - 'DescribeApi' => [ - 'summary' => 'Queries the definition of an API.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeAccessControlLists', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccessControlLists'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAccessControlLists', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeApi' => [ + 'summary' => 'Queries the definition of a specified API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8990,32 +5377,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '94305', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'ID of the group that contains the API.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8afff6c8c4c6447abb035812e4d66b65', - ], + 'schema' => ['description' => 'ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8afff6c8c4c6447abb035812e4d66b65', 'title' => ''], ], ], 'responses' => [ @@ -9023,924 +5396,551 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '8afff6c8c4c6447abb035812e4d66b65', - ], - 'ResultType' => [ - 'description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML.'."\n", - 'type' => 'string', - 'example' => 'JSON', - ], - 'WebSocketApiType' => [ - 'description' => 'The type of the two-way communication API.'."\n" - ."\n" - .'* **COMMON**: common API'."\n" - .'* **REGISTER**: registered API'."\n" - .'* **UNREGISTER**: unregistered API'."\n" - .'* **NOTIFY**: downstream notification API'."\n", - 'type' => 'string', - 'example' => 'COMMON', - ], - 'DisableInternet' => [ - 'description' => 'Specifies whether to limit API calls to within the VPC. Valid values:'."\n" - ."\n" - .'* **true**: Only API calls from the VPC are supported.'."\n" - .'* **false**: API calls from the VPC and Internet are both supported.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ResultBodyModel' => [ - 'description' => 'The returned description of the API.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'ResultSample' => [ - 'description' => 'The sample response from the backend service.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'AppCodeAuthType' => [ - 'description' => 'If **AuthType** is set to **APP**, the valid values are:'."\n" - ."\n" - .'* **DEFAULT**: The default value that is used if no other values are passed. This value means that the setting of the group is used.'."\n" - .'* **DISABLE**: The authentication is disabled.'."\n" - .'* **HEADER**: AppCode can be placed in the Header parameter for authentication.'."\n" - .'* **HEADER_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.'."\n", - 'type' => 'string', - 'example' => 'HEADER', - ], - 'AllowSignatureMethod' => [ - 'description' => 'If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - 'type' => 'string', - 'example' => 'HmacSHA256', - ], - 'RegionId' => [ - 'description' => 'The region ID of the API.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'ForceNonceCheck' => [ - 'description' => 'Specifies whether to carry the header : X-Ca-Nonce when calling an API. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent reply attacks. Valid values:'."\n" - ."\n" - .'* **true**: This field is forcibly checked when an API is requested to prevent replay attacks.'."\n" - .'* **false**: This field is not checked.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Visibility' => [ - 'description' => 'Specifies whether to make the API public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'FailResultSample' => [ - 'description' => 'The sample error response from the backend service.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'AuthType' => [ - 'description' => 'The security authentication method of the API. Valid values:'."\n" - ."\n" - .'* **APP**: Only authorized applications can call the API.'."\n" - ."\n" - .'* **ANONYMOUS**: The API can be anonymously called. In this mode, you must take note of the following rules:'."\n" - ."\n" - .' * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.'."\n" - .' * We recommend that you do not make the API whose security authentication method is ANONYMOUS available in Alibaba Cloud Marketplace because API Gateway cannot meter calls on the caller or limit the number of calls on the API. If you want to make the API group to which the API belongs available in Alibaba Cloud Marketplace, we recommend that you move the API to another group, set its type to PRIVATE, or set its security authentication method to APP.'."\n" - ."\n" - .'* **APPOPENID**: The OpenID Connect account authentication method is used. Only applications authorized by OpenID Connect can call the API. If this method is selected, the OpenIdConnectConfig parameter is required.'."\n", - 'type' => 'string', - 'example' => 'APP', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-28T13:13:12Z', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D0FF585F-7966-40CF-BC60-75DB070B23D5<', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Api description', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'ApiTest', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], - 'Mock' => [ - 'description' => 'Specifies whether to enable the Mock mode. Valid values:'."\n" - ."\n" - .'* OPEN: The Mock mode is enabled.'."\n" - .'* CLOSED: The Mock mode is not enabled.'."\n", - 'type' => 'string', - 'example' => 'CLOSED', - ], - 'MockResult' => [ - 'description' => 'The result returned for service mocking.'."\n", - 'type' => 'string', - 'example' => 'test result', - ], - 'CreatedTime' => [ - 'description' => 'The creation time of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-28T09:50:43Z', - ], - 'ApiName' => [ - 'description' => 'The name of the API, which is unique in the group.'."\n", - 'type' => 'string', - 'example' => 'ApiName', - ], - 'BackendEnable' => [ - 'description' => 'Specifies whether to enable backend services.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ApiId' => ['description' => 'ID of the API.', 'type' => 'string', 'example' => '8afff6c8c4c6447abb035812e4d66b65', 'title' => ''], + 'ResultType' => ['description' => 'Format of the response returned by the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'WebSocketApiType' => ['description' => 'Type of bidirectional communication API:'."\n" + ."\n" + .'- **COMMON**: Standard API.'."\n" + ."\n" + .'- **REGISTER**: Registration API.'."\n" + ."\n" + .'- **UNREGISTER**: Unregistration API.'."\n" + ."\n" + .'- **NOTIFY**: Downstream notification API.', 'type' => 'string', 'example' => 'COMMON', 'title' => ''], + 'DisableInternet' => ['description' => 'Specifies whether the API supports only internal network calls. Valid values:'."\n" + ."\n" + .'- **true**: The API supports only internal network calls.'."\n" + ."\n" + .'- **false**: No restriction on call sources.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ResultBodyModel' => ['description' => 'Response body of the API.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ResultSample' => ['description' => 'Example response returned by the backend service.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'AppCodeAuthType' => ['description' => 'Valid only when **AuthType** is set to **APP**. Valid values:'."\n" + ."\n" + .'- **DEFAULT**: Default value. Uses the setting of the group.'."\n" + ."\n" + .'- **DISABLE**: Disabled.'."\n" + ."\n" + .'- **HEADER**: Enables AppCode authentication in the header.'."\n" + ."\n" + .'- **HEADER\\_QUERY**: Enables AppCode authentication in both the header and query string.', 'type' => 'string', 'example' => 'HEADER', 'title' => ''], + 'AllowSignatureMethod' => ['description' => 'Required when **AuthType** is set to **APP**. Specifies the signature algorithm. Valid values: HmacSHA256 and HmacSHA1,HmacSHA256. Default: HmacSHA256.'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256', 'title' => ''], + 'RegionId' => ['description' => 'ID of the region where the API resides.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'ForceNonceCheck' => ['description' => 'Specifies whether the request header X-Ca-Nonce is required. This header is the unique ID of the request, typically a UUID. API Gateway validates this header to prevent replay attacks. Each value can be used only once within 15 minutes. Valid values:'."\n" + ."\n" + .'- **true**: Enforces validation of this header to prevent replay attacks.'."\n" + ."\n" + .'- **false**: Does not validate this header.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Visibility' => ['description' => 'Specifies whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: Public. If selected, the API appears on the Discover APIs page in the console for all users.'."\n" + ."\n" + .'- **PRIVATE**: Private. If selected, the API does not appear in Alibaba Cloud Marketplace when the group is listed.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'FailResultSample' => ['description' => 'Example error response returned by the backend service.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'AuthType' => ['description' => 'Security authentication type for the API. Valid values:'."\n" + ."\n" + .'- **APP**: Only authorized apps can call the API.'."\n" + ."\n" + .'- **ANONYMOUS**: Anonymous calls are allowed. Note the following:'."\n" + ."\n" + .' - Anyone with access to the API endpoint can call it. API Gateway performs no identity verification and cannot apply per-user throttling. If you expose this API, configure throttling at the API level.'."\n" + ."\n" + .' - We do not recommend listing ANONYMOUS APIs in Alibaba Cloud Marketplace. API Gateway cannot meter or limit anonymous calls. If your group is listed in Alibaba Cloud Marketplace, move this API to another group, set its visibility to PRIVATE, or use Alibaba Cloud APP authentication.'."\n" + ."\n" + .'- APPOPENID: Supports third-party OpenID Connect authentication and allows only authorized apps to call the API. When you select this option, **OpenIdConnectConfig** is required.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'ModifiedTime' => ['description' => 'Time when the API was last modified.', 'type' => 'string', 'example' => '2016-07-28T13:13:12Z', 'title' => ''], + 'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => 'D0FF585F-7966-40CF-BC60-75DB070B23D5<', 'title' => ''], + 'Description' => ['description' => 'Description of the API.', 'type' => 'string', 'example' => 'Api description', 'title' => ''], + 'GroupName' => ['description' => 'Name of the group that contains the API.', 'type' => 'string', 'example' => 'ApiTest', 'title' => ''], + 'GroupId' => ['description' => 'ID of the group that contains the API.', 'type' => 'string', 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], + 'Mock' => ['description' => 'Specifies whether mock mode is enabled. Valid values:'."\n" + ."\n" + .'- OPEN: Mock mode is enabled.'."\n" + ."\n" + .'- CLOSED: Mock mode is disabled.', 'type' => 'string', 'example' => 'CLOSED', 'title' => ''], + 'MockResult' => ['description' => 'Mock response.', 'type' => 'string', 'example' => 'test result', 'title' => ''], + 'CreatedTime' => ['description' => 'Time when the API was created.', 'type' => 'string', 'example' => '2016-07-28T09:50:43Z', 'title' => ''], + 'ApiName' => ['description' => 'Name of the API. Must be unique within the group.', 'type' => 'string', 'example' => 'ApiName', 'title' => ''], + 'BackendEnable' => ['description' => 'Specifies whether the backend service is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'BackendConfig' => [ - 'description' => 'Backend configurations'."\n", + 'description' => 'Backend configuration.', 'type' => 'object', 'properties' => [ - 'BackendId' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'example' => '0038e00c3dca44fcba3a94015d8f5bbf', - ], - 'BackendType' => [ - 'description' => 'Backend service type'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'BackendName' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'example' => 'testoss', - ], + 'BackendId' => ['description' => 'ID of the backend service.', 'type' => 'string', 'example' => '0038e00c3dca44fcba3a94015d8f5bbf', 'title' => ''], + 'BackendType' => ['description' => 'Type of the backend service.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'BackendName' => ['description' => 'Name of the backend service.', 'type' => 'string', 'example' => 'testoss', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'RequestConfig' => [ - 'description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n", + 'description' => 'Configuration for requests sent from consumers to API Gateway.', 'type' => 'object', 'properties' => [ - 'BodyModel' => [ - 'description' => 'The body model.'."\n", - 'type' => 'string', - 'example' => 'https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab', - ], - 'RequestPath' => [ - 'description' => 'The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is ` /object/add `.'."\n", - 'type' => 'string', - 'example' => '/api/billing/test/[type]', - ], - 'RequestHttpMethod' => [ - 'description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'BodyFormat' => [ - 'description' => 'This parameter takes effect only when the RequestMode parameter is set to MAPPING.********'."\n" - ."\n" - .'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.'."\n", - 'type' => 'string', - 'example' => 'STREAM', - ], - 'RequestMode' => [ - 'description' => 'The request mode. Valid values: MAPPING and PASSTHROUGH.'."\n", - 'type' => 'string', - 'example' => 'MAPPING', - ], - 'PostBodyDescription' => [ - 'description' => 'The description of the request body.'."\n", - 'type' => 'string', - 'example' => 'fwefwef', - ], - 'RequestProtocol' => [ - 'description' => 'The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'EscapePathParam' => [ - 'description' => 'Whether to escape the Path parameter, if true, the [param] on the Path will be treated as a regular character.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'BodyModel' => ['description' => 'Body model.', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab', 'title' => ''], + 'RequestPath' => ['description' => 'API path. For example, if the full URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the path is `/object/add`.', 'type' => 'string', 'example' => '/api/billing/test/[type]', 'title' => ''], + 'RequestHttpMethod' => ['description' => 'HTTP method. Valid values: GET, POST, DELETE, PUT, HEAD, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'BodyFormat' => ['description' => 'Valid only when **RequestMode** is **MAPPING**. Specifies how data is sent to the server for POST or PUT requests. Valid values: **FORM** (key-value pairs) and **STREAM** (byte stream).'."\n" + ."\n" + .'When you send a POST or PUT request, this parameter specifies how data is sent to the server. Valid values are **FORM** and **STREAM**, which represent form format (key-value pairs) and byte stream format, respectively.', 'type' => 'string', 'example' => 'STREAM', 'title' => ''], + 'RequestMode' => ['description' => 'Request mapping mode. Valid values: **MAPPING** (maps input parameters) and **PASSTHROUGH** (passes input parameters through unchanged).', 'type' => 'string', 'example' => 'MAPPING', 'title' => ''], + 'PostBodyDescription' => ['description' => 'Description of the request body.', 'type' => 'string', 'example' => 'fwefwef', 'title' => ''], + 'RequestProtocol' => ['description' => 'Supported protocols for the API. Multiple values are comma-separated, such as HTTP,HTTPS. Valid values: HTTP and HTTPS.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'EscapePathParam' => ['description' => 'Specifies whether to escape path parameters. If true, parameters like \\[param] in the path are treated as literal characters.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ServiceConfig' => [ - 'description' => 'The configuration items of API requests that API Gateway sends to the backend service.'."\n", + 'description' => 'Configuration for requests sent from API Gateway to the backend service.', 'type' => 'object', 'properties' => [ - 'AoneAppName' => [ - 'description' => 'The application name in AONE.'."\n", - 'type' => 'string', - 'example' => 'ib-blank', - ], - 'MockStatusCode' => [ - 'description' => 'The status code returned for service mocking.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ContentTypeValue' => [ - 'description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', - ], - 'ServiceProtocol' => [ - 'description' => 'The protocol used by the backend service. Valid values: HTTP and HTTPS.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ServicePath' => [ - 'description' => 'The path used to call the back-end service. If the complete back-end service path is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServicePath is **/object/add**.``'."\n", - 'type' => 'string', - 'example' => '/object/add', - ], - 'ContentTypeCatagory' => [ - 'description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" - ."\n" - .'* **DEFAULT**: the default header type in API Gateway'."\n" - .'* **CUSTOM**: a custom header type'."\n" - .'* **CLIENT**: the ContentType header type of the client'."\n", - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'ServiceAddress' => [ - 'description' => 'The URL used to call the back-end service. If the complete back-end service URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the value of ServiceAddress is **http://api.a.com:8080**.``'."\n", - 'type' => 'string', - 'example' => 'http://api.a.com:8080', - ], - 'Mock' => [ - 'description' => 'Specifies whether to enable the Mock mode. Valid values:'."\n" - ."\n" - .'* **TRUE**: The Mock mode is enabled.'."\n" - .'* **FALSE**: The Mock mode is not enabled.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'ServiceVpcEnable' => [ - 'description' => 'Specifies whether to enable the VPC channel. Valid values:'."\n" - ."\n" - .'* **TRUE**: The VPC channel is enabled. You must create the corresponding VPC access authorization before you can enable a VPC channel.'."\n" - .'* **FALSE**: The VPC channel is not enabled.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'MockResult' => [ - 'description' => 'The result returned when the Mock mode is enabled.'."\n", - 'type' => 'string', - 'example' => 'test result', - ], - 'ServiceHttpMethod' => [ - 'description' => 'The HTTP method used to call a backend service. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'ServiceTimeout' => [ - 'description' => 'The timeout period of the backend service. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], + 'AoneAppName' => ['description' => 'Name of the Aone application.', 'type' => 'string', 'example' => 'ib-blank', 'title' => ''], + 'MockStatusCode' => ['description' => 'Status code returned by mock responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ContentTypeValue' => ['description' => 'Value of the Content-Type header when ContentTypeCatagory is DEFAULT or CUSTOM.', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', 'title' => ''], + 'ServiceProtocol' => ['description' => 'Protocol used to connect to the backend service. Valid values: HTTP and HTTPS.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ServicePath' => ['description' => 'Path used to call the backend service. For example, if the full URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the path is `/object/add`.', 'type' => 'string', 'example' => '/object/add', 'title' => ''], + 'ContentTypeCatagory' => ['description' => 'Strategy for setting the Content-Type header when calling an HTTP backend service:'."\n" + ."\n" + .'- **DEFAULT**: Use the default value provided by API Gateway.'."\n" + ."\n" + .'- **CUSTOM**: Use a custom value.'."\n" + ."\n" + .'- **CLIENT**: Use the Content-Type header from the client request.', 'type' => 'string', 'example' => 'CUSTOM', 'title' => ''], + 'ServiceAddress' => ['description' => 'Endpoint used to call the backend service. For example, if the full URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the endpoint is `http://api.a.com:8080`.', 'type' => 'string', 'example' => 'http://api.a.com:8080', 'title' => ''], + 'Mock' => ['description' => 'Specifies whether mock mode is enabled. Valid values:'."\n" + ."\n" + .'- **TRUE**: Mock mode is enabled.'."\n" + ."\n" + .'- **FALSE**: Mock mode is disabled.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'ServiceVpcEnable' => ['description' => 'Specifies whether VPC channel is enabled. Valid values:'."\n" + ."\n" + .'- **TRUE**: VPC channel is enabled. You must first authorize the VPC before enabling this feature.'."\n" + ."\n" + .'- **FALSE**: VPC channel is disabled.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'MockResult' => ['description' => 'Response returned when mock mode is enabled.', 'type' => 'string', 'example' => 'test result', 'title' => ''], + 'ServiceHttpMethod' => ['description' => 'HTTP method used to call the backend service. Valid values: GET, POST, DELETE, PUT, HEAD, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ServiceTimeout' => ['description' => 'Timeout period for the backend service, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'MockHeaders' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MockHeader' => [ - 'description' => 'The simulated headers.'."\n", + 'description' => 'Mock headers.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'HeaderValue' => [ - 'description' => 'The value of the HTTP header.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'HeaderName' => [ - 'description' => 'The HTTP header.'."\n", - 'type' => 'string', - 'example' => 'Content-Length', - ], + 'HeaderValue' => ['description' => 'Value of the HTTP header parameter.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'HeaderName' => ['description' => 'Name of the HTTP header parameter.', 'type' => 'string', 'example' => 'Content-Length', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'VpcConfig' => [ - 'description' => 'Configuration items related to VPC channels'."\n", + 'description' => 'VPC channel configuration.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zeafsc3fygk1***', - ], - 'VpcScheme' => [ - 'description' => 'The VPC protocol.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'InstanceId' => [ - 'description' => 'The ID of the ECS or SLB instance in the VPC.'."\n", - 'type' => 'string', - 'example' => 'i-bp1h497hkijewv2***', - ], - 'Port' => [ - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'Name' => [ - 'description' => 'The name of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'glmall-app-test', - ], + 'VpcId' => ['description' => 'ID of the VPC.', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***', 'title' => ''], + 'VpcScheme' => ['description' => 'VPC protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'InstanceId' => ['description' => 'ID of the instance (ECS or Server Load Balancer) in the VPC.', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***', 'title' => ''], + 'Port' => ['description' => 'Port number of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'Name' => ['description' => 'Name of the VPC authorization.', 'type' => 'string', 'example' => 'glmall-app-test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'FunctionComputeConfig' => [ - 'description' => 'Backend configuration items when the backend service is Function Compute'."\n", + 'description' => 'Backend configuration for Function Compute.', 'type' => 'object', 'properties' => [ - 'FcType' => [ - 'description' => 'The type of the Function Compute instance.'."\n", - 'type' => 'string', - 'example' => 'HttpTrigger', - ], - 'RoleArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', - ], - 'Method' => [ - 'description' => 'The request method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'FcBaseUrl' => [ - 'description' => 'The root path of Function Compute.'."\n", - 'type' => 'string', - 'example' => 'https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/', - ], - 'ContentTypeValue' => [ - 'description' => 'The value of the ContentType header when the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', - ], - 'RegionId' => [ - 'description' => 'The region where the Function Compute instance is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'OnlyBusinessPath' => [ - 'description' => 'The backend only receives the service path.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'FunctionName' => [ - 'description' => 'The function name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'edge_function', - ], - 'ContentTypeCatagory' => [ - 'description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" - ."\n" - .'* **DEFAULT**: the default header type in API Gateway'."\n" - .'* **CUSTOM**: a custom header type'."\n" - .'* **CLIENT**: the ContentType header type of the client'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'Path' => [ - 'description' => 'The API request path.'."\n", - 'type' => 'string', - 'example' => '/api/offline/cacheData', - ], - 'ServiceName' => [ - 'description' => 'The service name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'fcservicename', - ], - 'Qualifier' => [ - 'description' => 'The alias of the function.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'TriggerName' => [ - 'type' => 'string', - 'description' => 'The name of the trigger.'."\n" - ."\n" - .'You can specify the TriggerName or TriggerUrl parameter. The TriggerName parameter is optional.'."\n", - 'example' => 'test1', - ], - 'FcVersion' => [ - 'type' => 'string', - ], + 'FcType' => ['description' => 'Function Compute service type.', 'type' => 'string', 'example' => 'HttpTrigger', 'title' => ''], + 'RoleArn' => ['description' => 'ARN of the RAM role that grants API Gateway permission to access Function Compute.', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', 'title' => ''], + 'Method' => ['description' => 'HTTP method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'FcBaseUrl' => ['description' => 'Root path of the Function Compute service.', 'type' => 'string', 'example' => 'https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/', 'title' => ''], + 'ContentTypeValue' => ['description' => 'Value of the Content-Type header when ContentTypeCatagory is DEFAULT or CUSTOM.', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', 'title' => ''], + 'RegionId' => ['description' => 'Region where Function Compute resides.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'OnlyBusinessPath' => ['description' => 'Specifies whether only the business path is passed to the backend.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'FunctionName' => ['description' => 'Name of the Function Compute function.', 'type' => 'string', 'example' => 'edge_function', 'title' => ''], + 'ContentTypeCatagory' => ['description' => 'Strategy for setting the Content-Type header when calling a Function Compute backend service:'."\n" + ."\n" + .'- **DEFAULT**: Use the default value provided by API Gateway.'."\n" + ."\n" + .'- **CUSTOM**: Use a custom value.'."\n" + ."\n" + .'- **CLIENT**: Use the Content-Type header from the client request.', 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'Path' => ['description' => 'API request path.', 'type' => 'string', 'example' => '/api/offline/cacheData', 'title' => ''], + 'ServiceName' => ['description' => 'Name of the Function Compute service.', 'type' => 'string', 'example' => 'fcservicename', 'title' => ''], + 'Qualifier' => ['description' => 'Alias of the function.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'TriggerName' => ['description' => 'The name of the trigger.'."\n" + ."\n" + .'You can specify the TriggerName or TriggerUrl parameter. The TriggerName parameter is optional.'."\n", 'type' => 'string', 'title' => '', 'example' => ''], + 'FcVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'OssConfig' => [ - 'description' => 'The information returned when the backend service is Object Storage Service (OSS).'."\n", + 'description' => 'OSS backend configuration.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The stored object or folder path.'."\n", - 'type' => 'string', - 'example' => '/folder/test.json', - ], - 'Action' => [ - 'description' => 'The operation options on OSS. Valid values:'."\n" - ."\n" - .'* GetObject'."\n" - .'* PostObject'."\n" - .'* DeleteObject'."\n" - .'* PutObject'."\n" - .'* HeadObject'."\n" - .'* GetObjectMeta'."\n" - .'* AppendObject'."\n", - 'type' => 'string', - 'example' => 'GetObject', - ], - 'OssRegionId' => [ - 'description' => 'The ID of the region where the OSS instance is located.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'BucketName' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'cbg-db', - ], + 'Key' => ['description' => 'Path to the object or folder in OSS.', 'type' => 'string', 'example' => '/folder/test.json', 'title' => ''], + 'Action' => ['description' => 'OSS operation. Valid values:'."\n" + ."\n" + .'- GetObject'."\n" + ."\n" + .'- PostObject'."\n" + ."\n" + .'- DeleteObject'."\n" + ."\n" + .'- PutObject'."\n" + ."\n" + .'- HeadObject'."\n" + ."\n" + .'- GetObjectMeta'."\n" + ."\n" + .'- AppendObject', 'type' => 'string', 'example' => 'GetObject', 'title' => ''], + 'OssRegionId' => ['description' => 'Region ID of the OSS service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'BucketName' => ['description' => 'OSS bucket name.', 'type' => 'string', 'example' => 'cbg-db', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'EventBridgeConfig' => [ - 'description' => 'Configuration items of EventBridge'."\n", + 'description' => 'EventBridge configuration.', 'type' => 'object', 'properties' => [ - 'EventBus' => [ - 'description' => 'The event bus.'."\n", - 'type' => 'string', - 'example' => 'testBus', - ], - 'EventSource' => [ - 'description' => 'The event source.'."\n", - 'type' => 'string', - 'example' => 'baas_driver', - ], - 'EventBridgeRegionId' => [ - 'description' => 'The ID of the region where the EventBridge instance is located.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'RoleArn' => [ - 'description' => 'The Arn that is authorized by a RAM user to EventBridge.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun', - ], + 'EventBus' => ['description' => 'Event bus.', 'type' => 'string', 'example' => 'testBus', 'title' => ''], + 'EventSource' => ['description' => 'Event source.', 'type' => 'string', 'example' => 'baas_driver', 'title' => ''], + 'EventBridgeRegionId' => ['description' => 'Region ID of the EventBridge service.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'RoleArn' => ['description' => 'ARN of the RAM role that grants EventBridge permission.', 'type' => 'string', 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'OpenIdConnectConfig' => [ - 'description' => 'Configuration items of the third-party OpenID Connect authentication method'."\n", + 'description' => 'OpenID Connect configuration for third-party account authentication.', 'type' => 'object', 'properties' => [ - 'OpenIdApiType' => [ - 'description' => 'The OpenID Connect mode. Valid values:'."\n" - ."\n" - .'* **IDTOKEN**: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.'."\n" - .'* **BUSINESS**: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.'."\n", - 'type' => 'string', - 'example' => 'IDTOKEN', - ], - 'IdTokenParamName' => [ - 'description' => 'The name of the parameter that corresponds to the token.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'PublicKeyId' => [ - 'description' => 'The ID of the public key.'."\n", - 'type' => 'string', - 'example' => '88483727556929326703309904351185815489', - ], - 'PublicKey' => [ - 'description' => 'The public key.'."\n", - 'type' => 'string', - 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', - ], + 'OpenIdApiType' => ['description' => 'OpenID Connect mode. Valid values:'."\n" + ."\n" + .'- IDTOKEN: Authorization API that issues tokens. When selected, PublicKeyId and **PublicKey** are required.'."\n" + ."\n" + .'- BUSINESS: Business API that validates tokens. When selected, **IdTokenParamName** is required.', 'type' => 'string', 'example' => 'IDTOKEN', 'title' => ''], + 'IdTokenParamName' => ['description' => 'Name of the token parameter.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PublicKeyId' => ['description' => 'ID of the public key.', 'type' => 'string', 'example' => '88483727556929326703309904351185815489', 'title' => ''], + 'PublicKey' => ['description' => 'Public key.', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ErrorCodeSamples' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ErrorCodeSample' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n", + 'description' => 'Example error codes returned by the backend service.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The returned error code.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'Model' => [ - 'description' => 'The model.'."\n", - 'type' => 'string', - 'example' => '[\\"*\\"]', - ], - 'Message' => [ - 'description' => 'The returned error message.'."\n", - 'type' => 'string', - 'example' => 'Missing the parameter UserId', - ], - 'Description' => [ - 'description' => 'The error description.'."\n", - 'type' => 'string', - 'example' => 'The UserId parameter is missing from the request.'."\n", - ], + 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'Model' => ['description' => 'Model.', 'type' => 'string', 'example' => '[\\"*\\"]', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Missing the parameter UserId', 'title' => ''], + 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'Missing parameter UserId', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'SystemParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SystemParameter' => [ - 'description' => 'System parameters sent by API Gateway to the backend service'."\n", + 'description' => 'System parameters sent from API Gateway to the backend service.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DemoValue' => [ - 'description' => 'The example value.'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'Client IP Address'."\n", - ], - 'ParameterName' => [ - 'description' => 'The system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'DemoValue' => ['description' => 'Example value.', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'Description of the parameter.', 'type' => 'string', 'example' => 'Client IP', 'title' => ''], + 'ParameterName' => ['description' => 'Name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'Location' => ['description' => 'Location of the parameter. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'Name of the corresponding backend parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'CustomSystemParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CustomSystemParameter' => [ - 'description' => 'Custom system parameters'."\n", + 'description' => 'List of custom system parameters.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DemoValue' => [ - 'description' => 'The example value.'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'Client IP Address'."\n", - ], - 'ParameterName' => [ - 'description' => 'The name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'DemoValue' => ['description' => 'Example value.', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'Description of the parameter.', 'type' => 'string', 'example' => '客户端IP', 'title' => ''], + 'ParameterName' => ['description' => 'Name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'Location' => ['description' => 'Location of the parameter. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'Name of the corresponding backend parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ConstantParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ConstantParameter' => [ - 'description' => 'System parameters sent by API Gateway to the backend service'."\n", + 'description' => 'Constant parameters sent from API Gateway to the backend service.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], - 'ConstantValue' => [ - 'description' => 'The constant parameter value.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], + 'Description' => ['description' => 'Description of the parameter.', 'type' => 'string', 'example' => 'constance', 'title' => ''], + 'Location' => ['description' => 'Location of the parameter. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'Name of the backend parameter.', 'type' => 'string', 'example' => 'constance', 'title' => ''], + 'ConstantValue' => ['description' => 'Value of the constant parameter.', 'type' => 'string', 'example' => 'constance', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'RequestParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RequestParameter' => [ - 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n", + 'description' => 'Parameters sent from consumers to API Gateway.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'JsonScheme' => [ - 'description' => 'The JSON Schema used for JSON validation when **ParameterType** is set to String.'."\n", - 'type' => 'string', - 'example' => 'JSON', - ], - 'MaxValue' => [ - 'description' => 'The maximum parameter value when **ParameterType** is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'ArrayItemsType' => [ - 'description' => 'The type of the array element.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'MinValue' => [ - 'description' => 'The minimum parameter value when **ParameterType** is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocShow' => [ - 'description' => 'Indicates whether the document is public. Valid values: **PUBLIC** and **PRIVATE**.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'MaxLength' => [ - 'description' => 'The maximum parameter length when **ParameterType** is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'ApiParameterName' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'age', - ], - 'EnumValue' => [ - 'description' => 'The hash values that are supported when **ParameterType** is set to Int, Long, Float, Double, or String. Separate values with commas (,). Examples: 1,2,3,4,9 and A,B,C,E,F.'."\n", - 'type' => 'string', - 'example' => 'boy,girl', - ], - 'DemoValue' => [ - 'description' => 'The example value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required. Valid values: **REQUIRED** and **OPTIONAL**.'."\n", - 'type' => 'string', - 'example' => 'OPTIONAL', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'Age'."\n", - ], - 'ParameterType' => [ - 'description' => 'The data type of the parameter. Valid values: String, Int, Long, Float, Double, and Boolean.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'RegularExpression' => [ - 'description' => 'The regular expression that is used for parameter validation when **ParameterType** is set to String.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'MinLength' => [ - 'description' => 'The minimum parameter length when **ParameterType** is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocOrder' => [ - 'description' => 'The order in which the parameter is sorted in the document.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], + 'JsonScheme' => ['description' => 'JSON schema validation. Valid only when **ParameterType** is String.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'MaxValue' => ['description' => 'Maximum value. Valid only when **ParameterType** is Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'ArrayItemsType' => ['description' => 'Type of the array element.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'MinValue' => ['description' => 'Minimum value. Valid only when **ParameterType** is Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocShow' => ['description' => 'Visibility in the documentation. Valid values: **PUBLIC** and **PRIVATE**.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'MaxLength' => ['description' => 'Maximum length of the parameter. Valid only when **ParameterType** is String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DefaultValue' => ['description' => 'Default value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'ApiParameterName' => ['description' => 'Parameter name.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'EnumValue' => ['description' => 'Allowed discrete values. Valid only when **ParameterType** is Int, Long, Float, Double, or String. Separate multiple values with commas, such as 1,2,3,4,9 or A,B,C,E,F.', 'type' => 'string', 'example' => 'boy,girl', 'title' => ''], + 'DemoValue' => ['description' => 'Example value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'Required' => ['description' => 'Specifies whether the parameter is required. Valid values: **REQUIRED** and **OPTIONAL**.', 'type' => 'string', 'example' => 'OPTIONAL', 'title' => ''], + 'Description' => ['description' => 'Description of the parameter.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'ParameterType' => ['description' => 'Type of the parameter. Valid values: String, Int, Long, Float, Double, and Boolean.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'RegularExpression' => ['description' => 'Regular expression for parameter validation. Valid only when **ParameterType** is String.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'MinLength' => ['description' => 'Minimum length of the parameter. Valid only when **ParameterType** is String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocOrder' => ['description' => 'Order in the documentation.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Location' => ['description' => 'Location of the parameter. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ServiceParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ServiceParameter' => [ - 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n", + 'description' => 'Parameters that the gateway sends to the backend service in an API request.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ParameterType' => [ - 'description' => 'The data type of the parameter. Valid values: STRING, NUMBER, and BOOLEAN.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'Location' => ['description' => 'The location of the parameter. Valid values: BODY, HEAD, QUERY, PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ParameterType' => ['description' => 'Backend parameter data type. Values can be STRING, NUMBER, or BOOLEAN, representing character, number, and Boolean respectively.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the backend parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ServiceParametersMap' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ServiceParameterMap' => [ - 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n", + 'description' => 'Mapping between parameters that the consumer sends to the gateway and parameters that the gateway sends to the backend service.', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RequestParameterName' => [ - 'description' => 'The corresponding frontend parameter name. The value must be contained in RequestParametersObject and match RequestParam.ApiParameterName.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], + 'RequestParameterName' => ['description' => 'Corresponds to the frontend request parameter name. This value must exist in RequestParametersObject and match RequestParam.ApiParameterName.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'ServiceParameterName' => ['description' => 'Backend parameter name', 'type' => 'string', 'example' => 'name', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'DeployedInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DeployedInfo' => [ - 'description' => 'The API publishing status.'."\n", + 'description' => 'API publish status', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values: RELEASE and TEST.'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'EffectiveVersion' => [ - 'description' => 'The effective version.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'DeployedStatus' => [ - 'description' => 'The deployment status. Valid values: DEPLOYED and NONDEPLOYED.'."\n", - 'type' => 'string', - 'example' => 'DEPLOYED', - ], + 'StageName' => ['description' => 'The environment name can be RELEASE or TEST.', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'EffectiveVersion' => ['description' => 'The effective version.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'DeployedStatus' => ['description' => 'The deployment status. Valid values: DEPLOYED and NONDEPLOYED. DEPLOYED indicates that the API is deployed. NONDEPLOYED indicates that the API is not deployed.', 'type' => 'string', 'example' => 'DEPLOYED', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'TagList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ - 'description' => 'Tag List.', + 'description' => 'Tag list', + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'description' => 'Label key.', - 'type' => 'string', - 'example' => 'APP', - ], - 'TagValue' => [ - 'description' => 'Label value.', - 'type' => 'string', - 'example' => 'value3', - ], + 'TagKey' => ['description' => 'Tag key', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'TagValue' => ['description' => 'Tag value', 'type' => 'string', 'example' => 'value3', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"请求缺少参数 UserId\\"\\n }\\n ]\\n },\\n \\"SystemParameters\\": {\\n \\"SystemParameter\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"客户端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\\": \\"年龄\\",\\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"}]', + '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' => 'DescribeApi', - 'description' => '* This operation is intended for API providers.'."\n", + 'description' => '- This operation is intended for users who publish APIs.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApiMarketAttributes' => [ - 'summary' => 'Queries the Alibaba Cloud Marketplace attributes of an API.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeApiDoc' => [ + 'summary' => 'Queries the documentation of an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9949,33 +5949,30 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94319', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeCode' => '94306', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b693252f3f19445e9a01dac177c4454c', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment name. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**'."\n" + ."\n" + .'If this parameter is not specified, the default value RELEASE is used.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'release', 'example' => 'RELEASE', 'title' => ''], ], [ 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1f9b5e9ba80943099cac52e040b7e160', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], ], ], 'responses' => [ @@ -9983,44 +5980,164 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '6318cd8f6a304cac9318dea8d9a78f7a', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6', + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => 'b24be7e59a104e52bffbf432cc9272af', 'title' => ''], + 'ResultType' => ['description' => 'The return value type.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'DisableInternet' => ['description' => '- Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" + ."\n" + .'- If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResultSample' => ['description' => 'The sample response.', 'type' => 'string', 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the API group.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ForceNonceCheck' => ['description' => '- Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values: PUBLIC and PRIVATE.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'FailResultSample' => ['description' => 'The sample error response from the backend service.', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', 'title' => ''], + 'AuthType' => ['description' => 'The security authentication method. Valid values: APP, ANONYMOUS, and APPOPENID, indicating respectively Alibaba Cloud application authentication, anonymous authentication, and third-party OpenID Connect account authentication.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F253FB5F-9AE1-5DDA-99B5-46BE00A3719E', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'f51d08c5b7c84342905544ebaec26d35', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'Membership era trading service', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'Lynk&Co Digital Mall OMS-UAT', 'title' => ''], + 'DeployedTime' => ['description' => 'The publishing time.', 'type' => 'string', 'example' => '2022-07-13T16:00:33Z', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API', 'type' => 'string', 'example' => 'Get keyword QR code URL', 'title' => ''], + 'RequestConfig' => [ + 'description' => 'The returned API frontend definition. It is an array consisting of RequestConfig data.', + 'type' => 'object', + 'properties' => [ + 'RequestPath' => ['description' => 'The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is `/object/add `.', 'type' => 'string', 'example' => '/api/billing/test/[type]', 'title' => ''], + 'RequestHttpMethod' => ['description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'BodyFormat' => ['description' => 'This parameter takes effect only when the RequestMode parameter is set to MAPPING.\\*\\*\\*\\*\\*\\*\\*\\*'."\n" + ."\n" + .'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.', 'type' => 'string', 'example' => 'STREAM', 'title' => ''], + 'RequestMode' => ['description' => 'The request mode. Valid values:'."\n" + ."\n" + .'- MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" + ."\n" + .'- PASSTHROUGH: Parameters are passed through.'."\n" + ."\n" + .'- MAPPING\\_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.', 'type' => 'string', 'example' => 'MAPPING', 'title' => ''], + 'PostBodyDescription' => ['description' => 'The description of the request body.', 'type' => 'string', 'example' => 'fwefwef', 'title' => ''], + 'RequestProtocol' => ['description' => 'The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'EscapePathParam' => ['description' => 'Whether to escape the Path parameter, if true, the \\[param] on the Path will be treated as a regular character.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'MarketChargingMode' => [ - 'description' => 'The billing method used by the Alibaba Cloud Marketplace.'."\n", - 'type' => 'string', - 'example' => 'PREPAID_BY_USAGE', + 'ErrorCodeSamples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorCodeSample' => [ + 'description' => 'The sample error codes returned by the backend service.', + 'type' => 'array', + 'items' => [ + 'description' => 'The sample error codes returned by the backend service.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The returned error code.', 'type' => 'string', 'example' => 'Error', 'title' => ''], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => 'error message', 'title' => ''], + 'Description' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'Unauthorized', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'NeedCharging' => [ - 'description' => 'Indicates whether fees are charged.'."\n", - 'type' => 'string', - 'example' => 'true', + 'RequestParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParameter' => [ + 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.', + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'MaxValue' => ['description' => 'The maximum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'ArrayItemsType' => ['description' => 'The type of the array element.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'MinValue' => ['description' => 'The minimum value.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocShow' => ['description' => 'Indicates whether the document is public. Valid values: **PUBLIC** and **PRIVATE**.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'ApiParameterName' => ['description' => 'The name of the parameter in the API request.', 'type' => 'string', 'example' => 'Length', 'title' => ''], + 'EnumValue' => ['description' => 'The hash values that are supported when **ParameterType** is set to Int, Long, Float, Double, or String. Separate values with commas (,). Examples: 1,2,3,4,9 and A,B,C,E,F.', 'type' => 'string', 'example' => 'boy,girl', 'title' => ''], + 'DemoValue' => ['description' => 'The example value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'string', 'example' => 'OPTIONAL', 'title' => ''], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'Parameter description', 'title' => ''], + 'ParameterType' => ['description' => 'The data type of the parameter.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'RegularExpression' => ['description' => 'The regular expression that is used for parameter validation when **ParameterType** is set to String.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'DocOrder' => ['description' => 'The order in which the parameter is sorted in the document.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"6318cd8f6a304cac9318dea8d9a78f7a\\",\\n \\"RequestId\\": \\"545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6\\",\\n \\"MarketChargingMode\\": \\"PREPAID_BY_USAGE\\",\\n \\"NeedCharging\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'DescribeApiMarketAttributes', - ], - 'DescribeApis' => [ - 'summary' => 'Queries a list of APIs that are being defined.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApiDoc', + 'description' => '- For API callers, the specified API must be a public or authorized private API that has been published to a runtime environment.'."\n" + ."\n" + .'- When you call this operation as an API caller, the service information, parameter definitions, and other details of the API you specify are returned.'."\n" + ."\n" + .'- When you call this operation as an API provider, the definition of the specified API running in the specified runtime environment is returned. The returned definition takes effect in the runtime environment, and may be different from the definition of the API you modify.'."\n" + ."\n" + .'- Before you call this operation as an API provider, ensure that the API to be queried is a public one or that your application has been authorized to call the API, because authentication on API callers is required.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiDoc'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiDoc', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApiGroup' => [ + 'summary' => 'Queries a specified API group, including its system-generated second-level domain name, custom domain names, and SSL Certificate information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10029,167 +6146,365 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94311', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c4a4d2de657548a2bd485d5d4df42b4a', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and is globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', + 'description' => 'The object tags. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'appname', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test_app', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'f68c19ee3bd1478fb58aa05ce8ae9b5a', + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], - [ - 'name' => 'ApiName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The API name. The name is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'weather', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the group.'."\n" + ."\n" + .'- **NORMAL**: The group is normal.'."\n" + ."\n" + .'- **DELETE**: The group is deleted.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'CompatibleFlags' => ['description' => 'A list of associated tags. Multiple tags are separated by commas (,).', 'type' => 'string', 'example' => 'depart:dep1', 'title' => ''], + 'BasePath' => ['description' => 'The root path of the API.', 'type' => 'string', 'example' => '/qqq', 'title' => ''], + 'Ipv6Status' => ['description' => 'The IPv6 status.', 'type' => 'string', 'example' => 'UNBIND', 'title' => ''], + 'UserLogConfig' => ['description' => 'The user log settings.', 'type' => 'string', 'example' => '{\\"requestBody\\":true,\\"responseBody\\":true,\\"queryString\\":\\"test\\",\\"requestHeaders\\":\\"test\\",\\"responseHeaders\\":\\"test\\",\\"jwtClaims\\":\\"test\\"}', 'title' => ''], + 'CustomerConfigs' => ['description' => 'The list of custom configuration items.', 'type' => 'string', 'example' => 'removeResponseServerHeader', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519', 'title' => ''], + 'Description' => ['description' => 'The description of the API group.', 'type' => 'string', 'example' => 'New weather informations.', 'title' => ''], + 'HttpsPolicy' => ['description' => 'The HTTPS policy.', 'type' => 'string', 'example' => 'HTTPS2_TLS1_0', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain name that is assigned to the group by the system.', 'type' => 'string', 'example' => '27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time, which is in UTC.', 'type' => 'string', 'example' => '2016-08-01T06:53:02Z', 'title' => ''], + 'DefaultDomain' => ['description' => 'The default domain name.', 'type' => 'string', 'example' => 'mkt.api.gaore.com', 'title' => ''], + 'CmsMonitorGroup' => ['description' => 'The Cloud Monitor application group.', 'type' => 'string', 'example' => '217008423', 'title' => ''], + 'BillingStatus' => ['description' => 'The billing status.'."\n" + ."\n" + .'- **NORMAL**: The billing is normal.'."\n" + ."\n" + .'- **LOCKED**: The group is locked due to an overdue payment.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'TrafficLimit' => ['description' => 'The maximum number of queries per second (QPS) for the group. The default value is 500. To increase the limit, submit a request.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'PassthroughHeaders' => ['description' => 'The pass-through headers.', 'type' => 'string', 'example' => 'eagleeye-rpcid,x-b3-traceid', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], + 'VpcDomain' => ['description' => 'The VPC domain name.', 'type' => 'string', 'example' => 'e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com', 'title' => ''], + 'InstanceType' => ['description' => 'The instance type.'."\n" + ."\n" + .'- CLASSIC\\_SHARED: a shared instance in the classic network.'."\n" + ."\n" + .'- VPC\\_SHARED: a shared instance in a VPC.'."\n" + ."\n" + .'- VPC\\_DEDICATED: a dedicated instance in a VPC.', 'type' => 'string', 'example' => 'VPC_SHARED', 'title' => ''], + 'CustomTraceConfig' => ['description' => 'The custom trace configuration.', 'type' => 'string', 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}', 'title' => ''], + 'RegionId' => ['description' => 'The region where the group is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time, in UTC.', 'type' => 'string', 'example' => '2016-08-01T06:54:32Z', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and is globally unique.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'NewWeather', 'title' => ''], + 'IllegalStatus' => ['description' => 'The lock status due to illegal activities.'."\n" + ."\n" + .'- **NORMAL**: The group is normal.'."\n" + ."\n" + .'- **LOCKED**: The group is locked due to illegal activities.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'VpcSlbIntranetDomain' => ['description' => 'The private domain name of the VPC SLB instance.', 'type' => 'string', 'example' => '257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com', 'title' => ''], + 'CustomDomains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainItem' => [ + 'description' => 'The information about the custom domain name.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the custom domain name.', + 'type' => 'object', + 'properties' => [ + 'BindStageName' => ['description' => 'The name of the environment to which the domain name is bound.', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'DomainLegalStatus' => ['description' => 'The validity status of the domain name. Valid values:'."\n" + ."\n" + .'- **NORMAL**: The domain name is valid.'."\n" + ."\n" + .'- **ABNORMAL**: The domain name is invalid. This status affects API calls. Resolve the issue as soon as possible.', 'type' => 'string', 'example' => 'ABNORMAL', 'title' => ''], + 'CertificateName' => ['description' => 'The name of the SSL certificate.', 'type' => 'string', 'example' => 'myCertificate', 'title' => ''], + 'CustomDomainType' => ['description' => 'The type of the custom domain name.', 'type' => 'string', 'example' => 'intranet', 'title' => ''], + 'DomainCNAMEStatus' => ['description' => 'The CNAME resolution status of the domain name. Valid values:'."\n" + ."\n" + .'- **RESOLVED**: The domain name is resolved.'."\n" + ."\n" + .'- **UNRESOLVED**: The domain name is not resolved.', 'type' => 'string', 'example' => 'RESOLVED', 'title' => ''], + 'WildcardDomainPatterns' => ['description' => 'The wildcard domain name pattern.', 'type' => 'string', 'example' => '[\\"{test}.test.com\\"]', 'title' => ''], + 'DomainBindingStatus' => ['description' => 'The binding status of the custom domain name. Valid values:'."\n" + ."\n" + .'- **BINDING**: The domain name is being bound.'."\n" + ."\n" + .'- **BOUND**: The domain name is bound.', 'type' => 'string', 'example' => 'BINDING', 'title' => ''], + 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'api.demo.com', 'title' => ''], + 'DomainRemark' => ['description' => 'The remarks about the domain name, such as the cause of an exception.', 'type' => 'string', 'example' => 'The domain name is not registered.', 'title' => ''], + 'DomainWebSocketStatus' => ['description' => 'The status of the domain name that is used for WebSocket connections.', 'type' => 'string', 'example' => 'CLOSE', 'title' => ''], + 'CertificateId' => ['description' => 'The ID of the SSL certificate. This ID is automatically generated by the system and is unique.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], + 'IsHttpRedirectToHttps' => ['description' => 'Indicates whether HTTP requests are redirected to HTTPS.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CertificateValidStart' => ['description' => 'The time when the certificate becomes valid.', 'type' => 'integer', 'format' => 'int64', 'example' => '1689043476000', 'title' => ''], + 'CertificateValidEnd' => ['description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '2635123476000', 'title' => ''], + 'BindStageAlias' => ['description' => 'The alias of the environment to which the domain name is bound.', 'type' => 'string', 'example' => 'TEST1', 'title' => ''], + 'SslVerifyDepth' => ['description' => 'The certificate verification depth.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'SslOcspEnable' => ['description' => 'Indicates whether Online Certificate Status Protocol (OCSP) validation is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SslOcspCacheEnable' => ['description' => 'Indicates whether OCSP caching is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ClientCertSDnPassThrough' => ['description' => 'Indicates whether the \\`ssl\\_client\\_s\\_dn\\` value in the certificate is passed to the backend service through the \\`X-Client-S-Dn\\` header.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StageItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StageInfo' => [ + 'description' => 'The information about the environment.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the environment.', + 'type' => 'object', + 'properties' => [ + 'StageId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => '123e8dc7bbe01613b5b1d726c2a7888e', 'title' => ''], + 'StageName' => ['description' => 'The environment name.', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'Description' => ['description' => 'The description of the environment.', 'type' => 'string', 'example' => 'MYTEST', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'CloudMarketCommodity' => ['description' => 'The Alibaba Cloud Marketplace product.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DedicatedInstanceType' => ['description' => 'The type of the dedicated instance in which the group is located.'."\n" + ."\n" + .'- VPC-connected dedicated instance: \\`vpc\\_connect\\`'."\n" + ."\n" + .'- Legacy dedicated instance: \\`normal\\`', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'MigrationStatus' => ['description' => 'The status of the task to migrate the group to another instance.'."\n" + ."\n" + .'- \\`Running\\`'."\n" + ."\n" + .'- \\`Success\\`'."\n" + ."\n" + .'- \\`Fail\\`', 'type' => 'string', 'example' => 'Fail', 'title' => ''], + 'MigrationError' => ['description' => 'The cause of the migration failure. This parameter is returned when the value of \\`MigrationStatus\\` is \\`Fail\\`.', 'type' => 'string', 'example' => 'The current instance conflicts with the target instance.', 'title' => ''], + 'DisableInnerDomain' => ['description' => 'Indicates whether to disable access from the internet through the second-level domain name.'."\n" + ."\n" + .'- \\`true\\`: Access from the internet through the second-level domain name is disabled.'."\n" + ."\n" + .'- \\`false\\`: Access from the internet through the second-level domain name is allowed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CustomAppCodeConfig' => ['description' => 'The custom AppCode configuration.', 'type' => 'string', 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApiGroup', + 'description' => '- This operation is intended for API providers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'CatalogId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1553414085247362', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'DescribeApiGroupVpcWhitelist' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Visibility', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94314', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f6c64214dc27400196eef954575d60d3', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: The API is public. If you publish the definition of a public API to the production environment, the definition is displayed on the APIs page for all users.'."\n" - .'* **PRIVATE**: The API is private. If you publish an API group that contains a private API in Alibaba Cloud Marketplace, the API is not displayed in Alibaba Cloud Marketplace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', + 'type' => 'object', + 'properties' => [ + 'VpcIds' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp11w979o2s9rcr962w25', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeApiGroupVpcWhitelist', + 'summary' => 'Queries the VPC whitelist that is allowed to access an API group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiGroupVpcWhitelist'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + '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' => [ + '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' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that can be specified in the name of the API group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Traffic', 'title' => ''], + ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 50. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'EnableTagAuth', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable tag verification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable tag verification.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apigateway-cn-v6419k43245xx', 'title' => ''], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => ['description' => 'The order. Valid values: asc and desc. Default value: desc.'."\n" + ."\n" + .'* asc: The API groups are displayed in ascending order of modification time.'."\n" + .'* desc: The API groups are displayed in descending order of modification time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags of objects that match the rule.'."\n", + 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, 'description' => '', + 'title' => '', ], 'required' => false, - 'example' => 'Key, Value', 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'ApiPath', - 'in' => 'query', - 'schema' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/illegal/query', - ], - ], - [ - 'name' => 'ApiMethod', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP method of the API request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - ], - [ - 'name' => 'UnDeployed', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to filter unpublished APIs.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'BasePath', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which you want to perform this operation. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The root path of the API.'."\n", 'example' => ' /edmdgp/service20250116management01/v1', 'title' => ''], ], ], 'responses' => [ @@ -10197,188 +6512,227 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'ApiSummarys' => [ + 'PageNumber' => ['description' => 'The number of pages to return the results on.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ApiGroupAttributes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiSummary' => [ - 'description' => 'The queried API definitions.'."\n", + 'ApiGroupAttribute' => [ + 'description' => 'The returned group set.'."\n", + 'title' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: The API is public.'."\n" - .'* **PRIVATE**: The API is private.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => '5af418828f0344a3b588c0cc1331a3bc', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'Creates an object'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'myGroup2', - ], - 'GroupId' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'example' => '1084f9034c744137901057206b39d2b6', - ], - 'CreatedTime' => [ - 'description' => 'The time when the API was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2016-05-20T18:18:25Z', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'CreateObject'."\n", - ], - 'RegionId' => [ - 'description' => 'The ID of the region to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'ApiPath' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/sqb/', - ], - 'ApiMethod' => [ - 'description' => 'The HTTP method of the API request.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'DeployedInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DeployedInfo' => [ - 'description' => 'The API publishing statuses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The API publishing status.'."\n", - 'type' => 'object', - 'properties' => [ - 'StageName' => [ - 'description' => 'Stage Name:'."\n" - ."\n" - .'* **RELEASE**: production environment'."\n" - .'* **PRE**: staging environment'."\n" - .'* **TEST**: test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'EffectiveVersion' => [ - 'description' => 'The deployed version.'."\n", - 'type' => 'string', - 'example' => '20220103170737313', - ], - 'DeployedStatus' => [ - 'description' => 'The deployment status. Valid values: DEPLOYED and NONDEPLOYED.'."\n", - 'type' => 'string', - 'example' => 'DEPLOYED', - ], - ], - ], - ], - ], - ], - 'TagList' => [ + 'BasePath' => ['description' => 'The basepath.'."\n", 'type' => 'string', 'example' => '/v2/', 'title' => ''], + 'BillingStatus' => ['description' => 'The billing status of the API group. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The instance is normal.'."\n" + .'* **LOCKED**: The API group is locked due to overdue payments.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'TrafficLimit' => ['description' => 'The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'apigateway-cn-v6419k43245xx', 'title' => ''], + 'InstanceType' => ['description' => 'The type of the instance.'."\n", 'type' => 'string', 'example' => 'VPC_SHARED', 'title' => ''], + 'RegionId' => ['description' => 'The region to which the API group belongs.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the API group.'."\n", 'type' => 'string', 'example' => '2016-08-01T08:45:15Z', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", 'type' => 'string', 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.'."\n", 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'Description' => ['description' => 'Group Description'."\n", 'type' => 'string', 'example' => 'TrafficInformations.', 'title' => ''], + 'IllegalStatus' => ['description' => 'The validity status of the API group. Valid values:'."\n" + ."\n" + .'* **NORMAL**: The instance is normal.'."\n" + .'* **LOCKED**: The API group is locked because it is not valid.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'HttpsPolicy' => ['description' => 'The HTTPS security policy'."\n", 'type' => 'string', 'example' => 'HTTPS2_TLS1_0', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain name that corresponds to the API group and is used by the CNAME of the custom domain name.'."\n", 'type' => 'string', 'example' => 'be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time (UTC) of the API group.'."\n", 'type' => 'string', 'example' => '2016-08-01T08:45:15Z', 'title' => ''], + 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Tag' => [ - 'description' => 'The tags that are added to the APIs.'."\n", + 'TagInfo' => [ + 'description' => 'The list of tags.'."\n", + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tagKey', - ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'tagValue', - ], + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], ], ], 'description' => '', + 'title' => '', ], ], ], ], ], 'description' => '', + 'title' => '', ], ], ], - '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\\": \\"创建对象接口\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"CreatedTime\\": \\"2016-05-20T18:18:25Z\\",\\n \\"ApiName\\": \\"创建对象\\",\\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":"<DescribeApisResponse>\\r\\n <ApiSummarys>\\r\\n <ApiSummary>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>\\r\\n <GroupName>myGroup3</GroupName>\\r\\n <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>\\r\\n <ApiName>获取对象列表</ApiName> \\r\\n <Visibility>public</Visibility>\\r\\n <Description>分页显示对象列表</Description>\\r\\n <CreatedTime>2016-06-20T18:18:25Z</CreatedTime>\\r\\n <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>\\r\\n </ApiSummary>\\r\\n <ApiSummary>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>1084f9034c744137901057206b39d2b6</GroupId>\\r\\n <GroupName>myGroup2</GroupName>\\r\\n <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>\\r\\n <ApiName>创建对象</ApiName> \\r\\n <Visibility>public</Visibility>\\r\\n <Description>创建对象接口</Description>\\r\\n <CreatedTime>2016-05-20T18:18:25Z</CreatedTime>\\r\\n <ModifiedTime>2016-07-23T08:28:48Z</ModifiedTime>\\r\\n </ApiSummary>\\r\\n </ApiSummarys>\\r\\n <PageNumber>3</PageNumber>\\r\\n <PageSize>15</PageSize>\\r\\n <TotalCount>32</TotalCount>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ002</RequestId> \\r\\n</DescribeApisResponse>","errorExample":""}]', - 'title' => 'DescribeApis', - 'description' => '* This operation is intended for API callers.'."\n" - .'* This operation returns a list of all APIs that are being defined. The basic information about these APIs is also returned in the list.'."\n" - .'* This operation returns all APIs that are being edited, regardless of their environments. The returned definitions may be different from the definitions in the environments.'."\n", + '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":"<DescribeApiGroupsResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n <TotalCount>2</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiGroupAttributes>\\r\\n <ApiGroupAttribute>\\r\\n <GroupId>be6d2abcc0dd4f749fc2d2edd6567164</GroupId>\\r\\n <GroupName>Traffic</GroupName>\\r\\n <SubDomain>be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>TrafficInformations.</Description>\\r\\n <CreatedTime>2016-08-01T08:45:15Z</CreatedTime>\\r\\n <ModifiedTime>2016-08-01T08:45:15Z</ModifiedTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <TrafficLimit>500</TrafficLimit>\\r\\n <BillingStatus>NORMAL</BillingStatus>\\r\\n <IllegalStatus>NORMAL</IllegalStatus>\\r\\n </ApiGroupAttribute>\\r\\n <ApiGroupAttribute>\\r\\n <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>\\r\\n <GroupName>NewWeather</GroupName>\\r\\n <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>\\r\\n <Description>NewWeatherInformations.</Description>\\r\\n <CreatedTime>2016-08-01T06:54:32Z</CreatedTime>\\r\\n <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <TrafficLimit>500</TrafficLimit>\\r\\n <BillingStatus>NORMAL</BillingStatus>\\r\\n <IllegalStatus>NORMAL</IllegalStatus>\\r\\n </ApiGroupAttribute>\\r\\n </ApiGroupAttributes>\\r\\n</DescribeApiGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeApiGroups', + 'summary' => 'Queries existing API groups and their basic information.', + 'description' => '* This operation is intended for API providers.'."\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/*'], + ], + ], + ], + ], ], - 'DescribeApiHistory' => [ - 'summary' => 'Queries the details of a specified historical version of a specified API definition.', - 'methods' => [ - 'post', - 'get', + 'DescribeApiHistories' => [ + 'summary' => 'Queries the historical versions of a specified 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' => 'The ID of the API group.'."\n", 'type' => 'string', 'required' => true, 'example' => '1084f9034c744137901057206b39d2b6', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", 'type' => 'string', 'required' => false, 'example' => 'RELEASE ', 'title' => ''], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c076144d7878437b8f82fb85890ce6a0', 'title' => ''], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the API. The name is used for fuzzy match.'."\n", 'type' => 'string', 'required' => false, 'example' => 'weather', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", 'type' => 'integer', 'required' => false, 'example' => '10', 'format' => 'int32', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'required' => false, 'example' => '1', 'format' => 'int32', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ003', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'ApiHisItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiHisItem' => [ + 'description' => 'The returned API information. It is an array consisting of ApiHisItem data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether an API version is effective. Valid values: **ONLINE** and **OFFLINE**.'."\n", 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.'."\n", 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc', 'title' => ''], + 'Description' => ['description' => 'The description of the API.'."\n", 'type' => 'string', 'example' => 'Create object API', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.'."\n", 'type' => 'string', 'example' => 'myGroup2', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.'."\n", 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6', 'title' => ''], + 'DeployedTime' => ['description' => 'The publishing time (UTC) of the API.'."\n", 'type' => 'string', 'example' => '2016-07-20T08:28:48Z', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'HistoryVersion' => ['description' => 'The historical version of the API.'."\n", 'type' => 'string', 'example' => '20160705104552393', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.'."\n", 'type' => 'string', 'example' => 'Create object', 'title' => ''], + 'RegionId' => ['description' => 'The region in which the API is located.'."\n", 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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":"","errorExample":""}]', + 'title' => 'DescribeApiHistories', + 'description' => '* This operation is intended for API providers. Only APIs that have been published have historical version records.'."\n" + .'* This operation allows you to obtain the historical versions of an API. This operation is always called by other operations.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistories'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries a specified historical version of a specified API definition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10389,58 +6743,34 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94316', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '3013a55c0c44483f984d26df27120513', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '3013a55c0c44483f984d26df27120513', 'title' => ''], ], [ 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dc6e17ee3120404c839bbcd7622ab6ed', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc6e17ee3120404c839bbcd7622ab6ed', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**: the test environment'."\n" - .'* **PRE**: the pre-release environment', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**: the test environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ 'name' => 'HistoryVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the version number that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20211122155403834', - ], + 'schema' => ['description' => 'Specifies the version number that you want to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20211122155403834', 'title' => ''], ], ], 'responses' => [ @@ -10448,518 +6778,257 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The invocation status of the API.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => 'bebf996e4b3d445d83078094b72b0d91', - ], - 'ResultType' => [ - 'description' => 'The type of the data to return.'."\n", - 'type' => 'string', - 'example' => 'JSON', - ], - 'WebSocketApiType' => [ - 'description' => 'The type of the two-way communication API. Valid values:'."\n" - ."\n" - .'* **COMMON**: general APIs'."\n" - .'* **REGISTER**: registered APIs'."\n" - .'* **UNREGISTER**: unregistered APIs'."\n" - .'* **NOTIFY**: downstream notification', - 'type' => 'string', - 'example' => 'COMMON', - ], - 'DisableInternet' => [ - 'description' => '* Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" - .'* If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResultBodyModel' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'ResultSample' => [ - 'description' => 'The sample response.'."\n", - 'type' => 'string', - 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}', - ], - 'AppCodeAuthType' => [ - 'description' => 'The AppCode authentication type supported. Valid values:'."\n" - ."\n" - .'* DEFAULT: supported after being made available in Alibaba Cloud Marketplace'."\n" - .'* DISABLE: not supported.'."\n" - .'* HEADER : supported only in the Header parameter'."\n" - .'* HEADER_QUERY : supported in the Header or Query parameter.'."\n", - 'type' => 'string', - 'example' => 'HEADER', - ], - 'AllowSignatureMethod' => [ - 'description' => 'If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - 'type' => 'string', - 'example' => 'HmacSHA256', - ], - 'RegionId' => [ - 'description' => 'The region where the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ForceNonceCheck' => [ - 'description' => '* Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Visibility' => [ - 'description' => 'Specifies whether to make the API public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'FailResultSample' => [ - 'description' => 'The sample error response from the backend service.'."\n", - 'type' => 'string', - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', - ], - 'AuthType' => [ - 'description' => 'The security authentication method of the API. Valid values:'."\n" - ."\n" - .'* **APP: Only authorized applications can call the API.**'."\n" - ."\n" - .'* **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" - ."\n" - .' * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.'."\n", - 'type' => 'string', - 'example' => 'APP', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Queries weather based on the region name'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'dev_api', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'cfb6ef799bf54fffabb0f02019ad2581', - ], - 'DeployedTime' => [ - 'description' => 'The publishing time (UTC) of the API.'."\n", - 'type' => 'string', - 'example' => '2021-06-1113:57:38', - ], - 'StageName' => [ - 'description' => 'The environment in which the API is requested. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment', - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'HistoryVersion' => [ - 'description' => 'The historical version number.'."\n", - 'type' => 'string', - 'example' => '20211022134156663', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'Backstage_MengMeng Broadcast_Seven Niu Cloud Push Stream Callback_Official'."\n", - ], - 'BackendEnable' => [ - 'description' => 'Specifies whether to enable backend services.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Status' => ['description' => 'The invocation status of the API.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => 'bebf996e4b3d445d83078094b72b0d91', 'title' => ''], + 'ResultType' => ['description' => 'The type of the data to return.', 'type' => 'string', 'example' => 'JSON', 'title' => ''], + 'WebSocketApiType' => ['description' => 'The type of the two-way communication API. Valid values:'."\n" + ."\n" + .'- **COMMON**: general APIs'."\n" + ."\n" + .'- **REGISTER**: registered APIs'."\n" + ."\n" + .'- **UNREGISTER**: unregistered APIs'."\n" + ."\n" + .'- **NOTIFY**: downstream notification', 'type' => 'string', 'example' => 'COMMON', 'title' => ''], + 'DisableInternet' => ['description' => '- Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" + ."\n" + .'- If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResultBodyModel' => ['description' => 'The return description of the API.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ResultSample' => ['description' => 'The sample response.', 'type' => 'string', 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}', 'title' => ''], + 'AppCodeAuthType' => ['description' => 'The AppCode authentication type supported. Valid values:'."\n" + ."\n" + .'- DEFAULT: supported after being made available in Alibaba Cloud Marketplace'."\n" + ."\n" + .'- DISABLE: not supported.'."\n" + ."\n" + .'- HEADER : supported only in the Header parameter'."\n" + ."\n" + .'- HEADER\\_QUERY : supported in the Header or Query parameter.', 'type' => 'string', 'example' => 'HEADER', 'title' => ''], + 'AllowSignatureMethod' => ['description' => 'If **AuthType** is set to **APP**, this value must be passed to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256', 'title' => ''], + 'RegionId' => ['description' => 'The region where the API is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ForceNonceCheck' => ['description' => '- Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Visibility' => ['description' => 'Specifies whether to make the API public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" + ."\n" + .'- **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'FailResultSample' => ['description' => 'The sample error response from the backend service.', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', 'title' => ''], + 'AuthType' => ['description' => 'The security authentication method of the API. Valid values:'."\n" + ."\n" + .'- **APP: Only authorized applications can call the API.**'."\n" + ."\n" + .'- **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" + ."\n" + .' - All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Query weather by region name', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'dev_api', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'cfb6ef799bf54fffabb0f02019ad2581', 'title' => ''], + 'DeployedTime' => ['description' => 'The publishing time (UTC) of the API.', 'type' => 'string', 'example' => '2021-06-1113:57:38', 'title' => ''], + 'StageName' => ['description' => 'The environment in which the API is requested. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'HistoryVersion' => ['description' => 'The historical version number.', 'type' => 'string', 'example' => '20211022134156663', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'Test API', 'title' => ''], + 'BackendEnable' => ['description' => 'Specifies whether to enable backend services.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'BackendConfig' => [ - 'description' => 'Backend configurations'."\n", + 'description' => 'Backend configurations', 'type' => 'object', 'properties' => [ - 'BackendId' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'example' => 'a0305308908c4740aba9cbfd63ba99b7', - ], - 'BackendType' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'BackendName' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'example' => 'zmapi', - ], + 'BackendId' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'example' => 'a0305308908c4740aba9cbfd63ba99b7', 'title' => ''], + 'BackendType' => ['description' => 'The type of the backend service.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'BackendName' => ['description' => 'The name of the backend service.', 'type' => 'string', 'example' => 'zmapi', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'RequestConfig' => [ 'description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n" ."\n" - .'For more information, see [RequestConfig](~~43985~~).'."\n", + .'For more information, see [RequestConfig](~~43985~~).', 'type' => 'object', 'properties' => [ - 'BodyModel' => [ - 'description' => 'The body model.'."\n", - 'type' => 'string', - 'example' => 'https://apigateway.aliyun.com/models/3a240a1XXXXXXXXd9ab1bf7e947b4095/9e2df550e85b4XXXXXXXX619eaab', - ], - 'RequestPath' => [ - 'description' => 'API path'."\n", - 'type' => 'string', - 'example' => '/api/billing/test/[type]', - ], - 'RequestHttpMethod' => [ - 'description' => 'The HTTP method. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'BodyFormat' => [ - 'description' => 'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams. This parameter takes effect only when the RequestMode parameter is set to MAPPING.'."\n", - 'type' => 'string', - 'example' => 'STREAM', - ], - 'RequestMode' => [ - 'description' => 'The request mode. Valid values:'."\n" - ."\n" - .'* MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" - .'* PASSTHROUGH: Parameters are passed through.'."\n" - .'* MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.'."\n", - 'type' => 'string', - 'example' => 'MAPPING', - ], - 'PostBodyDescription' => [ - 'description' => 'The description of the request body.'."\n", - 'type' => 'string', - 'example' => 'fwefwef', - ], - 'RequestProtocol' => [ - 'description' => 'The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS".'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'EscapePathParam' => [ - 'type' => 'boolean', - 'description' => 'Whether to escape the Path parameter, if true, the [param] on the Path will be treated as a regular character.', - 'example' => 'true', - ], + 'BodyModel' => ['description' => 'The body model.', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/340a127dcc4afd9ab1bf7e947b4095/9e2df550e85b412179ec33e2619eaab', 'title' => ''], + 'RequestPath' => ['description' => 'API path', 'type' => 'string', 'example' => '/api/billing/test/[type]', 'title' => ''], + 'RequestHttpMethod' => ['description' => 'The HTTP method. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'BodyFormat' => ['description' => 'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams. This parameter takes effect only when the RequestMode parameter is set to MAPPING.', 'type' => 'string', 'example' => 'STREAM', 'title' => ''], + 'RequestMode' => ['description' => 'The request mode. Valid values:'."\n" + ."\n" + .'- MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" + ."\n" + .'- PASSTHROUGH: Parameters are passed through.'."\n" + ."\n" + .'- MAPPING\\_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.', 'type' => 'string', 'example' => 'MAPPING', 'title' => ''], + 'PostBodyDescription' => ['description' => 'The description of the request body.', 'type' => 'string', 'example' => 'fwefwef', 'title' => ''], + 'RequestProtocol' => ['description' => 'The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS".', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'EscapePathParam' => ['description' => 'Whether to escape the Path parameter, if true, the \\[param] on the Path will be treated as a regular character.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ServiceConfig' => [ - 'description' => 'The information about a backend service call.'."\n", + 'description' => 'The information about a backend service call.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6kg9x8sx2tbxxxx', - ], - 'MockStatusCode' => [ - 'description' => 'The status code returned for service mocking.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ContentTypeValue' => [ - 'description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'application/json', - ], - 'ServiceProtocol' => [ - 'description' => 'The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ServicePath' => [ - 'description' => 'The path used when you call the backend service.'."\n", - 'type' => 'string', - 'example' => '/object/add', - ], - 'ContentTypeCatagory' => [ - 'description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" - ."\n" - .'* DEFAULT: the default header type in API Gateway'."\n" - .'* CUSTOM: a custom header type'."\n" - .'* CLIENT: the ContentType header type of the client'."\n", - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'ServiceAddress' => [ - 'description' => 'The URL used to call the backend service.'."\n", - 'type' => 'string', - 'example' => 'http://api.a.com:8080', - ], - 'Mock' => [ - 'description' => 'Specifies whether to enable the MOCK mode. Valid values:'."\n" - ."\n" - .'* TRUE: The Mock mode is enabled.'."\n" - .'* FALSE: The Mock mode is not enabled.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'ServiceVpcEnable' => [ - 'description' => 'Specifies whether to enable the VPC channel. Valid values:'."\n" - ."\n" - .'* TRUE: The VPC channel is enabled.'."\n" - .'* FALSE: The VPC channel is not enabled.'."\n" - ."\n" - .'You must create the corresponding VPC access authorization before you can enable a VPC channel.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'MockResult' => [ - 'description' => 'The result returned when the Mock mode is enabled.'."\n", - 'type' => 'string', - 'example' => 'test result', - ], - 'ServiceHttpMethod' => [ - 'description' => 'The HTTP request method used when calling the backend service. Valid values: PUT, GET, POST, DELETE, PATCH, HEAD, OPTIONS, and ANY.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'ServiceTimeout' => [ - 'description' => 'The timeout period of the backend service, in millisecond.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-uf6kg9x8sx2tbxxxx', 'title' => ''], + 'MockStatusCode' => ['description' => 'The status code returned for service mocking.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ContentTypeValue' => ['description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.', 'type' => 'string', 'example' => 'application/json', 'title' => ''], + 'ServiceProtocol' => ['description' => 'The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ServicePath' => ['description' => 'The path used when you call the backend service.', 'type' => 'string', 'example' => '/object/add', 'title' => ''], + 'ContentTypeCatagory' => ['description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" + ."\n" + .'- DEFAULT: the default header type in API Gateway'."\n" + ."\n" + .'- CUSTOM: a custom header type'."\n" + ."\n" + .'- CLIENT: the ContentType header type of the client', 'type' => 'string', 'example' => 'CUSTOM', 'title' => ''], + 'ServiceAddress' => ['description' => 'The URL used to call the backend service.', 'type' => 'string', 'example' => 'http://api.a.com:8080', 'title' => ''], + 'Mock' => ['description' => 'Specifies whether to enable the MOCK mode. Valid values:'."\n" + ."\n" + .'- TRUE: The Mock mode is enabled.'."\n" + ."\n" + .'- FALSE: The Mock mode is not enabled.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'ServiceVpcEnable' => ['description' => 'Specifies whether to enable the VPC channel. Valid values:'."\n" + ."\n" + .'- TRUE: The VPC channel is enabled.'."\n" + ."\n" + .'- FALSE: The VPC channel is not enabled.'."\n" + ."\n" + .'You must create the corresponding VPC access authorization before you can enable a VPC channel.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'MockResult' => ['description' => 'The result returned when the Mock mode is enabled.', 'type' => 'string', 'example' => 'test result', 'title' => ''], + 'ServiceHttpMethod' => ['description' => 'The HTTP request method used when calling the backend service. Valid values: PUT, GET, POST, DELETE, PATCH, HEAD, OPTIONS, and ANY.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ServiceTimeout' => ['description' => 'The timeout period of the backend service, in millisecond.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'MockHeaders' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'MockHeader' => [ - 'description' => 'The simulated Headers.'."\n", + 'description' => 'The simulated Headers.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'HeaderValue' => [ - 'description' => 'The values of the HTTP headers.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'HeaderName' => [ - 'description' => 'The HTTP headers.'."\n", - 'type' => 'string', - 'example' => 'Content-Type', - ], + 'HeaderValue' => ['description' => 'The values of the HTTP headers.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'HeaderName' => ['description' => 'The HTTP headers.', 'type' => 'string', 'example' => 'Content-Type', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'VpcConfig' => [ - 'description' => 'Configuration items related to VPC channels'."\n", + 'description' => 'Configuration items related to VPC channels', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zeafsc3fygk1***', - ], - 'VpcScheme' => [ - 'description' => 'The VPC protocol.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'InstanceId' => [ - 'description' => 'The IDs of the ELB and SLB instances in the VPC.'."\n", - 'type' => 'string', - 'example' => 'i-bp1h497hkijewv2***', - ], - 'Port' => [ - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'Name' => [ - 'description' => 'The name of the VPC.'."\n", - 'type' => 'string', - 'example' => 'glmall-app-test', - ], + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***', 'title' => ''], + 'VpcScheme' => ['description' => 'The VPC protocol.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'InstanceId' => ['description' => 'The IDs of the ELB and SLB instances in the VPC.', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***', 'title' => ''], + 'Port' => ['description' => 'The port number that corresponds to the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'Name' => ['description' => 'The name of the VPC.', 'type' => 'string', 'example' => 'glmall-app-test', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'FunctionComputeConfig' => [ - 'description' => 'Backend configuration items when the backend service is Function Compute'."\n", + 'description' => 'Backend configuration items when the backend service is Function Compute', 'type' => 'object', 'properties' => [ - 'FcType' => [ - 'description' => 'The type of the Function Compute instance.'."\n", - 'type' => 'string', - 'example' => 'HttpTrigger', - ], - 'RoleArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', - ], - 'Method' => [ - 'description' => 'The request method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'FcBaseUrl' => [ - 'description' => 'The root path of Function Compute.'."\n", - 'type' => 'string', - 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/', - ], - 'ContentTypeValue' => [ - 'description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'application/json', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'OnlyBusinessPath' => [ - 'description' => 'The backend only receives the service path.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'FunctionName' => [ - 'description' => 'The function name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'domain_business_control', - ], - 'ContentTypeCatagory' => [ - 'description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" - ."\n" - .'* **DEFAULT: the default header type in API Gateway.**'."\n" - .'* **CUSTOM: a custom header type.**'."\n" - .'* **CLIENT: the ContentType header type of the client.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'Path' => [ - 'description' => 'The API request path.'."\n", - 'type' => 'string', - 'example' => '/api/offline/cacheData', - ], - 'ServiceName' => [ - 'description' => 'The service name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'fcservicename', - ], - 'Qualifier' => [ - 'description' => 'The alias of the function.'."\n", - 'type' => 'string', - 'example' => '2', - ], + 'FcType' => ['description' => 'The type of the Function Compute instance.', 'type' => 'string', 'example' => 'HttpTrigger', 'title' => ''], + 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', 'title' => ''], + 'Method' => ['description' => 'The request method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'FcBaseUrl' => ['description' => 'The root path of Function Compute.', 'type' => 'string', 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/', 'title' => ''], + 'ContentTypeValue' => ['description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.', 'type' => 'string', 'example' => 'application/json', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'OnlyBusinessPath' => ['description' => 'The backend only receives the service path.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'FunctionName' => ['description' => 'The function name defined in Function Compute.', 'type' => 'string', 'example' => 'domain_business_control', 'title' => ''], + 'ContentTypeCatagory' => ['description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" + ."\n" + .'- **DEFAULT: the default header type in API Gateway.**'."\n" + ."\n" + .'- **CUSTOM: a custom header type.**'."\n" + ."\n" + .'- \\*\\*CLIENT: the ContentType header type of the client.', 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'Path' => ['description' => 'The API request path.', 'type' => 'string', 'example' => '/api/offline/cacheData', 'title' => ''], + 'ServiceName' => ['description' => 'The service name defined in Function Compute.', 'type' => 'string', 'example' => 'fcservicename', 'title' => ''], + 'Qualifier' => ['description' => 'The alias of the function.', 'type' => 'string', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'OssConfig' => [ - 'description' => 'Information when the backend service is OSS'."\n", + 'description' => 'Information when the backend service is OSS', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'description' => 'The stored object or folder path.'."\n", - 'example' => 'ENV', - ], - 'Action' => [ - 'type' => 'string', - 'description' => 'The operation options on OSS. Valid values:'."\n" - ."\n" - .'* GetObject'."\n" - .'* PostObject'."\n" - .'* DeleteObject'."\n" - .'* PutObject'."\n" - .'* HeadObject'."\n" - .'* GetObjectMeta'."\n" - .'* AppendObject'."\n", - 'example' => 'GetObject', - ], - 'OssRegionId' => [ - 'description' => 'The ID of the region where the OSS instance is located.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'BucketName' => [ - 'description' => 'The OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'phototest02', - ], + 'Key' => ['description' => 'The stored object or folder path.', 'type' => 'string', 'example' => '/folder/test.json', 'title' => ''], + 'Action' => ['description' => 'The operation options on OSS. Valid values:'."\n" + ."\n" + .'- GetObject'."\n" + ."\n" + .'- PostObject'."\n" + ."\n" + .'- DeleteObject'."\n" + ."\n" + .'- PutObject'."\n" + ."\n" + .'- HeadObject'."\n" + ."\n" + .'- GetObjectMeta'."\n" + ."\n" + .'- AppendObject', 'type' => 'string', 'example' => 'GetObject', 'title' => ''], + 'OssRegionId' => ['description' => 'The ID of the region where the OSS instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'BucketName' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'phototest02', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'EventBridgeConfig' => [ - 'description' => 'Configuration items of EventBridge'."\n", + 'description' => 'Configuration items of EventBridge', 'type' => 'object', 'properties' => [ - 'EventBridgeRegionId' => [ - 'description' => 'The ID of the region where the EventBridge instance is located.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EventBus' => [ - 'description' => 'The event bus.'."\n", - 'type' => 'string', - 'example' => 'testBus', - ], - 'EventSource' => [ - 'description' => 'The event source of the managed rule.'."\n", - 'type' => 'string', - 'example' => 'baas_driver', - ], - 'RoleArn' => [ - 'description' => 'The Arn that is authorized by a RAM user to EventBridge.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun', - ], + 'EventBridgeRegionId' => ['description' => 'The ID of the region where the EventBridge instance is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'EventBus' => ['description' => 'The event bus.', 'type' => 'string', 'example' => 'testBus', 'title' => ''], + 'EventSource' => ['description' => 'The event source of the managed rule.', 'type' => 'string', 'example' => 'baas_driver', 'title' => ''], + 'RoleArn' => ['description' => 'The Arn that is authorized by a RAM user to EventBridge.', 'type' => 'string', 'example' => 'acs:ram::1933122015759***:role/adminoidcaliyun', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'OpenIdConnectConfig' => [ - 'description' => 'The configuration items of the third-party OpenID Connect authentication method.'."\n", + 'description' => 'The configuration items of the third-party OpenID Connect authentication method.', 'type' => 'object', 'properties' => [ - 'OpenIdApiType' => [ - 'description' => 'The configuration of OpenID Connect authentication. Valid values:'."\n" - ."\n" - .'* **IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.**'."\n" - .'* **BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.'."\n", - 'type' => 'string', - 'example' => 'IDTOKEN', - ], - 'IdTokenParamName' => [ - 'description' => 'The name of the parameter that corresponds to the token.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'PublicKeyId' => [ - 'description' => 'The ID of the public key.'."\n", - 'type' => 'string', - 'example' => '88483727556929326703309904351185815489', - ], - 'PublicKey' => [ - 'description' => 'The public key of the API.'."\n", - 'type' => 'string', - 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', - ], + 'OpenIdApiType' => ['description' => 'The configuration of OpenID Connect authentication. Valid values:'."\n" + ."\n" + .'- **IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.**'."\n" + ."\n" + .'- \\*\\*BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.', 'type' => 'string', 'example' => 'IDTOKEN', 'title' => ''], + 'IdTokenParamName' => ['description' => 'The name of the parameter that corresponds to the token.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PublicKeyId' => ['description' => 'The ID of the public key.', 'type' => 'string', 'example' => '88483727556929326703309904351185815489', 'title' => ''], + 'PublicKey' => ['description' => 'The public key of the API.', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ErrorCodeSamples' => [ 'type' => 'object', @@ -10968,205 +7037,140 @@ 'ErrorCodeSample' => [ 'description' => 'The sample error codes returned by the backend service.'."\n" ."\n" - .'For more information, see [ErrorCodeSample](~~44392~~).'."\n", + .'For more information, see [ErrorCodeSample](~~44392~~).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The returned error code.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'Message' => [ - 'description' => 'The returned error message.'."\n", - 'type' => 'string', - 'example' => 'MissingParameter', - ], - 'Description' => [ - 'description' => 'The error description.'."\n", - 'type' => 'string', - 'example' => 'Missing the parameter UserId', - ], + 'Code' => ['description' => 'The returned error code.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => 'MissingParameter', 'title' => ''], + 'Description' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'Missing the parameter UserId', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ResultDescriptions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultDescription' => [ - 'description' => 'The return description of the API.'."\n", + 'description' => 'The return description of the API.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The result type.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'Key' => [ - 'description' => 'The primary key of the result.'."\n", - 'type' => 'string', - 'example' => 'groupName', - ], - 'HasChild' => [ - 'description' => 'Indicates whether a subnode exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Description' => [ - 'description' => 'The subnode description.'."\n", - 'type' => 'string', - 'example' => 'for_test1', - ], - 'Pid' => [ - 'description' => 'The ID of the parent node.'."\n", - 'type' => 'string', - 'example' => 'pid', - ], - 'Mandatory' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => 'The result name.'."\n", - 'type' => 'string', - 'example' => 'fwqf', - ], - 'Id' => [ - 'description' => 'The result ID.'."\n", - 'type' => 'string', - 'example' => 'id', - ], + 'Type' => ['description' => 'The result type.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'Key' => ['description' => 'The primary key of the result.', 'type' => 'string', 'example' => 'groupName', 'title' => ''], + 'HasChild' => ['description' => 'Indicates whether a subnode exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The subnode description.', 'type' => 'string', 'example' => 'for_test1', 'title' => ''], + 'Pid' => ['description' => 'The ID of the parent node.', 'type' => 'string', 'example' => 'pid', 'title' => ''], + 'Mandatory' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The result name.', 'type' => 'string', 'example' => 'fwqf', 'title' => ''], + 'Id' => ['description' => 'The result ID.', 'type' => 'string', 'example' => 'id', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'SystemParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SystemParameter' => [ - 'description' => 'The common parameters of the APIs, in JSON format.'."\n", + 'description' => 'The common parameters of the APIs, in JSON format.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DemoValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'system parameters description', - ], - 'ParameterName' => [ - 'description' => 'The system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'DemoValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'system parameters description', 'title' => ''], + 'ParameterName' => ['description' => 'The system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The mapped parameter name in the backend service.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'CustomSystemParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CustomSystemParameter' => [ - 'description' => 'The custom system parameters.'."\n", + 'description' => 'The custom system parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DemoValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'balabala', - ], - 'ParameterName' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'DemoValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'balabala', 'title' => ''], + 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The mapped parameter name in the backend service.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ConstantParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ConstantParameter' => [ - 'description' => 'The constant parameters.'."\n", + 'description' => 'The constant parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'for_test1', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], - 'ConstantValue' => [ - 'description' => 'The value of the constant parameter.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'for_test1', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The mapped parameter name in the backend service.', 'type' => 'string', 'example' => 'constance', 'title' => ''], + 'ConstantValue' => ['description' => 'The value of the constant parameter.', 'type' => 'string', 'example' => 'constance', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'RequestParameters' => [ 'type' => 'object', @@ -11175,106 +7179,40 @@ 'RequestParameter' => [ 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" ."\n" - .'For more information, see [RequestParameter](~~43986~~).'."\n", + .'For more information, see [RequestParameter](~~43986~~).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'JsonScheme' => [ - 'description' => 'JSON scheme'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'MaxValue' => [ - 'description' => 'The maximum parameter value when **ParameterType** is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'ArrayItemsType' => [ - 'description' => 'The type of the array element.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'MinValue' => [ - 'description' => 'The minimum parameter value when **ParameterType** is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocShow' => [ - 'description' => 'Indicates whether the document is public. Valid values: **PUBLIC** and **PRIVATE**.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'MaxLength' => [ - 'description' => 'The maximum parameter length when **ParameterType** is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'ApiParameterName' => [ - 'description' => 'The name of the parameter in the API request.'."\n", - 'type' => 'string', - 'example' => 'age', - ], - 'EnumValue' => [ - 'description' => 'The hash values that are supported when **ParameterType** is set to Int, Long, Float, Double, or String. Separate values with commas (,). Examples: 1,2,3,4,9 and A,B,C,E,F.'."\n", - 'type' => 'string', - 'example' => 'boy,girl', - ], - 'DemoValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required. Valid values: **REQUIRED** and **OPTIONAL**.'."\n", - 'type' => 'string', - 'example' => 'OPTIONAL', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'modidyTest', - ], - 'ParameterType' => [ - 'description' => 'The data type of the parameter. Valid values: String, Int, Long, Float, Double, and Boolean.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'RegularExpression' => [ - 'description' => 'The regular expression that is used for parameter validation when **ParameterType** is set to String.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'MinLength' => [ - 'description' => 'The minimum parameter length when **ParameterType** is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocOrder' => [ - 'description' => 'The order in which the parameter is sorted in the document.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], + 'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'MaxValue' => ['description' => 'The maximum parameter value when **ParameterType** is set to Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'ArrayItemsType' => ['description' => 'The type of the array element.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'MinValue' => ['description' => 'The minimum parameter value when **ParameterType** is set to Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocShow' => ['description' => 'Indicates whether the document is public. Valid values: **PUBLIC** and **PRIVATE**.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'MaxLength' => ['description' => 'The maximum parameter length when **ParameterType** is set to String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'ApiParameterName' => ['description' => 'The name of the parameter in the API request.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'EnumValue' => ['description' => 'The hash values that are supported when **ParameterType** is set to Int, Long, Float, Double, or String. Separate values with commas (,). Examples: 1,2,3,4,9 and A,B,C,E,F.', 'type' => 'string', 'example' => 'boy,girl', 'title' => ''], + 'DemoValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required. Valid values: **REQUIRED** and **OPTIONAL**.', 'type' => 'string', 'example' => 'OPTIONAL', 'title' => ''], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'modidyTest', 'title' => ''], + 'ParameterType' => ['description' => 'The data type of the parameter. Valid values: String, Int, Long, Float, Double, and Boolean.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'RegularExpression' => ['description' => 'The regular expression that is used for parameter validation when **ParameterType** is set to String.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'MinLength' => ['description' => 'The minimum parameter length when **ParameterType** is set to String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocOrder' => ['description' => 'The order in which the parameter is sorted in the document.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ServiceParameters' => [ 'type' => 'object', @@ -11283,31 +7221,26 @@ 'ServiceParameter' => [ 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" ."\n" - .'For more information, see [ServiceParameter](~~43988~~).'."\n", + .'For more information, see [ServiceParameter](~~43988~~).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ParameterType' => [ - 'description' => 'The data type of the parameter. Valid values: STRING, NUMBER, and BOOLEAN.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ParameterType' => ['description' => 'The data type of the parameter. Valid values: STRING, NUMBER, and BOOLEAN.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The mapped parameter name in the backend service.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'ServiceParametersMap' => [ 'type' => 'object', @@ -11316,154 +7249,104 @@ 'ServiceParameterMap' => [ 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" ."\n" - .'For more information, see [ServiceParameterMap](~~43989~~).'."\n", + .'For more information, see [ServiceParameterMap](~~43989~~).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RequestParameterName' => [ - 'description' => 'The corresponding frontend parameter name. The value must be contained in RequestParametersObject and match RequestParam.ApiParameterName.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], - 'ServiceParameterName' => [ - 'description' => 'The mapped parameter name in the backend service.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], + 'RequestParameterName' => ['description' => 'The corresponding frontend parameter name. The value must be contained in RequestParametersObject and match RequestParam.ApiParameterName.', 'type' => 'string', 'example' => 'sex', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The mapped parameter name in the backend service.', 'type' => 'string', 'example' => 'sex', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"根据地区名称查询天气情况\\",\\n \\"GroupName\\": \\"dev_api\\",\\n \\"GroupId\\": \\"cfb6ef799bf54fffabb0f02019ad2581\\",\\n \\"DeployedTime\\": \\"2021-06-1113:57:38\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"HistoryVersion\\": \\"20211022134156663\\",\\n \\"ApiName\\": \\"测试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"}]', + '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' => 'DescribeApiHistory', - 'description' => 'Queries the details of a specified historical version of a specified API definition.'."\n" + 'description' => 'Queries a specified historical version of a specified API definition.'."\n" ."\n" - .'* This API is intended for API providers.'."\n" - .'* API Gateway records the time and definition of an API every time the API is published. You can use the version number obtained from other operations to query definition details at a certain publication.'."\n", - ], - 'DescribeApisByApp' => [ - 'summary' => 'Queries the APIs with which an application is associated.', - 'methods' => [ - 'post', - 'get', + .'- This API is intended for API providers.'."\n" + ."\n" + .'- API Gateway records the time and definition of an API every time the API is published. You can use the version number obtained from other operations to query definition details at a certain publication.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiHistory'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiHistory', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApiIpControls' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94323', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeCode' => '94317', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => 'APP的ID', - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '333486644', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页码', - 'description' => 'The number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页条目', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'ApiUid', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'title' => 'API的ID', - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b19240592b1b4e74961fb8438ed7550c', - ], + 'schema' => ['description' => 'The runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => 'API名称', - 'description' => 'The name of the API. The name is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'getPersonInfo', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'title' => 'API请求路径', - 'description' => 'The request path of the API.', - 'type' => 'string', - 'required' => false, - 'example' => '/tt', - ], + 'schema' => ['description' => 'The IDs of APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '123,234', 'title' => ''], ], [ - 'name' => 'Method', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => 'API的请求HTTP Method', - 'description' => 'The request HTTP method of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -11471,152 +7354,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => 'The number of pages to return the results on.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'PageSize' => [ - 'title' => '每页条目', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '总条目数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AppApiRelationInfos' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ApiIpControls' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AppApiRelationInfo' => [ - 'description' => 'The API authorizations.'."\n", + 'ApiIpControlItem' => [ + 'description' => 'The information about the ACLs. The information is an array of ApiIpControlItem data.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'title' => 'API的ID', - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => 'c625795a1e664782a918eaa629e96ab5', - ], - 'AuthorizationSource' => [ - 'title' => '授权来源', - 'description' => 'The authorization source.'."\n", - 'type' => 'string', - 'example' => 'SELF', - ], - 'AuthVaildTime' => [ - 'title' => '授权有效时间', - 'description' => 'The validity period of the authorization.'."\n", - 'type' => 'string', - 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The authorization description.'."\n", - 'type' => 'string', - 'example' => 'b1008kz', - ], - 'GroupName' => [ - 'title' => '分组名称', - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'wb2022012101605749', - ], - 'GroupId' => [ - 'title' => '分组ID', - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '38bed48d664149e4b9b5ea576319673f', - ], - 'Operator' => [ - 'description' => 'The authorizer. Valid values:'."\n" - ."\n" - .'* **PROVIDER**: API owner'."\n" - .'* **CONSUMER**: API caller'."\n", - 'type' => 'string', - 'example' => 'PROVIDER', - ], - 'StageName' => [ - 'title' => '环境名称', - 'description' => 'The environment name.'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'StageAlias' => [ - 'description' => 'The environment alias.'."\n", - 'type' => 'string', - 'example' => 'Online', - ], - 'CreatedTime' => [ - 'title' => '授权时间', - 'description' => 'The time when the authorization was created.'."\n", - 'type' => 'string', - 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT', - ], - 'ApiName' => [ - 'title' => 'API名称', - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'sd2_h5_player_history_competition', - ], - 'RegionId' => [ - 'title' => '地区ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Path' => [ - 'title' => 'API的请求路径', - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/api/offline/cacheData', - ], - 'Method' => [ - 'title' => 'API的请求HTTP Method', - 'description' => 'The HTTP method of the API.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], + 'BoundTime' => ['description' => 'The time of binding.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90', 'title' => ''], + 'IpControlId' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'IpControlName' => ['description' => 'The name of the ACL.', 'type' => 'string', 'example' => 'testControlName', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'testapi', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"线上\\",\\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' => 'DescribeApisByApp', - ], - 'DescribeAuthorizedApis' => [ - 'summary' => 'Queries the authorized APIs of a specified APP.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiIpControls', + 'summary' => 'Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment.', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- If an optional parameter is not specified, all results are returned on separate pages.'."\n" + ."\n" + .'·', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiIpControls'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApiLatencyData' => [ + 'summary' => 'Queries the response time statistics of an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11625,45 +7437,40 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94342', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeCode' => '94318', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -11671,132 +7478,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AuthorizedApis' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', 'title' => ''], + 'CallLatencys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AuthorizedApi' => [ - 'description' => 'The authorized API set.'."\n", + 'MonitorItem' => [ + 'description' => 'The returned information about API call latency. It is an array consisting of MonitorItem data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The unique identifier of the API, which is automatically generated by the system.'."\n", - 'type' => 'string', - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', - ], - 'AuthorizationSource' => [ - 'description' => 'The authorization source. Valid values:'."\n" - ."\n" - .'* **CONSOLE**'."\n" - .'* **API**'."\n", - 'type' => 'string', - 'example' => 'CONSOLE', - ], - 'AuthVaildTime' => [ - 'description' => 'The expiration time of the authorization in UTC.'."\n", - 'type' => 'string', - 'example' => '2018-10-05T16:00:00Z', - ], - 'Description' => [ - 'description' => 'Authorization description'."\n", - 'type' => 'string', - 'example' => 'Queries weather based on the region name'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'Weather', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - 'AuthorizedTime' => [ - 'description' => 'The authorization time in UTC.'."\n", - 'type' => 'string', - 'example' => '2016-07-21T06:17:20', - ], - 'Operator' => [ - 'description' => 'The authorizer. Valid values:'."\n" - ."\n" - .'* **PROVIDER:** API owner'."\n" - .'* **CONSUMER:** API caller'."\n", - 'type' => 'string', - 'example' => 'PROVIDER', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The name of the API'."\n", - 'type' => 'string', - 'example' => 'AreaWeather', - ], - 'RegionId' => [ - 'description' => 'The region to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'ItemValue' => ['description' => 'The value corresponding to the monitoring metric.', 'type' => 'string', 'example' => '15', 'title' => ''], + 'ItemTime' => ['description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"根据地区名称查询天气情况\\",\\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":"<DescribeAuthorizedApisResponse>\\r\\n <PageNumber>1</PageNumber>\\r\\n <TotalCount>2</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n <AuthorizedApis>\\r\\n <AuthorizedApi>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>\\r\\n <GroupName>Weather</GroupName>\\r\\n <StageName>RELEASE</StageName>\\r\\n <Operator>PROVIDER</Operator>\\r\\n <ApiId>baacc592e63a4cb6a41920d9d3f91f38</ApiId>\\r\\n <ApiName>AreaWeather</ApiName>\\r\\n <AuthorizationSource>CONSOLE</AuthorizationSource>\\r\\n <Description>根据地区名称查询天气情况</Description>\\r\\n <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>\\r\\n <AuthVaildTime>2018-10-05T16:00:00Z</AuthVaildTime>\\r\\n </AuthorizedApi>\\r\\n <AuthorizedApi>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>\\r\\n <GroupName>Weather</GroupName>\\r\\n <StageName>RELEASE</StageName>\\r\\n <Operator>CONSUMER</Operator>\\r\\n <ApiId>baacc592e63a4cb6a41920d9d3f89g76</ApiId>\\r\\n <ApiName>Area</ApiName>\\r\\n <AuthorizationSource>API</AuthorizationSource>\\r\\n <Description>查询区域</Description>\\r\\n <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>\\r\\n <AuthVaildTime></AuthVaildTime>\\r\\n </AuthorizedApi>\\r\\n </AuthorizedApis> \\r\\n</DescribeAuthorizedApisResponse>","errorExample":""}]', - 'title' => 'DescribeAuthorizedApis', - 'description' => '* This operation is intended for API callers.'."\n" - .'* The specified application can call all APIs included in the responses.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApiDoc' => [ - 'summary' => 'Queries the documentation of an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiLatencyData', + 'description' => 'query the latency metrics in milliseconds for a specified API.'."\n" + ."\n" + .'- This API is intended for API providers.'."\n" + ."\n" + .'- Only statistics for API calls made in the release environment are collected by default.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiLatencyData'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApiMarketAttributes' => [ + 'summary' => 'Queries the Alibaba Cloud Marketplace attributes of an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11805,50 +7551,87 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94306', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94319', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b693252f3f19445e9a01dac177c4454c', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'ApiId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1f9b5e9ba80943099cac52e040b7e160', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The environment name. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n" - ."\n" - .'If this parameter is not specified, the default value RELEASE is used.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'RELEASE', - 'default' => 'release', + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '6318cd8f6a304cac9318dea8d9a78f7a', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '545D4E52-4F77-5EC4-BB7E-7344CEC7B5E6', 'title' => ''], + 'MarketChargingMode' => ['description' => 'The billing method used by the Alibaba Cloud Marketplace.', 'type' => 'string', 'example' => 'PREPAID_BY_USAGE', 'title' => ''], + 'NeedCharging' => ['description' => 'Indicates whether fees are charged.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeApiMarketAttributes', + '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' => 'Queries the attached APIs of an API product.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApiId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], + 'schema' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -11856,300 +7639,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => 'b24be7e59a104e52bffbf432cc9272af', - ], - 'ResultType' => [ - 'description' => 'The return value type.'."\n", - 'type' => 'string', - 'example' => 'JSON', - ], - 'DisableInternet' => [ - 'description' => '* Specifies whether to set **DisableInternet** to **true** to limit API calls to within the VPC.'."\n" - .'* If you set **DisableInternet** to **false**, the limit is lifted. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResultSample' => [ - 'description' => 'The sample response.'."\n", - 'type' => 'string', - 'example' => '{\\n \\"status\\": 0,\\n \\"data\\": {\\n \\"count\\": 1,\\n \\"list\\": [\\n \\"352\\"\\n ]\\n },\\n \\"message\\": \\"success\\"\\n}', - ], - 'RegionId' => [ - 'description' => 'The region ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ForceNonceCheck' => [ - 'description' => '* Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values: PUBLIC and PRIVATE.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'FailResultSample' => [ - 'description' => 'The sample error response from the backend service.'."\n", - 'type' => 'string', - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', - ], - 'AuthType' => [ - 'description' => 'The security authentication method. Valid values: APP, ANONYMOUS, and APPOPENID, indicating respectively Alibaba Cloud application authentication, anonymous authentication, and third-party OpenID Connect account authentication.'."\n", - 'type' => 'string', - 'example' => 'APP', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F253FB5F-9AE1-5DDA-99B5-46BE00A3719E', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'f51d08c5b7c84342905544ebaec26d35', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'Member Age Transaction Service'."\n", - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'Lynk\\&Co Digital Mall OMS-UAT'."\n", - ], - 'DeployedTime' => [ - 'description' => 'The publishing time.'."\n", - 'type' => 'string', - 'example' => '2022-07-13T16:00:33Z', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The name of the API'."\n", - 'type' => 'string', - 'example' => 'ObtainKeywordQRCodeAddress'."\n", - ], - 'RequestConfig' => [ - 'description' => 'The returned API frontend definition. It is an array consisting of RequestConfig data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestPath' => [ - 'description' => 'The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is ` /object/add `.'."\n", - 'type' => 'string', - 'example' => '/api/billing/test/[type]', - ], - 'RequestHttpMethod' => [ - 'description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'BodyFormat' => [ - 'description' => 'This parameter takes effect only when the RequestMode parameter is set to MAPPING.********'."\n" - ."\n" - .'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.'."\n", - 'type' => 'string', - 'example' => 'STREAM', - ], - 'RequestMode' => [ - 'description' => 'The request mode. Valid values:'."\n" - ."\n" - .'* MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" - .'* PASSTHROUGH: Parameters are passed through.'."\n" - .'* MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.'."\n", - 'type' => 'string', - 'example' => 'MAPPING', - ], - 'PostBodyDescription' => [ - 'description' => 'The description of the request body.'."\n", - 'type' => 'string', - 'example' => 'fwefwef', - ], - 'RequestProtocol' => [ - 'description' => 'The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'EscapePathParam' => [ - 'description' => 'Whether to escape the Path parameter, if true, the [param] on the Path will be treated as a regular character.', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'ErrorCodeSamples' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ErrorCodeSample' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The returned error code.'."\n", - 'type' => 'string', - 'example' => 'Error', - ], - 'Message' => [ - 'description' => 'The returned error message.'."\n", - 'type' => 'string', - 'example' => 'error message', - ], - 'Description' => [ - 'description' => 'The error description.'."\n", - 'type' => 'string', - 'example' => 'Unauthorized'."\n", - ], - ], - ], - ], - ], - ], - 'RequestParameters' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'ApiInfoList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'RequestParameter' => [ - 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.'."\n", + 'ApiInfo' => [ + 'description' => 'The information about the returned APIs.', 'type' => 'array', 'items' => [ - 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'JsonScheme' => [ - 'description' => 'JSON scheme'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'MaxValue' => [ - 'description' => 'The maximum value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'ArrayItemsType' => [ - 'description' => 'The type of the array element.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'MinValue' => [ - 'description' => 'The minimum value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocShow' => [ - 'description' => 'Indicates whether the document is public. Valid values: **PUBLIC** and **PRIVATE**.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'MaxLength' => [ - 'description' => 'The maximum length.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'ApiParameterName' => [ - 'description' => 'The name of the parameter in the API request.'."\n", - 'type' => 'string', - 'example' => 'Length', - ], - 'EnumValue' => [ - 'description' => 'The hash values that are supported when **ParameterType** is set to Int, Long, Float, Double, or String. Separate values with commas (,). Examples: 1,2,3,4,9 and A,B,C,E,F.'."\n", - 'type' => 'string', - 'example' => 'boy,girl', - ], - 'DemoValue' => [ - 'description' => 'The example value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'string', - 'example' => 'OPTIONAL', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'Parameters'."\n", - ], - 'ParameterType' => [ - 'description' => 'The data type of the parameter.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'RegularExpression' => [ - 'description' => 'The regular expression that is used for parameter validation when **ParameterType** is set to String.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'MinLength' => [ - 'description' => 'The minimum length.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'DocOrder' => [ - 'description' => 'The order in which the parameter is sorted in the document.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => 'dd46297680014a7e8e318308f3345951', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group to which the API belongs.', 'type' => 'string', 'example' => 'testApiGroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '1e377f18142345dfb700cd8911c2463a', 'title' => ''], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/test', 'title' => ''], + 'Method' => ['description' => 'The request method of the API.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'StageName' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'testApi', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the API is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"会员时代交易服务\\",\\n \\"Description\\": \\"领克数字商城OMS-UAT\\",\\n \\"DeployedTime\\": \\"2022-07-13T16:00:33Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"获取关键词二维码地址\\",\\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\\": \\"未授权\\"\\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\\": \\"参数说明\\",\\n \\"ParameterType\\": \\"String\\",\\n \\"RegularExpression\\": \\"xxx\\",\\n \\"MinLength\\": 2,\\n \\"DocOrder\\": 0,\\n \\"Location\\": \\"HEAD\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeApiDoc', - 'description' => '* For API callers, the specified API must be a public or authorized private API that has been published to a runtime environment.'."\n" - .'* When you call this operation as an API caller, the service information, parameter definitions, and other details of the API you specify are returned.'."\n" - .'* When you call this operation as an API provider, the definition of the specified API running in the specified runtime environment is returned. The returned definition takes effect in the runtime environment, and may be different from the definition of the API you modify.'."\n" - .'* Before you call this operation as an API provider, ensure that the API to be queried is a public one or that your application has been authorized to call the API, because authentication on API callers is required.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDeployedApi' => [ - 'summary' => 'Queries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiProductApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiProductApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => [], @@ -12157,50 +7721,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94351', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '81750604ccff48c48f34d6c0165e09db', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110962435', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ab7c95a01a7e42f28718f34497bbf47c', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE: the pre-release environment**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12208,777 +7744,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '4eed13a57d4e42fbb51316be8a5329ff', - ], - 'ResultType' => [ - 'description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.'."\n", - 'type' => 'string', - 'example' => 'HTML', - ], - 'DisableInternet' => [ - 'description' => '* Specifies whether to set DisableInternet to **true** to limit API calls to within the VPC.'."\n" - .'* If you set DisableInternet to **false**, the limit is lifted.'."\n" - ."\n" - .'> If you do not set this parameter, the original value is not modified.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResultBodyModel' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'ResultSample' => [ - 'description' => 'The sample response from the backend service.'."\n", - 'type' => 'string', - 'example' => '{code: 200, message:\'success\', data: \'\'}', - ], - 'AllowSignatureMethod' => [ - 'description' => 'The signature method used by the client. Valid values:'."\n" - ."\n" - .'* HmacSHA256'."\n" - .'* HmacSHA1,HmacSHA256'."\n", - 'type' => 'string', - 'example' => 'HmacSHA256', - ], - 'RegionId' => [ - 'description' => 'The region to which the API group belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ForceNonceCheck' => [ - 'description' => '* Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" - .'* If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Visibility' => [ - 'description' => 'Specifies whether to make the API public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.**'."\n" - .'* **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'FailResultSample' => [ - 'description' => 'The sample error response from the backend service.'."\n", - 'type' => 'string', - 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', - ], - 'AuthType' => [ - 'description' => 'The security authentication method of the API. Valid values:'."\n" - ."\n" - .'* **APP: Only authorized applications can call the API.**'."\n" - ."\n" - .'* **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" - ."\n" - .' * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.'."\n", - 'type' => 'string', - 'example' => 'APP', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Api description', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'Weather', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'bc77f5b49c974437a9912ea3755cd834', - ], - 'DeployedTime' => [ - 'description' => 'The deployment time. Format: yyyy-mm-ddhh:mm:ss.'."\n", - 'type' => 'string', - 'example' => '2022-07-25T17:47:51Z', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE: the pre-release environment**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The name of the API'."\n", - 'type' => 'string', - 'example' => 'weather', - ], - 'RequestConfig' => [ - 'description' => 'Configuration items of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestConfig](~~43985~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'BodyModel' => [ - 'description' => 'The body model.'."\n", - 'type' => 'string', - 'example' => 'https://apigateway.aliyun.com/models/3a240a127dccXXXXXXXX947b4095/9e2df550e85b4121a79XXXXXxaab', - ], - 'RequestPath' => [ - 'description' => 'The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is ` /object/add `.'."\n", - 'type' => 'string', - 'example' => '/api/billing/test/[type]', - ], - 'RequestHttpMethod' => [ - 'description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'BodyFormat' => [ - 'description' => 'This parameter takes effect only when the RequestMode parameter is set to MAPPING.'."\n" - ."\n" - .'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.', - 'type' => 'string', - 'example' => 'STREAM', - ], - 'RequestMode' => [ - 'description' => 'The request mode. Valid values:'."\n" - ."\n" - .'* MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" - .'* PASSTHROUGH: Parameters are passed through.'."\n" - .'* MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.'."\n", - 'type' => 'string', - 'example' => 'MAPPING', - ], - 'PostBodyDescription' => [ - 'description' => 'The description of the request body.'."\n", - 'type' => 'string', - 'example' => 'fwefwef', - ], - 'RequestProtocol' => [ - 'description' => 'The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS".'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - ], - ], - 'ServiceConfig' => [ - 'description' => 'The configuration items of API requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceConfig](~~43987~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6kg9x8sx2tbxxxx', - ], - 'MockStatusCode' => [ - 'description' => 'The status code returned for service mocking.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ServicePath' => [ - 'description' => 'The path used to call the back-end service. If the complete back-end service path is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServicePath is **/object/add**.``'."\n", - 'type' => 'string', - 'example' => '/object/add', - ], - 'Mock' => [ - 'description' => 'Specifies whether to enable the Mock mode. Valid values:'."\n" - ."\n" - .'* **TRUE: The Mock mode is enabled.**'."\n" - .'* **FALSE: The Mock mode is not enabled.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'ServiceAddress' => [ - 'description' => 'The URL used to call the back-end service. If the complete back-end service URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the value of ServiceAddress is **http://api.a.com:8080**.``'."\n", - 'type' => 'string', - 'example' => 'http://api.a.com:8080', - ], - 'ServiceVpcEnable' => [ - 'description' => 'Specifies whether to enable the VPC channel. Valid values:'."\n" - ."\n" - .'* **TRUE**: The VPC channel is enabled. You must create the corresponding VPC access authorization before you can enable a VPC channel.'."\n" - .'* **FALSE**: The VPC channel is not enabled.'."\n", - 'type' => 'string', - 'example' => 'TRUE', - ], - 'MockResult' => [ - 'description' => 'The result returned when the Mock mode is enabled.'."\n", - 'type' => 'string', - 'example' => 'test result', - ], - 'ServiceHttpMethod' => [ - 'description' => 'The HTTP method used to call a backend service. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'ServiceProtocol' => [ - 'description' => 'The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ServiceTimeout' => [ - 'description' => 'The timeout period of the backend service, in millisecond.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'MockHeaders' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MockHeader' => [ - 'description' => 'The simulated Headers.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'HeaderValue' => [ - 'description' => 'The value of the HTTP header parameter.'."\n", - 'type' => 'string', - 'example' => '86400', - ], - 'HeaderName' => [ - 'description' => 'The name of the HTTP header parameter.'."\n", - 'type' => 'string', - 'example' => 'Content-Type', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'VpcConfig' => [ - 'description' => 'Configuration items related to VPC channels'."\n", - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zeafsc3fygk1***', - ], - 'InstanceId' => [ - 'description' => 'The IDs of the ELB and SLB instances in the VPC.'."\n", - 'type' => 'string', - 'example' => 'i-bp1h497hkijewv2***', - ], - 'Port' => [ - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - ], - 'Name' => [ - 'description' => 'The name of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'glmall-app-test', - ], - ], - ], - 'FunctionComputeConfig' => [ - 'description' => 'Backend configuration items when the backend service is Function Compute'."\n", - 'type' => 'object', - 'properties' => [ - 'FcType' => [ - 'description' => 'The type of the Function Compute instance.'."\n", - 'type' => 'string', - 'example' => 'HttpTrigger', - ], - 'RoleArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', - ], - 'Method' => [ - 'description' => 'The request method.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'FcBaseUrl' => [ - 'description' => 'The root path of Function Compute.'."\n", - 'type' => 'string', - 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/', - ], - 'ContentTypeValue' => [ - 'description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'."\n", - ], - 'RegionId' => [ - 'description' => 'The region where the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'OnlyBusinessPath' => [ - 'description' => 'The backend only receives the service path.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'FunctionName' => [ - 'description' => 'The function name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'domain_business_control', - ], - 'ContentTypeCatagory' => [ - 'description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" - ."\n" - .'* **DEFAULT: the default header type in API Gateway.**'."\n" - .'* **CUSTOM: a custom header type.**'."\n" - .'* **CLIENT: the ContentType header type of the client.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'Path' => [ - 'description' => 'The API request path.'."\n", - 'type' => 'string', - 'example' => '/api/offline/cacheData', - ], - 'ServiceName' => [ - 'description' => 'The service name defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'fcservicename', - ], - 'Qualifier' => [ - 'description' => 'The alias of the function.'."\n", - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], - ], - 'OpenIdConnectConfig' => [ - 'description' => 'The configuration items of the third-party OpenID Connect authentication method.'."\n", - 'type' => 'object', - 'properties' => [ - 'OpenIdApiType' => [ - 'description' => 'The configuration of OpenID Connect authentication. Valid values:'."\n" - ."\n" - .'* **IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.**'."\n" - .'* **BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.'."\n", - 'type' => 'string', - 'example' => 'IDTOKEN', - ], - 'IdTokenParamName' => [ - 'description' => 'The name of the parameter that corresponds to the token.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'PublicKeyId' => [ - 'description' => 'The ID of the public key.'."\n", - 'type' => 'string', - 'example' => '88483727556929326703309904351185815489', - ], - 'PublicKey' => [ - 'description' => 'The public key of the API.'."\n", - 'type' => 'string', - 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', - ], - ], - ], - 'ErrorCodeSamples' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ErrorCodeSample' => [ - 'description' => 'The sample error codes returned by the backend service.'."\n" - ."\n" - .'For more information, see [ErrorCodeSample](~~44392~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Error', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'error message', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - ], - 'description' => '', - ], - ], - ], - ], - 'ResultDescriptions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ResultDescription' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The return description of the API.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - 'description' => 'The type of the result.'."\n", - 'example' => 'String', - ], - 'Key' => [ - 'type' => 'string', - 'description' => 'The primary key of the result.'."\n", - 'example' => 'DEMO', - ], - 'HasChild' => [ - 'type' => 'boolean', - 'example' => 'false', - 'description' => 'Specifies whether a subnode exists.'."\n", - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'result description', - ], - 'Pid' => [ - 'type' => 'string', - 'description' => 'The ID of the parent node.'."\n", - 'example' => 'pid', - ], - 'Mandatory' => [ - 'description' => 'Specifies whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'type' => 'string', - 'description' => 'The name of the result.'."\n", - 'example' => 'fwqf', - ], - 'Id' => [ - 'type' => 'string', - 'description' => 'The ID of the result.'."\n", - 'example' => 'id', - ], - ], - ], - ], - ], - ], - 'SystemParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SystemParameter' => [ - 'description' => 'System parameters'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DemoValue' => [ - 'description' => 'Examples'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'QueryParamDTO', - ], - 'ParameterName' => [ - 'description' => 'The name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The name of the corresponding backend parameter.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'CustomSystemParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CustomSystemParameter' => [ - 'description' => 'The custom system parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DemoValue' => [ - 'description' => 'Example'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'ParameterName' => [ - 'description' => 'The name of the custom system parameter.'."\n", - 'type' => 'string', - 'example' => 'appid', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The name of the corresponding backend parameter.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'ConstantParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ConstantParameter' => [ - 'description' => 'The constant parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ServiceParameterName' => [ - 'description' => 'The name of the backend service parameter.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], - 'ConstantValue' => [ - 'description' => 'The constant value.'."\n", - 'type' => 'string', - 'example' => 'constance', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'RequestParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'RequestParameter' => [ - 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" - ."\n" - .'For more information, see [RequestParameter](~~43986~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'JsonScheme' => [ - 'description' => 'JSON scheme'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'MaxValue' => [ - 'description' => 'The maximum parameter value when ParameterType is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'ArrayItemsType' => [ - 'description' => 'The type of the array element.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'MinValue' => [ - 'description' => 'The minimum parameter value when ParameterType is set to Int, Long, Float, or Double.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocShow' => [ - 'description' => 'Specifies whether the document is public. Valid values: PUBLIC and PRIVATE.'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'MaxLength' => [ - 'description' => 'The maximum parameter length when ParameterType is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'ApiParameterName' => [ - 'description' => 'The name of the API parameter.'."\n", - 'type' => 'string', - 'example' => 'age', - ], - 'EnumValue' => [ - 'description' => 'The hash values that can be entered when ParameterType is set to Int, Long, Float, Double, or String. Separate different values with commas (,), such as 1,2,3,4,9 or A,B,C,E,F.'."\n", - 'type' => 'string', - 'example' => 'boy,girl', - ], - 'DemoValue' => [ - 'description' => 'Example'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required. Valid values: REQUIRED and OPTIONAL.'."\n", - 'type' => 'string', - 'example' => 'OPTIONAL', - ], - 'Description' => [ - 'description' => 'Description'."\n", - 'type' => 'string', - 'example' => 'parameter description', - ], - 'ParameterType' => [ - 'description' => 'The type of a request parameter. Valid values: String, Int, Long, Float, Double, and Boolean.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'RegularExpression' => [ - 'description' => 'The regular expression used for parameter validation when ParameterType is set to String.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'MinLength' => [ - 'description' => 'The minimum parameter length when ParameterType is set to String.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'DocOrder' => [ - 'description' => 'The order in the document.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'ServiceParameters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ServiceParameter' => [ - 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameter](~~43988~~).'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Location' => [ - 'description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - ], - 'ParameterType' => [ - 'description' => 'The data type of the back-end service parameter.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'ServiceParameterName' => [ - 'description' => 'The name of the backend service parameter.'."\n", - 'type' => 'string', - 'example' => 'clientIp', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'ServiceParametersMap' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0B805201-AF4C-5788-AC9E-C3EEC83DC82A', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'ApiProductInfoList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ServiceParameterMap' => [ - 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" - ."\n" - .'For more information, see [ServiceParameterMap](~~43989~~).'."\n", + 'ApiProductInfo' => [ + 'description' => 'The information about API products.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RequestParameterName' => [ - 'description' => 'The name of the front-end input parameter.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], - 'ServiceParameterName' => [ - 'description' => 'The name of the backend service parameter.'."\n", - 'type' => 'string', - 'example' => 'sex', - ], + 'ApiProductId' => ['description' => 'The ID of the API product.', 'type' => 'string', 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"Api 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' => 'DescribeDeployedApi', - ], - 'DescribeHistoryApis' => [ - 'summary' => 'Queries the historical versions of an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiProductsByApp', + 'summary' => 'Queries API products by application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiProductsByApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiProductsByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => [], @@ -12987,74 +7814,40 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94362', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94320', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0ccb66aadb5345b78a40f57d192d8aa4', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a12068f555964ca8a0c9c33288f1e5a7', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API. The name is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'getPersonInfo', - ], + 'schema' => ['description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the current page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -13062,146 +7855,134 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', - ], - 'PageSize' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 50. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', 'title' => ''], + 'CallSuccesses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The returned information about successful API calls. It is an array consisting of MonitorItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The value corresponding to the monitoring metric.', 'type' => 'string', 'example' => '650', 'title' => ''], + 'ItemTime' => ['description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:24:00Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ApiHisItems' => [ + 'CallFails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiHisItem' => [ - 'description' => 'The returned API information. It is an array consisting of ApiHisItems.'."\n", + 'MonitorItem' => [ + 'description' => 'The returned information about failed API calls. It is an array consisting of MonitorItem data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether an API version is effective. Valid values: ONLINE and OFFLINE.'."\n", - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => '5af418828f0344a3b588c0cc1331a3bc', - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'Creates an object'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'myGroup2', - ], - 'GroupId' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'example' => '1084f9034c744137901057206b39d2b6', - ], - 'DeployedTime' => [ - 'description' => 'The time when the API was published. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2016-07-20T08:28:48Z', - ], - 'StageName' => [ - 'description' => 'The environment name. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'StageAlias' => [ - 'description' => 'The environment alias.'."\n", - 'type' => 'string', - 'example' => 'Online', - ], - 'HistoryVersion' => [ - 'description' => 'The historical version of the API definition.'."\n", - 'type' => 'string', - 'example' => '20210915101416294', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'v2_role_assign', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], + 'ItemValue' => ['description' => 'The value corresponding to the monitoring metric.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ItemTime' => ['description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"创建对象接口\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"DeployedTime\\": \\"2016-07-20T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"线上\\",\\n \\"HistoryVersion\\": \\"20210915101416294\\",\\n \\"ApiName\\": \\"v2_role_assign\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeHistoryApis', - ], - 'DescribeImportOASTask' => [ - 'summary' => 'Queries the result of an OAS API import task.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiQpsData', + 'summary' => 'Queries the QPS statistics of an API.', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- Only statistics for API calls made in the release environment are collected by default.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiQpsData'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApiSignatures' => [ + 'summary' => 'Queries the backend signature keys that are bound to the APIs of a specified API group in a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '155133', - 'abilityTreeNodes' => [ - 'FEATUREapigateway9WMX21', - ], + 'abilityTreeCode' => '94330', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'OperationId', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status of the API import task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4c53ccf1d40c489686d1adf5c2644a7f', - ], + 'schema' => ['description' => 'The runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -13209,156 +7990,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], - 'ApiResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiResult' => [ - 'description' => 'The execution status of the subtask. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* WAIT'."\n" - .'* OVER'."\n" - .'* FAIL'."\n" - .'* CANCEL'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => 'c5a0c2900ff746b789c007545be22fb8', - ], - 'Path' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/creator/getByCreatorId', - ], - 'Method' => [ - 'description' => 'The HTTP request HTTP method of the API.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'release data api 411055691505041', - ], - 'GroupId' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'example' => '736508d885074167ba8fbce3bc95ea0b', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'GetByCreatorIdUsingGET', - ], - 'ErrorMessage' => [ - 'description' => 'The cause of the failure if the API fails to be imported.'."\n", - 'type' => 'string', - 'example' => 'Internal Error', - ], - 'UpdateStatus' => [ - 'description' => 'The execution status of the subtask. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* WAIT'."\n" - .'* OVER'."\n" - .'* FAIL'."\n" - .'* CANCEL'."\n", - 'type' => 'string', - 'example' => 'WAIT', - ], - ], - ], - ], - ], - ], - 'ModelResults' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiSignatures' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ModelResult' => [ - 'description' => 'The execution status of the subtask. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* WAIT'."\n" - .'* OVER'."\n" - .'* FAIL'."\n" - .'* CANCEL'."\n", + 'ApiSignatureItem' => [ + 'description' => 'The returned signature key information. It is an array consisting of ApiSignatureItem data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ModelName' => [ - 'description' => 'The model name.'."\n", - 'type' => 'string', - 'example' => 'Pet', - ], - 'ModelId' => [ - 'description' => 'The ID of the imported model.'."\n", - 'type' => 'string', - 'example' => '6b48d724c921415486e190c494dd6bf8', - ], - 'GroupId' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'example' => '736508d885074167ba8fbce3bc95ea0b', - ], - 'ErrorMessage' => [ - 'description' => 'The cause of the failure if the model fails to be imported.'."\n", - 'type' => 'string', - 'example' => 'Internal Error'."\n", - ], - 'UpdateStatus' => [ - 'description' => 'The execution status of the subtask. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* WAIT'."\n" - .'* OVER'."\n" - .'* FAIL'."\n" - .'* CANCEL'."\n", - 'type' => 'string', - 'example' => 'FAIL', - ], + 'BoundTime' => ['description' => 'The time when the backend signature key was bound.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90', 'title' => ''], + 'SignatureId' => ['description' => 'The ID of the backend signature key.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'SignatureName' => ['description' => 'The name of the backend signature key.', 'type' => 'string', 'example' => 'backendsignature', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'testapi', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'TaskStatus' => [ - 'description' => 'The status of the import task. Valid values:'."\n" - ."\n" - .'* Running'."\n" - .'* Finished'."\n", - 'type' => 'string', - 'example' => 'Finished', + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"这个API用于查询\\",\\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' => 'DescribeImportOASTask', - ], - 'DescribePurchasedApis' => [ - 'summary' => 'Queries the APIs purchased in the Alibaba Cloud Marketplace.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiSignatures', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiSignatures'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApiTrafficControls' => [ + 'summary' => 'Queries the throttling policies bound to all members of an API group in a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13367,86 +8067,38 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '94333', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'd27ad517be5f4c95ac3631780a8f4d50', - ], - ], - [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The runtime environment of the API. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], + 'schema' => ['description' => 'The ID of the API group that you want to query.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cz88IpQuery'."\n", - ], + 'schema' => ['description' => 'The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '123,234', 'title' => ''], ], [ - 'name' => 'Visibility', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**: indicates that the API is public. If you set this parameter to PUBLIC, this API is displayed on the API List page in the console for all users after the API is published to the production environment.'."\n" - .'* **PRIVATE**: indicates that the API is private. If you set this parameter to PRIVATE, this API is not displayed in Alibaba Cloud Marketplace after the API group to which this API belongs is made available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -13454,125 +8106,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PurchasedApis' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiTrafficControls' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'PurchasedApi' => [ - 'description' => 'The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.'."\n", + 'ApiTrafficControlItem' => [ + 'description' => 'The returned throttling policy information. It is an array consisting of ApiTrafficControlItem data.', 'type' => 'array', 'items' => [ - 'description' => 'The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.'."\n", 'type' => 'object', 'properties' => [ - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**'."\n" - .'* **PRIVATE**'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'PurchasedTime' => [ - 'description' => 'The time when the API was purchased.'."\n", - 'type' => 'string', - 'example' => '2021-06-11T13:57:38+08:00', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => 'eb6e54c1576d41149746e8e69b0a0792', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the API.'."\n", - 'type' => 'string', - 'example' => '2021-06-11T13:57:38+08:00', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'DMS_DEFAULT_GROUP_408589', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group to which the API belongs. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'example' => '3013a55c0c44483f984d26df27120513', - ], - 'DeployedTime' => [ - 'description' => 'The deployment time. Format: yyyy-mm-ddhh:mm:ss.'."\n", - 'type' => 'string', - 'example' => '2021-06-1113:57:38', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'gw_rado_tissot_', - ], - 'RegionId' => [ - 'description' => 'The ID of the region in which the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'BoundTime' => ['description' => 'The binding time of the throttling policy.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '46fbb52840d146f186e38e8e70fc8c90', 'title' => ''], + 'TrafficControlId' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'TrafficControlName' => ['description' => 'The name of the throttling policy.', 'type' => 'string', 'example' => 'backendsignature', 'title' => ''], + 'ApiName' => ['description' => 'API operation', 'type' => 'string', 'example' => 'testapi', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribePurchasedApis', - ], - 'DescribeApiHistories' => [ - 'summary' => 'Queries the historical versions of a specified API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiTrafficControls', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficControls'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApiTrafficData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13581,76 +8182,40 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94315', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94334', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1084f9034c744137901057206b39d2b6', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE ', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c076144d7878437b8f82fb85890ce6a0', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API. The name is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'weather', - ], + 'schema' => ['description' => 'The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T08:28:48Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'required' => false, - 'example' => '10', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2016-07-23T09:28:48Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'required' => false, - 'example' => '1', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**: the test environment'."\n" + ."\n" + .'- PRE: the pre-release environment', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -13658,256 +8223,196 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ003', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', 'title' => ''], + 'CallUploads' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The returned uplink traffic data of API calls. It is an array consisting of MonitorItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The value corresponding to the monitoring metric.', 'type' => 'string', 'example' => '670', 'title' => ''], + 'ItemTime' => ['description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ApiHisItems' => [ + 'CallDownloads' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiHisItem' => [ - 'description' => 'The returned API information. It is an array consisting of ApiHisItem data.'."\n", + 'MonitorItem' => [ + 'description' => 'The returned downlink traffic data of API calls. It is an array consisting of MonitorItem data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether an API version is effective. Valid values: **ONLINE** and **OFFLINE**.'."\n", - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '5af418828f0344a3b588c0cc1331a3bc', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Creates an object'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'myGroup2', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '1084f9034c744137901057206b39d2b6', - ], - 'DeployedTime' => [ - 'description' => 'The publishing time (UTC) of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-20T08:28:48Z', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'HistoryVersion' => [ - 'description' => 'The historical version of the API.'."\n", - 'type' => 'string', - 'example' => '20160705104552393', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'CreateObject'."\n", - ], - 'RegionId' => [ - 'description' => 'The region in which the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], + 'ItemValue' => ['description' => 'The value corresponding to the monitoring metric.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ItemTime' => ['description' => 'The time of the monitoring metric. The time format follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2016-07-28T08:20:00Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"创建对象接口\\",\\n \\"GroupName\\": \\"myGroup2\\",\\n \\"GroupId\\": \\"1084f9034c744137901057206b39d2b6\\",\\n \\"DeployedTime\\": \\"2016-07-20T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"HistoryVersion\\": \\"20160705104552393\\",\\n \\"ApiName\\": \\"创建对象\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeApiHistoriesResponse>\\r\\n <ApiHisItems>\\r\\n <ApiHisItem>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>63be9002440b4778a61122f14c2b2bbb</GroupId>\\r\\n <GroupName>myGroup3</GroupName>\\r\\n <ApiId>c076144d7878437b8f82fb85890ce6a0</ApiId>\\r\\n <ApiName>获取对象列表</ApiName>\\r\\n <StageName>release</StageName>\\r\\n <HistoryVersion>20160705104552292</HistoryVersion>\\r\\n <Status>DISABLE</Status>\\r\\n <Description>分页显示对象列表</Description>\\r\\n <DeployedTime>2016-07-23T08:28:48Z</DeployedTime>\\r\\n </ApiHisItem>\\r\\n <ApiHisItem>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>1084f9034c744137901057206b39d2b6</GroupId>\\r\\n <GroupName>myGroup2</GroupName>\\r\\n <ApiId>5af418828f0344a3b588c0cc1331a3bc</ApiId>\\r\\n <ApiName>创建对象</ApiName>\\r\\n <StageName>release</StageName>\\r\\n <HistoryVersion>20160705104552393</HistoryVersion>\\r\\n <Status>DISABLE</Status>\\r\\n <Description>创建对象接口</Description>\\r\\n <DeployedTime>2016-07-20T08:28:48Z</DeployedTime>\\r\\n </ApiHisItem>\\r\\n </ApiHisItems>\\r\\n <PageNumber>3</PageNumber>\\r\\n <PageSize>15</PageSize>\\r\\n <TotalCount>32</TotalCount>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ003</RequestId> \\r\\n</DescribeApiHistoriesResponse>","errorExample":""}]', - 'title' => 'DescribeApiHistories', - 'description' => '* This operation is intended for API providers. Only APIs that have been published have historical version records.'."\n" - .'* This operation allows you to obtain the historical versions of an API. This operation is always called by other operations.'."\n", - ], - 'DescribeDeployedApis' => [ - 'summary' => 'Queries the APIs that have been published to a specified environment.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApiTrafficData', + 'summary' => 'Queries the statistics on the traffic of an API.', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- Only statistics for API calls made in the release environment are collected by default.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApiTrafficData'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeApis' => [ + 'summary' => 'Queries a list of APIs that are being defined.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94352', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], + 'schema' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => false, 'example' => 'c4a4d2de657548a2bd485d5d4df42b4a', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The API ID.', 'type' => 'string', 'required' => false, 'example' => 'f68c19ee3bd1478fb58aa05ce8ae9b5a', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c076144d7878437b8f82fb85890ce6a0', - ], + 'schema' => ['description' => 'The API name. The name is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'weather', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'CatalogId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API. The name is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'weather', - ], + 'schema' => ['description' => 'The category ID.', 'type' => 'string', 'required' => false, 'example' => '1553414085247362', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Visibility', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: The API is public. If you publish the definition of a public API to the production environment, the definition is displayed on the APIs page for all users.'."\n" + ."\n" + .'- **PRIVATE**: The API is private. If you publish an API group that contains a private API in Alibaba Cloud Marketplace, the API is not displayed in Alibaba Cloud Marketplace.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'EnableTagAuth', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable tag verification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable tag verification.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tags of objects that match the rule.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appname', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testapp', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => 'Key, Value', 'maxItems' => 50, + 'title' => '', ], ], [ 'name' => 'ApiPath', 'in' => 'query', - 'schema' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/st4', - ], + 'schema' => ['description' => 'The request path of the API.', 'type' => 'string', 'required' => false, 'example' => '/illegal/query', 'title' => ''], ], [ 'name' => 'ApiMethod', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP method of the API request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], + 'schema' => ['description' => 'The HTTP method of the API request.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + ], + [ + 'name' => 'UnDeployed', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to filter unpublished APIs.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which you want to perform this operation. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -13915,212 +8420,200 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DeployedApis' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'ApiSummarys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DeployedApiItem' => [ - 'description' => 'The returned API information. It is an array consisting of DeployedApiItem data.'."\n", + 'ApiSummary' => [ + 'description' => 'The queried API definitions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**'."\n" - .'* **PRIVATE**'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => 'c076144d7878437b8f82fb85890ce6a0', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Queries objects by pages'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'myGroup3', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], - 'DeployedTime' => [ - 'description' => 'The publising time (UTC) of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'DescribeObjects'."\n", - ], - 'RegionId' => [ - 'description' => 'The region where the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'ApiPath' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/trademark/search', + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: The API is public.'."\n" + ."\n" + .'- **PRIVATE**: The API is private.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'Create object API', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group to which the API belongs.', 'type' => 'string', 'example' => 'myGroup2', 'title' => ''], + 'GroupId' => ['description' => 'The API group ID.', 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the API was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2016-05-20T18:18:25Z', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'Create object', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region to which the API belongs.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'ApiPath' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/sqb/', 'title' => ''], + 'ApiMethod' => ['description' => 'The HTTP method of the API request.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'DeployedInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedInfo' => [ + 'description' => 'The API publishing statuses.', + 'type' => 'array', + 'items' => [ + 'description' => 'The API publishing status.', + 'type' => 'object', + 'properties' => [ + 'StageName' => ['description' => 'Stage Name:'."\n" + ."\n" + .'- **RELEASE**: production environment'."\n" + ."\n" + .'- **PRE**: staging environment'."\n" + ."\n" + .'- **TEST**: test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'EffectiveVersion' => ['description' => 'The deployed version.', 'type' => 'string', 'example' => '20220103170737313', 'title' => ''], + 'DeployedStatus' => ['description' => 'The deployment status. Valid values: DEPLOYED and NONDEPLOYED.', 'type' => 'string', 'example' => 'DEPLOYED', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ApiMethod' => [ - 'description' => 'The HTTP method of the API request.'."\n", - 'type' => 'string', - 'example' => 'POST', + 'TagList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the APIs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tagKey', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'tagValue', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"获取对象列表\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ApiPath\\": \\"/trademark/search\\",\\n \\"ApiMethod\\": \\"POST\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeDeployedApis', - 'description' => '* This API is intended for API providers.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApis', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- This operation returns a list of all APIs that are being defined. The basic information about these APIs is also returned in the list.'."\n" + ."\n" + .'- This operation returns all APIs that are being edited, regardless of their environments. The returned definitions may be different from the definitions in the environments.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMarketRemainsQuota' => [ - 'summary' => 'Queries the number of remaining ordered relationships for a purchaser.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApisByApp' => [ + 'summary' => 'Queries the APIs with which an application is associated.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94376', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeCode' => '94323', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '*.demo.com', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '333486644'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RemainsQuota' => [ - 'description' => 'The remaining quota.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', - ], - ], - 'description' => '', - ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RemainsQuota\\": 1000,\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', - 'title' => 'DescribeMarketRemainsQuota', - ], - 'DescribeDeployApiTask' => [ - 'summary' => 'Queries the progress of an asynchronous API publishing task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94350', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', + [ + 'name' => 'ApiUid', + 'in' => 'query', + 'schema' => ['description' => 'The API ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'b19240592b1b4e74961fb8438ed7550c'], ], - ], - 'parameters' => [ [ - 'name' => 'OperationUid', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '51524fb8f12846d694d0a1de9a0cf274', - ], + 'schema' => ['description' => 'The name of the API. The name is used for fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'getPersonInfo'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => 'The request path of the API.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '/tt'], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => ['description' => 'The request HTTP method of the API.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'POST'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the API.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -14128,97 +8621,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', - ], - 'DeployedResults' => [ + 'PageNumber' => ['description' => 'The number of pages to return the results on.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015'], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'AppApiRelationInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DeployedResult' => [ - 'description' => 'The returned result.'."\n", + 'AppApiRelationInfo' => [ + 'description' => 'The API authorizations.', 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Success. Request Success.', - ], - 'StageName' => [ - 'description' => 'The runtime environment of the API. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b', - ], - 'ApiUid' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '0433c1cd84724923b7a4f9ca1cfc249c', - ], - 'DeployedStatus' => [ - 'description' => 'The deployment status of the API.'."\n", - 'type' => 'string', - 'example' => 'OVER', - ], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'title' => '', 'example' => 'c625795a1e664782a918eaa629e96ab5'], + 'AuthorizationSource' => ['description' => 'The authorization source.', 'type' => 'string', 'title' => '', 'example' => 'SELF'], + 'AuthVaildTime' => ['description' => 'The validity period of the authorization.', 'type' => 'string', 'title' => '', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'], + 'Description' => ['description' => 'The authorization description.', 'type' => 'string', 'title' => '', 'example' => 'b1008kz'], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'title' => '', 'example' => 'wb2022012101605749'], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'title' => '', 'example' => '38bed48d664149e4b9b5ea576319673f'], + 'Operator' => ['description' => 'The authorizer. Valid values:'."\n" + ."\n" + .'- **PROVIDER**: API owner'."\n" + ."\n" + .'- **CONSUMER**: API caller', 'type' => 'string', 'example' => 'PROVIDER', 'title' => ''], + 'StageName' => ['description' => 'The environment name.', 'type' => 'string', 'title' => '', 'example' => 'RELEASE'], + 'StageAlias' => ['description' => 'The environment alias.', 'type' => 'string', 'example' => 'Production', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the authorization was created.', 'type' => 'string', 'title' => '', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'title' => '', 'example' => 'sd2_h5_player_history_competition'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'title' => '', 'example' => '/api/offline/cacheData'], + 'Method' => ['description' => 'The HTTP method of the API.', 'type' => 'string', 'title' => '', 'example' => 'GET'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeDeployApiTask', - ], - 'DescribeAbolishApiTask' => [ - 'summary' => 'Queries the progress of an API unpublishing task.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeApisByApp', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApisByBackend' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94303', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '118586', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'OperationUid', + 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the unpublishing operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'fc54****dd4c4***ad7edd7****39401', - ], + 'schema' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'required' => true, 'example' => '4ac69b7a17524781b275ed4c5eb25c54', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**'."\n" + ."\n" + .'- **TEST**'."\n" + ."\n" + .'If you do not specify this parameter, APIs in the draft state are returned.', 'type' => 'string', 'required' => false, 'example' => 'PRE', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14226,133 +8747,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', - ], - 'ApiAbolishResults' => [ + 'PageNumber' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ApiInfoList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiAbolishResult' => [ - 'description' => 'The result returned.'."\n", + 'ApiInfo' => [ + 'description' => 'The information about the returned API list.', 'type' => 'array', 'items' => [ - 'description' => 'The result returned.'."\n", 'type' => 'object', 'properties' => [ - 'StageId' => [ - 'description' => 'The ID of the runtime environment.'."\n", - 'type' => 'string', - 'example' => '0919f2854a88484c91dc9253347c78f9', - ], - 'AbolishStatus' => [ - 'description' => 'The unpublishing status.'."\n", - 'type' => 'string', - 'example' => 'OVER', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '160cb6505e1c43a6b84346856d74eb47', - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'wb2022021401619286', - ], - 'ApiUid' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '4e26cdbbb113416dba1f0285bed29979', - ], - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Success. Request Success.', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'v2_page_consent', - ], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '20bcdc9453524b78a8beb1f6de21edb7', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'testApiGroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '15bcdc9453524b7gs8beb1f6de21edb7', 'title' => ''], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/test', 'title' => ''], + 'Method' => ['description' => 'The request method of the API.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'testApi', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeAbolishApiTask', - ], - 'AbolishApi' => [ - 'summary' => 'Unpublishes a specified API from a specified runtime environment.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApisByBackend', + 'summary' => 'Queries APIs in the draft or published state that are created by using a specified backend service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByBackend'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the APIs that are bound to an access control list (ACL).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94324', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the specified API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14360,94 +8848,113 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'description' => 'The returned API information. It is an array of ApiInfo data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundTime' => ['description' => 'The time of API binding.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'Visibility' => ['description' => 'The visibility of the API. Valid values:'."\n" + ."\n" + .'- **PUBLIC**'."\n" + ."\n" + .'- **PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'mygroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- \\*\\*TEST.', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API', 'type' => 'string', 'example' => 'testapi', 'title' => ''], + 'RegionId' => ['description' => 'The region in which the API is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","errorExample":""},{"type":"xml","example":"<AbolishApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ016</RequestId> \\r\\n</AbolishApiResponse>","errorExample":""}]', - 'title' => 'AbolishApi', - 'description' => '* This operation is intended for API providers and is the opposite of DeployApi.'."\n" - .'* An API can be unpublished from a specified runtime environment in under 5 seconds.'."\n" - .'* An unpublished API cannot be called in the specified runtime environment.'."\n", - ], - 'DeployApi' => [ - 'summary' => 'Publishes an API to a specified environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApisByIpControl', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- You can specify PageNumber to obtain the result on the specified page.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByIpControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisByIpControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApisBySignature' => [ + 'summary' => 'Queries the APIs to which a specified backend signature key is bound.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94302', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '63be9002440b4778a61122f14c2b2bbb', - ], - ], - [ - 'name' => 'ApiId', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', - ], + 'schema' => ['description' => 'The ID of the signature key.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The publishing remarks.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'for_test1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14455,100 +8962,113 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'description' => 'The returned API information. It is an array consisting of ApiInfo data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundTime' => ['description' => 'The binding time of the API.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**'."\n" + ."\n" + .'- **PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which the API belongs.', 'type' => 'string', 'example' => 'mygroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'testapi', 'title' => ''], + 'RegionId' => ['description' => 'The region where the API is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"<DeployApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId> \\r\\n</DeployApiResponse>","errorExample":""}]', - 'title' => 'DeployApi', - 'description' => '* This operation is intended for API providers. Only the API that you have defined and published to a runtime environment can be called.'."\n" - .'* An API is published to a cluster in under 5 seconds.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchDeployApis' => [ - 'summary' => 'Publishes multiple APIs at a time.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApisBySignature', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The results are returned on separate pages. You can specify PageNumber to obtain the result on the specified page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisBySignature'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisBySignature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeApisByTrafficControl' => [ + 'summary' => 'Queries the APIs to which a specified throttling policy is bound.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94327', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'StageName', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n" - .'* PRE: the pre-release environment'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the throttling policy that you want to query.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Api', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The APIs that you want to publish.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b4f5c342b8bc4ef88ccda0332402e0fa', - ], - 'ApiUid' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2b35dd68345b472f8051647306a16415', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14556,188 +9076,113 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OperationId' => [ - 'description' => 'The ID of the operation.'."\n", - 'type' => 'string', - 'example' => '2a322599-8e38-428a-a306-9b21ea2129bf', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'description' => 'The returned API information. It is an array consisting of ApiInfo data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundTime' => ['description' => 'The binding time of the API.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**'."\n" + ."\n" + .'- **PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which an API belongs.', 'type' => 'string', 'example' => 'mygroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API', 'type' => 'string', 'example' => 'testapi', 'title' => ''], + 'RegionId' => ['description' => 'The region where the API is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"2a322599-8e38-428a-a306-9b21ea2129bf\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', - 'title' => 'BatchDeployApis', - ], - 'BatchAbolishApis' => [ - 'summary' => 'Unpublishes multiple published APIs at a time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeApisByTrafficControl', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- You can specify PageNumber to obtain the result on the specified page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByTrafficControl'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Api', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The APIs that you want to operate.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StageId' => [ - 'description' => 'The ID of the environment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '979fd16250644d5b82173534f465ac77', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ced5ab777f7b440398ea70e4470124de', - ], - 'ApiUid' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '994f72dcdaf04af0b38022c65fdbd1ac', - ], - 'StageName' => [ - 'description' => 'The name of the environment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - 'maxItems' => 500, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OperationId' => [ - 'description' => 'The ID of the operation.'."\n", - 'type' => 'string', - 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisByTrafficControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', - 'title' => 'BatchAbolishApis', + 'translator' => 'manual', ], - 'SwitchApi' => [ - 'summary' => 'Switches the definition of an API in a specified runtime environment to a historical version.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeApisByVpcAccess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', + 'abilityTreeCode' => '94328', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', - ], - ], - [ - 'name' => 'StageName', + 'name' => 'VpcName', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The name of the VPC access authorization.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'lynkco-iov-uat', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The description. The description can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'for_demo', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'HistoryVersion', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The historical version number of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20160705104552292', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '2', 'title' => ''], ], ], 'responses' => [ @@ -14745,102 +9190,140 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', + 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'ApiVpcAccessInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiVpcAccessInfo' => [ + 'description' => 'The returned API information. It is an array consisting of ApiInfo data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => '09839002de484e76b5a213b040a6a3ca', 'title' => ''], + 'VpcId' => ['description' => 'vpc id', 'type' => 'string', 'example' => 'vpc-2ze7bj64wstznvftrskbk', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID or IP address in the VPC access authorization.', 'type' => 'string', 'example' => 'Ib-04e41XXXXXd95e9c1', 'title' => ''], + 'Port' => ['description' => 'The port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'StageId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => '57e17906a69b4424914fb1e05f67c78a', 'title' => ''], + 'VpcName' => ['description' => 'The name of the VPC access authorization.', 'type' => 'string', 'example' => 'aliYun_service_prod', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group to which the API belongs.', 'type' => 'string', 'example' => '41c33748cbfb41f6b00870156203b72a', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group to which the API belongs.', 'type' => 'string', 'example' => 'RT_PLU_IP_CTRL_group', 'title' => ''], + 'Description' => ['description' => 'The description, which can be up to 200 characters in length.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'StageName' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'iwc', 'title' => ''], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/api/v1/friends/rc/status', 'title' => ''], + 'Method' => ['description' => 'The HTTP request method of the API.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB263467-7F5D-5A1B-88E8-06CB0228E0FE\\"\\n}","type":"json"}]', - 'title' => 'SwitchApi', - ], - 'DryRunSwagger' => [ - 'summary' => 'Checks the syntax before Swagger-compliant data is imported.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeApisByVpcAccess', + 'summary' => 'Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApisByVpcAccess'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisByVpcAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries APIs by application and returns the result by environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '94422', - 'abilityTreeNodes' => [ - 'FEATUREapigateway9WMX21', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '191542', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'Overwrite', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to overwrite the existing API.'."\n" - ."\n" - .'APIs with the same HTTP request type and backend request path are considered the same.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2386789'], ], [ - 'name' => 'GlobalCondition', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The global condition.'."\n", - 'type' => 'object', - 'required' => false, - 'docRequired' => true, - 'example' => '{}', - ], + 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'DataFormat', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The Swagger text format:'."\n" - ."\n" - .'* json'."\n" - .'* yaml'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'yaml', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ - 'name' => 'Data', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Swagger text content.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '"A Swagger API definition in YAML"', - ], + 'name' => 'ApiUid', + 'in' => 'query', + 'schema' => ['description' => 'The API ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'b19240592b1b4e74961fb8438ed7550c'], ], [ - 'name' => 'GroupId', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd633cf5524f841b9950e245b191bdabf', - ], + 'schema' => ['description' => 'The API name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ApiName'], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => ['description' => 'The request path of the API.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '/tt'], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => ['description' => 'The request HTTP method of the API.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'POST'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The API description. The description can be up to 200 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -14848,282 +9331,248 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'GlobalCondition' => [ - 'description' => 'The global condition.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], - 'Success' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiDryRunSwaggerSuccess' => [ - 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when the API is created.'."\n", - 'type' => 'string', - 'example' => '/http/get/mapping', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when the API is created.'."\n", - 'type' => 'string', - 'example' => 'get', - ], - 'ApiSwagger' => [ - 'description' => 'The API definition that complies with the Swagger specification.'."\n", - 'type' => 'string', - 'example' => '"A Swagger API definition in YAML"', - ], - 'ApiOperation' => [ - 'description' => 'Specifies whether the operation is CREATE or MODIFY.'."\n", - 'type' => 'string', - 'example' => 'CREATE', - ], - 'ApiUid' => [ - 'description' => 'The UID of the successfully imported API.'."\n", - 'type' => 'string', - 'example' => '8e274ec61cf6468e83b68371956831cb', - ], - ], - ], - ], - ], - ], - 'Failed' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportSwaggerFailed' => [ - 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => 'The request path configured when the API is created.'."\n", - 'type' => 'string', - 'example' => '/http/get/mapping', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method configured when the API is created.'."\n", - 'type' => 'string', - 'example' => 'post', - ], - 'ErrorMsg' => [ - 'description' => 'The error message returned when the API is created.'."\n", - 'type' => 'string', - 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'ModelFailed' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'AppApiRelationInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiImportModelFailed' => [ - 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.'."\n", + 'AppApiRelationInfo' => [ + 'description' => 'The authorization information of the API.', 'type' => 'array', 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Not Found', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'Region', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '36d4bcfaec1946e1870d90b2d7519710', - ], - ], 'description' => '', - ], - ], - ], - ], - 'ModelSuccess' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiImportModelSuccess' => [ - 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.'."\n", - 'type' => 'array', - 'items' => [ 'type' => 'object', 'properties' => [ - 'ModelUid' => [ - 'description' => 'The UID of the model.'."\n", - 'type' => 'string', - 'example' => 'ec1946e1870d90b2d7519', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'NewInstance', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => 'b2d552ed90ca435b86f7bf8d45414793', - ], - 'ModelOperation' => [ - 'description' => 'The model operation.'."\n", - 'type' => 'string', - 'example' => 'CREATE', + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'title' => '', 'example' => 'c625795a1e664782a918eaa629e96ab5'], + 'AuthorizationSource' => ['description' => 'The authorization source.', 'type' => 'string', 'title' => '', 'example' => 'SELF'], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'title' => '', 'example' => 'b1008kz'], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'title' => '', 'example' => 'manager_vehicles'], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'title' => '', 'example' => '38bed48d664149e4b9b5ea576319673f'], + 'Operator' => ['description' => 'The authorizer. Valid values:'."\n" + ."\n" + .'- **PROVIDER:** the API owner'."\n" + ."\n" + .'- **CONSUMER:** the API caller', 'type' => 'string', 'example' => 'PROVIDER', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the authorization was created.', 'type' => 'string', 'title' => '', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT'], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'title' => '', 'example' => 'sd2_h5_player_history_competition'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai'], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'title' => '', 'example' => '/api/offline/cacheData'], + 'Method' => ['description' => 'The request HTTP method of the API.', 'type' => 'string', 'title' => '', 'example' => 'POST'], + 'StageNameAndAuth' => [ + 'description' => 'The mapping information between environments and authorizations.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The environment name.', 'type' => 'string', 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DryRunSwagger', + 'title' => 'DescribeApisWithStageNameIntegratedByApp', + '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' => 'All Resource', '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"}]', ], - 'CreateApp' => [ - 'summary' => 'Creates an app for API Gateway.', - 'methods' => [ - 'post', - 'get', + 'DescribeApp' => [ + 'summary' => 'This operation queries the list of Apps available for authorization and fetches App information for developers during authorization operations.', + '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' => 'The App ID. The system generates this globally unique ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '110843374', 'title' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'App name', 'type' => 'string', 'example' => 'CreateApptest', 'title' => ''], + 'RequestId' => ['description' => 'The ID of this request.', 'type' => 'string', 'example' => 'DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB', 'title' => ''], + 'ModifiedTime' => ['description' => 'App modification time', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z', 'title' => ''], + 'Description' => ['description' => 'App description', 'type' => 'string', 'example' => 'Estimated on October 15, 2021 at 10:20:27', 'title' => ''], + 'AppId' => ['description' => 'The unique ID of the App', 'type' => 'integer', 'format' => 'int64', 'example' => '110843374', 'title' => ''], + 'CreatedTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2019-01-29T09:33:01Z', 'title' => ''], + 'Extend' => ['description' => 'Extension information', 'type' => 'string', 'example' => '110243810311', 'title' => ''], + 'Disabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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\\": false\\n}","type":"json"}]', + 'title' => 'DescribeApp', + '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}'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeAppAttributes' => [ + 'summary' => 'Query the list of applications and their basic information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIX31M', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94336', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278', 'title' => ''], + ], + [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application. The name must be 4 to 26 characters in length. The name can contain letters, digits, and underscores (\\_), and must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CreateAppTest', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'example' => 'testApp', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the application. The description can be up to 180 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Specify the page number to query. The default value is 1, and the starting value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'Valid values of n: `[1, 20]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'Valid values of n: `[1, 20]`. If the parameter has a value, you must specify a value for the tag key with the same N as tag.N.Key. Otherwise, an error is reported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\' \'', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 500, - ], + 'schema' => ['description' => 'Specify the number of rows per page for paged query. The maximum value is 100, and the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => ['description' => 'The AppCode encoding of the application.', 'type' => 'string', 'required' => false, 'example' => '23552160', 'title' => ''], ], [ 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The key of the application that is used to make an API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60030986', - ], + 'schema' => ['description' => 'The application key, used when calling APIs.', 'type' => 'string', 'required' => false, 'example' => '203708622', 'title' => ''], ], [ - 'name' => 'AppSecret', + 'name' => 'Sort', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'nzyNqFkRWB2uLw86', - ], + 'schema' => ['description' => 'Sort order. The default value is desc. Options are asc and desc.'."\n" + ."\n" + .'- asc: Sort by modification time in ascending order.'."\n" + ."\n" + .'- desc: Sort by modification time in descending order.', 'type' => 'string', 'required' => false, 'default' => 'desc', 'example' => 'desc', 'title' => ''], ], [ - 'name' => 'AppCode', + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => ['description' => 'Enable tag validation.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The AppCode of the application.'."\n", - 'type' => 'string', + 'description' => 'Specify object tags that apply to the rule. You can set multiple tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Specify object tags that apply to the rule. You can set multiple tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag value.'."\n" + ."\n" + .'The value range of n is `[1, 20]`', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag key.'."\n" + ."\n" + .'The value range of n is `[1, 20]`', 'type' => 'string', 'required' => false, 'example' => '\' \'', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + 'example' => 'Key, Value', + 'maxItems' => 20, + 'title' => '', ], ], [ 'name' => 'Extend', 'in' => 'query', - 'schema' => [ - 'description' => 'The extended information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110210264071', - ], + 'schema' => ['description' => 'Extension information.', 'type' => 'string', 'required' => false, 'example' => '110243810311', 'title' => ''], ], ], 'responses' => [ @@ -15131,101 +9580,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TagStatus' => [ - 'description' => 'Indicates whether the tag exists. If the value is **true**, the tag exists. If the value is **false**, the tag does not exist.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550', - ], - 'AppId' => [ - 'description' => 'The unique ID of the application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20112314518278', + 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F', 'title' => ''], + 'PageSize' => ['description' => 'The returned number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries in the returned result.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Apps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppAttribute' => [ + 'description' => 'An array of AppAttribute objects that returns application information.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'CreateApptest', 'title' => ''], + 'ModifiedTime' => ['description' => 'Modification time (Greenwich Mean Time).', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z', 'title' => ''], + 'Description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => 'App test', 'title' => ''], + 'CreatedTime' => ['description' => 'Creation time (Greenwich Mean Time).', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278', 'title' => ''], + 'Extend' => ['description' => 'Extension information.', 'type' => 'string', 'example' => '110461946884', 'title' => ''], + 'Disabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagInfo' => [ + 'description' => 'List of tags.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'appid', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TagStatus\\": false,\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\",\\n \\"AppId\\": 20112314518278\\n}","errorExample":""},{"type":"xml","example":"<CreateAppResponse>\\r\\n <AppId>20112314518278</AppId> \\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n</CreateAppResponse>","errorExample":""}]', - 'title' => 'CreateApp', - 'description' => '* This operation is intended for API callers.'."\n" - .'* Each application has a key-value pair which is used for identity verification when you call an API.'."\n" - .'* An application must be authorized to call an API.'."\n" - .'* Each application has only one key-value pair, which can be reset if the pair is leaked.'."\n" - .'* A maximum of 1,000 applications can be created for each Alibaba Cloud account.'."\n" - .'* You can call this operation up to 50 times per second per account.'."\n", + 'title' => 'DescribeAppAttributes', + 'description' => '- This feature is intended for users who call APIs.'."\n" + ."\n" + .'- The AppId parameter is optional.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteApp' => [ - 'summary' => 'Deletes a specified app.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppAttributes'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppAttributes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": false,\\n \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"appid\\",\\n \\"Value\\": \\"123\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAppSecurities' => [ + 'summary' => 'Queries the key-related information of an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110840611', - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags. Up to 20 tags are allowed.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'appname', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testapp', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'example' => 'test2', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110862931', 'title' => ''], ], ], 'responses' => [ @@ -15233,137 +9698,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], + 'AppSecuritys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppSecurity' => [ + 'description' => 'The associated security policy information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppSecret' => ['description' => 'The application AppSecret.', 'type' => 'string', 'example' => 'ea5291a7aff343769eb3139a2f6de8c9', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the AppSecret was last modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-08-14T18:03:00+08:00', 'title' => ''], + 'AppKey' => ['description' => 'The application AppKey.', 'type' => 'string', 'example' => '34379343', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the AppKey was created.', 'type' => 'string', 'example' => '2021-09-14T18:50:59', 'title' => ''], + 'AppCode' => ['description' => 'The application AppCode.', 'type' => 'string', 'example' => 'd2350ecd62c44cbfbe35a7f182e35105', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAppResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n</DeleteAppResponse>","errorExample":""}]', - 'title' => 'DeleteApp', - 'description' => '* This operation is intended for API callers.'."\n" - .'* After an application is deleted, the application and its API authorization cannot be restored.'."\n" - .'* You can call this operation up to 50 times per second per account.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyApp' => [ - 'summary' => 'Modifies a specified app.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeAppSecurities', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppSecurities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'This key is used for authentication when an API call is made.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94436', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94339', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20112314518278', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The value must be 4 to 26 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.'."\n" - ."\n" - .'This parameter is required only when you want to modify the value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jiedian_pord', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the app. The description can contain a maximum of 180 characters in length.'."\n" - ."\n" - .'This parameter is required only when you want to modify the value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'modidyTest', - ], + 'schema' => ['description' => 'The ID of the app.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20112314518278', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => true, 'example' => 'app', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], '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', + 'title' => '', ], ], ], @@ -15372,35 +9808,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], + 'AppSecret' => ['description' => 'The password of the app.', 'type' => 'string', 'example' => 'c1ae97aaa7e45f21d10824bc44678fee', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'AppKey' => ['description' => 'The key of the app.', 'type' => 'string', 'example' => '60030986', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time (UTC) of the key.', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z', 'title' => ''], + 'AppCode' => ['description' => 'The AppCode of the app.', 'type' => 'string', 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time (UTC) of the key, which is the same as the app creation time.', 'type' => 'string', 'example' => '2016-07-31T04:10:19Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAppResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n</ModifyAppResponse>","errorExample":""}]', - 'title' => 'ModifyApp', - 'description' => '* This operation is intended for API callers.'."\n" - .'* AppName or Description can be modified. If these parameters are not specified, no modifications are made and the operation will directly return a successful response.********'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'title' => 'DescribeAppSecurity', + 'description' => '- This operation is intended for API callers.', + '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeApps' => [ 'summary' => 'Queries the apps of a user. App information is returned only to the app owner.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15410,59 +9858,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94337', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20112314518278', - ], + 'schema' => ['description' => 'The ID of the app.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278', 'title' => ''], ], [ 'name' => 'AppOwner', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account of the app owner. For more information, see [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3a8c196eVWxvQB#/secure).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1546564', - ], + 'schema' => ['description' => 'The Alibaba Cloud account of the app owner. For more information, see [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3a8c196eVWxvQB#/secure).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1546564', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -15470,85 +9887,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Apps' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AppItem' => [ - 'description' => 'The returned app information. It is an array consisting of AppItem data.'."\n", + 'description' => 'The returned app information. It is an array consisting of AppItem data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the app.'."\n", - 'type' => 'string', - 'example' => 'CreateApptest', - ], - 'Description' => [ - 'description' => 'The description of the app.'."\n", - 'type' => 'string', - 'example' => 'App test', - ], - 'AppId' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20112314518278', - ], + 'AppName' => ['description' => 'The name of the app.', 'type' => 'string', 'example' => 'CreateApptest', 'title' => ''], + 'Description' => ['description' => 'The description of the app.', 'type' => 'string', 'example' => 'App test', 'title' => ''], + 'AppId' => ['description' => 'The ID of the app.', 'type' => 'integer', 'format' => 'int64', 'example' => '20112314518278', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeAppsResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <Apps>\\r\\n <AppItem>\\r\\n <AppId>20112314518278</AppId>\\r\\n <AppName>CreateApptest</AppName>\\r\\n <Description>App test</Description>\\r\\n </AppItem>\\r\\n </Apps>\\r\\n</DescribeAppsResponse> ","errorExample":""}]', 'title' => 'DescribeApps', - 'description' => '* This API is intended for API providers.'."\n" - .'* API providers can use the app IDs or their Alibaba Cloud accounts to query app information.'."\n" - .'* Each provider can call this operation for a maximum of 200 times every day in a region.'."\n", + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- API providers can use the app IDs or their Alibaba Cloud accounts to query app information.'."\n" + ."\n" + .'- Each provider can call this operation for a maximum of 200 times every day in a region.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAppAttributes' => [ - 'summary' => 'Queries apps and their basic information.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeApps'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeAppsByApiProduct' => [ + 'summary' => 'Queries authorized applications by API product.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15556,152 +9966,128 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94336', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20112314518278', - ], - ], - [ - 'name' => 'AppName', + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the app.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AppCode', + 'name' => 'AppName', 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'testApp', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The AppCode of the app.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23552160', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AC866798-62D3-52F4-8AB5-CA149A53984F', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'AuthorizedApps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AuthorizedApp' => [ + 'description' => 'The information about authorized applications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'APP_02580_DEV', 'title' => ''], + 'Description' => ['description' => 'The authorization description.', 'type' => 'string', 'example' => 'Authorization description', 'title' => ''], + 'AuthValidTime' => ['description' => 'The expiration time of the authorization. The time is in GMT. An empty value indicates that the authorization does not expire.', 'type' => 'string', 'example' => '2023-06-17T03:41:53Z', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '110982419', 'title' => ''], + 'Extend' => ['description' => 'The extended information.', 'type' => 'string', 'example' => 'extra info', 'title' => ''], + 'AuthorizedTime' => ['description' => 'The time when the authorization was created. The time is in GMT.', 'type' => 'string', 'example' => '2016-07-21T06:17:20Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'DescribeAppsByApiProduct', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAppsByApiProduct'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'AppKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The app key that is used to make an API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '203708622', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppsByApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'DescribeAuthorizedApis' => [ + 'summary' => 'Queries the authorized APIs of a specified APP.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Sort', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order. Valid values: asc and desc. Default value: desc.'."\n" - ."\n" - .'* asc: The apps are displayed in ascending order of modification time.'."\n" - .'* desc: The apps are displayed in descending order of modification time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - 'default' => 'desc', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94342', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], + ], + 'parameters' => [ [ - 'name' => 'EnableTagAuth', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable tag verification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The application ID, which is generated by the system and globally unique.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\' \'', - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Extend', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '扩展信息', - 'type' => 'string', - 'required' => false, - 'example' => '110243810311', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -15709,128 +10095,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Apps' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'AuthorizedApis' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AppAttribute' => [ - 'description' => 'The returned app information. It is an array that consists of AppAttribute data.'."\n", + 'AuthorizedApi' => [ + 'description' => 'The authorized API set.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the app.'."\n", - 'type' => 'string', - 'example' => 'CreateApptest', - ], - 'ModifiedTime' => [ - 'description' => 'The modification time (UTC) of the app.'."\n", - 'type' => 'string', - 'example' => '2016-07-31T04:10:19Z', - ], - 'Description' => [ - 'description' => 'The description of the app.'."\n", - 'type' => 'string', - 'example' => 'App test', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the app.'."\n", - 'type' => 'string', - 'example' => '2016-07-31T04:10:19Z', - ], - 'AppId' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20112314518278', - ], - 'Extend' => [ - 'description' => '扩展信息', - 'type' => 'string', - 'example' => '110461946884', - ], - 'Disabled' => [ - 'type' => 'boolean', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagInfo' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'appid', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'ApiId' => ['description' => 'The unique identifier of the API, which is automatically generated by the system.', 'type' => 'string', 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', 'title' => ''], + 'AuthorizationSource' => ['description' => 'The authorization source. Valid values:'."\n" + ."\n" + .'- **CONSOLE**'."\n" + ."\n" + .'- **API**', 'type' => 'string', 'example' => 'CONSOLE', 'title' => ''], + 'AuthVaildTime' => ['description' => 'The expiration time of the authorization in UTC.', 'type' => 'string', 'example' => '2018-10-05T16:00:00Z', 'title' => ''], + 'Description' => ['description' => 'Authorization description', 'type' => 'string', 'example' => 'Query weather by region name', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'Weather', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], + 'AuthorizedTime' => ['description' => 'The authorization time in UTC.', 'type' => 'string', 'example' => '2016-07-21T06:17:20', 'title' => ''], + 'Operator' => ['description' => 'The authorizer. Valid values:'."\n" + ."\n" + .'- **PROVIDER:** API owner'."\n" + ."\n" + .'- **CONSUMER:** API caller', 'type' => 'string', 'example' => 'PROVIDER', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API', 'type' => 'string', 'example' => 'AreaWeather', 'title' => ''], + 'RegionId' => ['description' => 'The region to which the API belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeAppAttributesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <Apps>\\r\\n <AppAttribute>\\r\\n <AppId>20112314518278</AppId>\\r\\n <AppName>CreateApptest</AppName>\\r\\n <Description>App test</Description>\\r\\n <CreatedTime>2016-07-31T04:10:19Z</CreatedTime>\\r\\n <ModifiedTime>2016-07-31T04:10:19Z</ModifiedTime>\\r\\n </AppAttribute>\\r\\n </Apps>\\r\\n</DescribeAppAttributesResponse> ","errorExample":""}]', - 'title' => 'DescribeAppAttributes', - 'description' => '* This operation is intended for API callers.'."\n" - .'* AppId is optional.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeAuthorizedApis', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- The specified application can call all APIs included in the responses.', '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}'], + ], + ], + ], + ], + 'translator' => 'manual', ], 'DescribeAuthorizedApps' => [ 'summary' => 'Queries the current apps.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15840,21 +10195,13 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94343', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ 'name' => 'StageName', @@ -15862,81 +10209,47 @@ 'schema' => [ 'description' => 'The environment. Valid values:'."\n" ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', + 'enumValueTitles' => ['RELEASE' => 'RELEASE'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'RELEASE' => 'RELEASE', - ], 'example' => 'RELEASE', + 'title' => '', ], ], [ 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', - ], + 'schema' => ['description' => 'The ID of the API. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20112314518278', - ], + 'schema' => ['description' => 'The ID of the app.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20112314518278', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the app.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateApptest', - ], + 'schema' => ['description' => 'The name of the app.', 'type' => 'string', 'required' => false, 'example' => 'CreateApptest', 'title' => ''], ], [ 'name' => 'AppOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account of the app owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1546564', - ], + 'schema' => ['description' => 'The Alibaba Cloud account of the app owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1546564', 'title' => ''], ], ], 'responses' => [ @@ -15944,299 +10257,417 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'AuthorizedApps' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AuthorizedApp' => [ - 'description' => 'The authorized applications.'."\n", + 'description' => 'The authorized applications.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'Weather'."\n", - ], - 'AuthorizationSource' => [ - 'description' => 'The authorization source. Valid values:'."\n" - ."\n" - .'* **CONSOLE**'."\n" - .'* **API**'."\n", - 'type' => 'string', - 'example' => 'CONSOLE', - ], - 'AuthVaildTime' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => '2018-10-05T16:00:00Z', - ], - 'Description' => [ - 'description' => 'The authorization description.'."\n", - 'type' => 'string', - 'example' => 'Queries weather based on the region name'."\n", - ], - 'AuthorizedTime' => [ - 'description' => 'The authorization time (UTC).'."\n", - 'type' => 'string', - 'example' => '2016-07-21T06:17:20Z', - ], - 'AppId' => [ - 'description' => 'The application ID, which is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2386789', - ], - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'StageAlias' => [ - 'description' => 'The environment alias.'."\n", - 'type' => 'string', - 'example' => 'Production'."\n", - ], - 'Operator' => [ - 'description' => 'The authorizer. Valid values:'."\n" - ."\n" - .'* **PROVIDER**: API owner'."\n" - .'* **CONSUMER**: API caller'."\n", - 'type' => 'string', - 'example' => 'PROVIDER', - ], - 'AppDescription' => [ - 'description' => 'The application description.'."\n", - 'type' => 'string', - 'example' => 'Production application'."\n", - ], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'Weather', 'title' => ''], + 'AuthorizationSource' => ['description' => 'The authorization source. Valid values:'."\n" + ."\n" + .'- **CONSOLE**'."\n" + ."\n" + .'- **API**', 'type' => 'string', 'example' => 'CONSOLE', 'title' => ''], + 'AuthVaildTime' => ['description' => 'The application name.', 'type' => 'string', 'example' => '2018-10-05T16:00:00Z', 'title' => ''], + 'Description' => ['description' => 'The authorization description.', 'type' => 'string', 'example' => 'Query weather by region name', 'title' => ''], + 'AuthorizedTime' => ['description' => 'The authorization time (UTC).', 'type' => 'string', 'example' => '2016-07-21T06:17:20Z', 'title' => ''], + 'AppId' => ['description' => 'The application ID, which is generated by the system and globally unique.', 'type' => 'integer', 'format' => 'int64', 'example' => '2386789', 'title' => ''], + 'StageName' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'StageAlias' => ['description' => 'The environment alias.', 'type' => 'string', 'example' => 'Production', 'title' => ''], + 'Operator' => ['description' => 'The authorizer. Valid values:'."\n" + ."\n" + .'- **PROVIDER**: API owner'."\n" + ."\n" + .'- **CONSUMER**: API caller', 'type' => 'string', 'example' => 'PROVIDER', 'title' => ''], + 'AppDescription' => ['description' => 'The application description.', 'type' => 'string', 'example' => 'Production application', 'title' => ''], 'Tag' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagInfo' => [ - 'description' => 'The key of the tag.'."\n", + 'description' => 'The key of the tag.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'example' => 'DEV', - ], - 'Value' => [ - 'description' => 'The tag value.', - 'type' => 'string', - 'example' => '240', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'DEV', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '240', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"天气\\",\\n \\"AuthorizationSource\\": \\"CONSOLE\\",\\n \\"AuthVaildTime\\": \\"2018-10-05T16:00:00Z\\",\\n \\"Description\\": \\"根据地区名称查询天气情况\\",\\n \\"AuthorizedTime\\": \\"2016-07-21T06:17:20Z\\",\\n \\"AppId\\": 2386789,\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"线上\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"AppDescription\\": \\"生产应用\\",\\n \\"Tag\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"DEV\\",\\n \\"Value\\": \\"240\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAuthorizedAppsResponse>\\r\\n <TotalCount>2</TotalCount>\\r\\n <PageNumber>1</PageNumber>\\r\\n <PageSize>10</PageSize>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n <AuthorizedApps>\\r\\n <AuthorizedApp>\\r\\n <StageName>RELEASE</StageName>\\r\\n <AppId>2386789</AppId>\\r\\n <AppName>天气app</AppName>\\r\\n <Operator>PROVIDER</Operator>\\r\\n <AuthorizationSource>CONSOLE</AuthorizationSource>\\r\\n <Description>根据地区名称查询天气情况</Description>\\r\\n <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>\\r\\n <AuthVaildTime>2018-10-05T16:00:00Z</AuthVaildTime> \\r\\n </AuthorizedApp>\\r\\n <AuthorizedApp>\\r\\n <StageName>TEST</StageName>\\r\\n <AppId>2386789</AppId>\\r\\n <AppName>天气app</AppName>\\r\\n <Operator>CONSUMER</Operator>\\r\\n <AuthorizationSource>API</AuthorizationSource>\\r\\n <Description>根据地区名称查询天气情况</Description>\\r\\n <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>\\r\\n <AuthVaildTime></AuthVaildTime>\\r\\n </AuthorizedApp>\\r\\n </AuthorizedApps> \\r\\n</DescribeAuthorizedAppsResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeAuthorizedApps', - 'description' => '* This operation is intended for API providers.'."\n" - .'* All applications included in the responses have access to the specified API.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApp' => [ - 'summary' => 'Queries the apps that can be authorized.', - 'methods' => [ - 'post', - 'get', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- All applications included in the responses have access to the specified API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuthorizedApps'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAuthorizedApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'extraInfo' => ' ', + 'translator' => 'manual', + ], + 'DescribeBackendInfo' => [ + 'summary' => 'Query backend service information and the backend addresses configured in each environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94335', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeCode' => '115431', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app. The ID is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '110843374', - ], + 'schema' => ['description' => 'Backend service ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '739b68751c0b4e899e04d0c92b6d0be7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the app.'."\n", - 'type' => 'string', - 'example' => 'CreateApptest', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the app was modified.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T09:33:01Z', - ], - 'Description' => [ - 'description' => 'The description of the app.'."\n", - 'type' => 'string', - 'example' => 'Estimated on October 15, 2021 at 10:20:27'."\n", - ], - 'AppId' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110843374', - ], - 'CreatedTime' => [ - 'description' => 'The time when the app was created.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T09:33:01Z', - ], - 'Extend' => [ - 'description' => '扩展信息', - 'type' => 'string', - 'example' => '110243810311', - ], - 'Disabled' => [ - 'type' => 'boolean', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231', 'title' => ''], + 'BackendInfo' => [ + 'description' => 'Backend service information.', + 'type' => 'object', + 'properties' => [ + 'BackendName' => ['description' => 'Backend service name.', 'type' => 'string', 'example' => 'testoss2', 'title' => ''], + 'BackendType' => ['description' => 'Backend service type.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ModifiedTime' => ['description' => 'Backend service modification time.', 'type' => 'string', 'example' => '2017-12-11T15:18:09+08:00', 'title' => ''], + 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'CreatedTime' => ['description' => 'Backend service creation time.', 'type' => 'string', 'example' => '2021-11-22T11:10:46+08:00', 'title' => ''], + 'BackendId' => ['description' => 'Backend service ID.', 'type' => 'string', 'example' => '6fc978bb63574146b766863dd7bdf661', 'title' => ''], + 'BackendModels' => [ + 'description' => 'Backend service configuration information in environments.', + 'type' => 'array', + 'items' => [ + 'description' => 'Backend service configuration information in environments.', + 'type' => 'object', + 'properties' => [ + 'BackendModelId' => ['description' => 'Backend service configuration ID in environments.', 'type' => 'string', 'example' => '5c4995d08e8b4954b0f326e8e4f2b97d', 'title' => ''], + 'StageModeId' => ['description' => 'Environment ID.', 'type' => 'string', 'example' => '6fc978bb63574146b766863dd7bdf661', 'title' => ''], + 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'testDvs 1', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2021-12-20T03:22:03.000+0000', 'title' => ''], + 'GmtModified' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2021-12-20T03:22:03.000+0000', 'title' => ''], + 'StageName' => ['description' => 'Environment name.', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'BackendConfig' => [ + 'description' => 'Backend configuration.', + 'type' => 'object', + 'properties' => [ + 'ServiceAddress' => ['description' => 'Backend service endpoint.', 'type' => 'string', 'example' => '10.0.0.1', 'title' => ''], + 'HttpTargetHostName' => ['description' => 'Host of the HTTP backend service.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Type' => ['description' => 'Backend service type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'VpcConfig' => [ + 'description' => 'VPC backend information.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-wz9v96hqi6d14744sxqmx', 'title' => ''], + 'InstanceId' => ['description' => 'Instance ID (ECS/SLB) in the VPC.', 'type' => 'string', 'example' => 'i-uf6iaale3gfef9t9cb41', 'title' => ''], + 'Port' => ['description' => 'Port number of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', 'title' => ''], + 'VpcAccessId' => ['description' => 'VPC authorization ID.', 'type' => 'string', 'example' => '2zej3ehuzg9m77kvwnfpn', 'title' => ''], + 'Name' => ['description' => 'VPC configuration name.', 'type' => 'string', 'example' => 'dypls-cn-beijing-slb-pre', 'title' => ''], + 'VpcScheme' => ['description' => 'HTTP/HTTPS protocol.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'VpcTargetHostName' => ['description' => 'Host of the VPC backend service.', 'type' => 'string', 'example' => 'openapi.alipan.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FunctionComputeConfig' => [ + 'description' => 'Function Compute backend information.', + 'type' => 'object', + 'properties' => [ + 'FcType' => ['description' => 'Function Compute service type.', 'type' => 'string', 'example' => 'HttpTrigger', 'title' => ''], + 'FcRegionId' => ['description' => 'Region ID of the Function Compute service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ServiceName' => ['description' => 'ServiceName defined in Function Compute.', 'type' => 'string', 'example' => 'myservice', 'title' => ''], + 'FunctionName' => ['description' => 'FunctionName defined in Function Compute.', 'type' => 'string', 'example' => 'edge_function', 'title' => ''], + 'RoleArn' => ['description' => 'RAM role ARN that grants API Gateway permission to access Function Compute.', 'type' => 'string', 'example' => 'acs:ram::31985*:role/aliyunserviceroleforbastionhostpam', 'title' => ''], + 'Qualifier' => ['description' => 'Function alias.', 'type' => 'string', 'example' => 'testQualifier', 'title' => ''], + 'FcBaseUrl' => ['description' => 'Root path of the Function Compute service.', 'type' => 'string', 'example' => 'https://t*******.ap-*****.fcapp.run/', 'title' => ''], + 'OnlyBusinessPath' => ['description' => 'The backend only accepts business paths.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TriggerName' => ['description' => 'The name of the trigger.'."\n" + ."\n" + .'You can specify the TriggerName or TriggerUrl parameter. The TriggerName parameter is optional.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'OssConfig' => [ + 'description' => 'OSS backend information.', + 'type' => 'object', + 'properties' => [ + 'OssRegionId' => ['description' => 'Region ID of the OSS service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'BucketName' => ['description' => 'OSS bucket name.', 'type' => 'string', 'example' => 'my_bucket', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EventBridgeConfig' => [ + 'description' => 'EventBridge backend configuration.', + 'type' => 'object', + 'properties' => [ + 'EventBridgeRegionId' => ['description' => 'Region ID of the EventBridge service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'EventSource' => ['description' => 'Event source.', 'type' => 'string', 'example' => 'dds_driver', 'title' => ''], + 'EventBus' => ['description' => 'Event bus.', 'type' => 'string', 'example' => 'testBus', 'title' => ''], + 'RoleArn' => ['description' => 'RAM role ARN that grants EventBridge permission.', 'type' => 'string', 'example' => 'acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'MockConfig' => [ + 'description' => 'Mock configuration information.', + 'type' => 'object', + 'properties' => [ + 'MockResult' => ['description' => 'Mock return result.', 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + 'MockStatusCode' => ['description' => 'Mock return status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'MockHeaders' => [ + 'description' => 'Mock return headers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Mock information.', + 'type' => 'object', + 'properties' => [ + 'HeaderName' => ['description' => 'Header parameter name.', 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + 'HeaderValue' => ['description' => 'Corresponding parameter value.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'DiscoveryConfig' => [ + 'description' => 'Configuration information for service discovery backend.', + 'type' => 'object', + 'properties' => [ + 'RcType' => ['description' => 'Registry type.', 'type' => 'string', 'example' => 'NACOS', 'title' => ''], + 'NacosConfig' => [ + 'description' => 'Nacos configuration information.', + 'type' => 'object', + 'properties' => [ + 'ServerAddress' => ['description' => 'Nacos service endpoint.', 'type' => 'string', 'example' => 'http://1xx.2xx.3xx.4xx:8848', 'title' => ''], + 'Namespace' => ['description' => 'Namespace ID of the microservice registered in Nacos.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'GroupName' => ['description' => 'Group name of the microservice registered in Nacos.', 'type' => 'string', 'example' => 'DEFAULT_GROUP', 'title' => ''], + 'ServiceName' => ['description' => 'Microservice name.', 'type' => 'string', 'example' => 'service-provider', 'title' => ''], + 'Clusters' => ['description' => 'Cluster name where the microservice resides.', 'type' => 'string', 'example' => 'cluster1', 'title' => ''], + 'AuthType' => ['description' => 'Authentication method.', 'type' => 'string', 'example' => 'PASSWORD', 'title' => ''], + 'UserName' => ['description' => 'Username.', 'type' => 'string', 'example' => 'username', 'title' => ''], + 'Password' => ['description' => 'Password.', 'type' => 'string', 'example' => 'password', 'title' => ''], + 'AccessKey' => ['description' => 'AccessKey of the RAM user with MSE Resource Management permissions.', 'type' => 'string', 'example' => 'A5FIDxxxxxx', 'title' => ''], + 'SecretKey' => ['description' => 'SecretKey of the RAM user with MSE Resource Management permissions.', 'type' => 'string', 'example' => 'dl5loxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ZookeeperConfig' => [ + 'description' => 'Zookeeper configuration information.', + 'type' => 'object', + 'properties' => [ + 'ConnectString' => ['description' => 'Zookeeper server connection address.', 'type' => 'string', 'example' => 'http://192.168.1.xxx:2181', 'title' => ''], + 'Namespace' => ['description' => 'Namespace.', 'type' => 'string', 'example' => 'provider', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'service', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ServiceTimeout' => ['description' => 'Backend service timeout period in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'EdasConfig' => [ + 'description' => 'EDAS configuration information.', + 'type' => 'object', + 'properties' => [ + 'MicroserviceNamespaceName' => ['description' => 'EDAS microservice namespace name.', 'type' => 'string', 'example' => 'Edas-Nacos', 'title' => ''], + 'MicroserviceNamespaceId' => ['description' => 'EDAS microservice namespace ID.', 'type' => 'string', 'example' => 'cn-hangzhou:edasNacos', 'title' => ''], + 'MicroserviceNamespace' => ['description' => 'EDAS microservice namespace ID.', 'type' => 'string', 'example' => 'cn-hangzhou:edasNacos'."\n", 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'service', 'title' => ''], + 'EdasAppId' => ['description' => 'EDAS application ID.', 'type' => 'string', 'example' => '6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx', 'title' => ''], + 'RegistryType' => ['description' => 'Registry type.', 'type' => 'string', 'example' => 'EDAS', 'title' => ''], + 'MseInstanceId' => ['description' => 'MSE registry instance ID.', 'type' => 'string', 'example' => 'mse-cn-jia3n1rxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppName\\": \\"CreateApptest\\",\\n \\"RequestId\\": \\"DBDB3B0F-EC61-5F33-88AD-EC2446FA1DDB\\",\\n \\"ModifiedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"Description\\": \\"2021年10月15日10:20:27测算\\",\\n \\"AppId\\": 110843374,\\n \\"CreatedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"Extend\\": \\"110243810311\\",\\n \\"Disabled\\": true\\n}","type":"json"}]', - 'title' => 'DescribeApp', - ], - 'DescribeAppSecurity' => [ - 'summary' => 'This key is used for authentication when an API call is made.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeBackendInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendInfo'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeBackendInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries backend services. You can filter backend services by backend service name and backend service type.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94339', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'abilityTreeCode' => '114857', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'BackendName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20112314518278', - ], + 'schema' => ['description' => 'The name of the backend service. You can use \\* to perform fuzzy queries.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the backend service.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The list of the tag.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 20, + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -16245,88 +10676,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AppSecret' => [ - 'description' => 'The password of the app.'."\n", - 'type' => 'string', - 'example' => 'c1ae97aaa7e45f21d10824bc44678fee', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'AppKey' => [ - 'description' => 'The key of the app.'."\n", - 'type' => 'string', - 'example' => '60030986', - ], - 'ModifiedTime' => [ - 'description' => 'The modification time (UTC) of the key.'."\n", - 'type' => 'string', - 'example' => '2016-07-31T04:10:19Z', - ], - 'AppCode' => [ - 'description' => 'The AppCode of the app.'."\n", - 'type' => 'string', - 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the key, which is the same as the app creation time.', - 'type' => 'string', - 'example' => '2016-07-31T04:10:19Z', + 'PageNumber' => ['description' => 'The number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '090A0DF9-9144-5236-8CBA-E18DE317722D', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BackendInfoList' => [ + 'description' => 'The backend services.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BackendName' => ['description' => 'The name of the backend service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'BackendType' => ['description' => 'The type of the backend service.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the backend service was modified.', 'type' => 'string', 'example' => '2022-01-25T11:22:29Z', 'title' => ''], + 'Description' => ['description' => 'The description of the backend service.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the backend service was created.', 'type' => 'string', 'example' => '2022-01-25T11:22:29Z', 'title' => ''], + 'BackendId' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'example' => '35bd31d32c9c425ebbe9330db9f8c375', 'title' => ''], + 'Tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => 'groupName', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeAppSecurityResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n <AppKey>60030986</AppKey>\\r\\n <AppSecret>c1ae97aaa7e45f21d10824bc44678fee</AppSecret>\\r\\n <CreatedTime>2016-07-31T04:10:19Z</CreatedTime>\\r\\n <ModifiedTime>2016-07-31T04:10:19Z</ModifiedTime>\\r\\n</DescribeAppSecurityResponse>","errorExample":""}]', - 'title' => 'DescribeAppSecurity', - 'description' => '* This operation is intended for API callers.'."\n", - ], - 'ResetAppCode' => [ - 'summary' => 'Resets the AppCode of an application. You can call this operation only once per minute.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeBackendList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeBackendList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Returns information about a single dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94471', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155066', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'AppCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The AppCode of the app.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', - ], - ], - [ - 'name' => 'NewAppCode', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new AppCode of the app.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6f0e7ab2aa5f4b8fb18421e6edf4fb6c2', - ], + 'schema' => ['description' => 'Dataset ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********', 'title' => ''], ], ], 'responses' => [ @@ -16334,82 +10776,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'A2C8F75E-EE84-5C64-960F-45C8********', 'title' => ''], + 'DatasetInfo' => [ + 'description' => 'Dataset information', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'Dataset ID', 'type' => 'string', 'example' => '62b91a790a693238********', 'title' => ''], + 'DatasetName' => ['description' => 'Dataset name', 'type' => 'string', 'example' => 'DatasetName', 'title' => ''], + 'DatasetType' => ['description' => 'Dataset type. Valid values:'."\n" + ."\n" + .'- JWT\\_BLOCKING: JWT blacklist'."\n" + ."\n" + .'- IP\\_WHITELIST\\_CIDR: IP address whitelist'."\n" + ."\n" + .'- PARAMETER\\_ACCESS: Parameter access control', 'type' => 'string', 'example' => 'JWT_BLOCKING', 'title' => ''], + 'ModifiedTime' => ['description' => 'Last modified time in Greenwich Mean Time', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z', 'title' => ''], + 'CreatedTime' => ['description' => 'Creation time in Greenwich Mean Time', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\"\\n}","type":"json"}]', - 'title' => 'ResetAppCode', - ], - 'RemoveVpcAccess' => [ - 'summary' => 'Deletes a VPC access authorization without unpublishing the associated APIs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeDatasetInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetInfo'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDatasetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries a data entry in a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94469', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '155080', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-uf657qec7lx42paw3qxxx', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of an ECS or SLB instance in the VPC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '62b91a790a693238********', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'DatasetItemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '80', - ], + 'schema' => ['description' => 'The ID of the data entry.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5045****', 'title' => ''], ], [ - 'name' => 'NeedBatchWork', + 'name' => 'Value', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether batch work is required.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The value of the data entry.', 'type' => 'string', 'required' => false, 'example' => '106.43.XXX.XXX'."\n", 'title' => ''], ], ], 'responses' => [ @@ -16417,115 +10865,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'Apis' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5BAFA85F-38E3-5D9E-9E32-4B09********', 'title' => ''], + 'DatasetItemInfo' => [ + 'description' => 'The Dataset information.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Api' => [ - 'description' => 'API operations'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'API Id', - 'type' => 'string', - 'example' => '551877242a4b4f3a84a56b7c3570e4a7', - ], - 'StageId' => [ - 'description' => 'The ID of the runtime environment.'."\n", - 'type' => 'string', - 'example' => 'd1e1ee28f9fb4b729db0ee8ca76ff0a5', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '78d54ac4424d4b1792e33ca35637e8e4', - ], - ], - ], - ], + 'DatasetId' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'example' => '626238665db4a5140eea3e40********', 'title' => ''], + 'DatasetItemId' => ['description' => 'The ID of the data entry.', 'type' => 'string', 'example' => '5045****', 'title' => ''], + 'Value' => ['description' => 'The value of the data entry.', 'type' => 'string', 'example' => '106.43.XXX.XXX', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format. If this parameter is empty, the data entry does not expire.', 'type' => 'string', 'example' => '2022-09-22T12:00:00Z'."\n", 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the data entry.', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n", 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time (UTC) of the data entry.', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the data entry.', 'type' => 'string', 'example' => 'Description', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<RemoveVpcAccessResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n</RemoveVpcAccessResponse>","errorExample":""}]', - 'title' => 'RemoveVpcAccess', - 'description' => '* This API is intended for API providers.'."\n" - .'* Revokes the permissions of API Gateway to access your VPC instance.'."\n" - ."\n" - .'> Deleting an authorization affects the associated API. Before you delete the authorization, make sure that it is not used by the API.'."\n", - ], - 'RemoveVpcAccessAndAbolishApis' => [ - 'summary' => 'Deletes a VPC access authorization and unpublishes the associated API.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDatasetItemInfo', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemInfo'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDatasetItemInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDatasetItemList' => [ + 'summary' => 'Queries the data entries of a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94470', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '155090', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'VpcId', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp1iw82phcgkvupgfv0o8', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'example' => '602e1f6b3543200eaab0a89e********', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DatasetItemIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-uf6iaale3gfef9t9cb41', - ], + 'schema' => ['description' => 'The ID of the data entry. You can enter multiple IDs. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => '5045****'."\n", 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8080', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NeedBatchWork', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -16533,143 +10955,229 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OperationId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C6E9C6E4-608B-5C0F-9783-E288********', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'DatasetItemInfoList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'example' => ' '."\n" + .'4add6a61804e47858266883e********'."\n", 'title' => ''], + 'DatasetItemId' => ['description' => 'The ID of the data entry.', 'type' => 'string', 'example' => '5045****', 'title' => ''], + 'Value' => ['description' => 'The value of the data entry.', 'type' => 'string', 'example' => '106.43.XXX.XXX', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format. If this parameter is empty, the data entry does not expire.', 'type' => 'string', 'example' => '2022-09-22T12:00:00Z', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the data entry.', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the data entry was created.', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z', 'title' => ''], + 'Description' => ['description' => 'The description of the data entry.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The Dataset information.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', - 'title' => 'RemoveVpcAccessAndAbolishApis', - ], - 'ModifyVpcAccessAndUpdateApis' => [ - 'summary' => 'Modifies the information of a VPC access authorization and updates the metadata of the associated API.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDatasetItemList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetItemList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDatasetItemList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDatasetList' => [ + 'summary' => 'Retrieves the list of custom datasets.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155070', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'VpcId', + 'name' => 'DatasetIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the new VPC.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'vpc-m5e7jqfppv5wbvmdw5pg2', - ], + 'schema' => ['description' => 'Dataset IDs. You can specify multiple dataset IDs separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '4add6a61804e47858266883e********', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the new instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => ' '."\n" - .'i-uf6bzcg1pr4oh5jjmxxx'."\n", - ], + 'schema' => ['description' => 'Plugin dataset name', 'type' => 'string', 'required' => false, 'example' => 'IPwhitelist', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The new port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '80', - ], + 'schema' => ['description' => 'The page number to query. Default is 1. Page numbering starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the VPC authorization.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The name of a VPC authorization cannot be changed. You cannot use this parameter to change the name of a VPC authorization.'."\n" - ."\n" - .'* You must set this parameter to the name of the current VPC authorization.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'VpcName', - ], + 'schema' => ['description' => 'Number of entries per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Token', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The token of the request.'."\n", - 'type' => 'string', + 'description' => 'Object tags that the rule applies to. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'Tag value', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NeedBatchWork', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to update the associated API.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning:** If you want to update the VPC authorization of a published API, you must set this parameter to true. Otherwise, the update will not be synchronized to the backend service of the API.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The returned page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'D403C6E6-21B3-5B78-82DA-E3B6********', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of returned entries', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'DatasetInfoList' => [ + 'description' => 'An array of datasetinfo objects that contain dataset details', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'Dataset ID', 'type' => 'string', 'example' => '6304ce6b4ae6453f********', 'title' => ''], + 'DatasetName' => ['description' => 'Dataset name', 'type' => 'string', 'example' => 'DatasetName', 'title' => ''], + 'DatasetType' => ['description' => 'Dataset type. Valid values:'."\n" + ."\n" + .'- JWT\\_BLOCKING: JWT blacklist'."\n" + ."\n" + .'- IP\\_WHITELIST\\_CIDR: IP address whitelist'."\n" + ."\n" + .'- PARAMETER\\_ACCESS: Parameter access control', 'type' => 'string', 'example' => 'IP_WHITELIST_CIDR', 'title' => ''], + 'ModifiedTime' => ['description' => 'Last modified time in UTC', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n", 'title' => ''], + 'CreatedTime' => ['description' => 'Creation time in UTC', 'type' => 'string', 'example' => '2022-09-21T12:58:43Z'."\n", 'title' => ''], + 'Tags' => [ + 'description' => 'Tags', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key', 'type' => 'string', 'example' => 'ENV', 'title' => ''], + 'Value' => ['description' => 'Tag value', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => 'The tags.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeDatasetList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDatasetList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'Refresh', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to update the VPC authorization.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the ID of the instance in your VPC is changed but the IP address of the instance remains unchanged, you can set this parameter to true to update the VPC authorization.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + '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' => 'Queries the progress of an asynchronous API publishing task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94350', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], + ], + 'parameters' => [ [ - 'name' => 'VpcTargetHostName', + 'name' => 'OperationUid', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The hostname of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'iot.hu***ng.com', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '51524fb8f12846d694d0a1de9a0cf274', 'title' => ''], ], ], 'responses' => [ @@ -16677,71 +11185,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OperationId' => [ - 'description' => 'The ID of the asynchronous task.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* If the associated API is updated, you can use the task ID in the **DescribeUpdateVpcInfoTask** operation to query the update result.'."\n", - 'type' => 'string', - 'example' => '7b6d0cb72b2e4215b0129f675c889746', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', 'title' => ''], + 'DeployedResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedResult' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success. Request Success.', 'title' => ''], + 'StageName' => ['description' => 'The runtime environment of the API. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b', 'title' => ''], + 'ApiUid' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '0433c1cd84724923b7a4f9ca1cfc249c', 'title' => ''], + 'DeployedStatus' => ['description' => 'The deployment status of the API.', 'type' => 'string', 'example' => 'OVER', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"7b6d0cb72b2e4215b0129f675c889746\\",\\n \\"RequestId\\": \\"C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39\\"\\n}","type":"json"}]', - 'title' => 'ModifyVpcAccessAndUpdateApis', - ], - 'ModifyApiGroupVpcWhitelist' => [ - 'summary' => 'Modifies the VPC whitelist of an API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeDeployApiTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployApiTask'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDeployApiTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94434', - 'abilityTreeNodes' => [ - 'FEATUREapigatewaySKO2I5', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94351', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9b80408147724ddab4c4e2703c6ca019', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '81750604ccff48c48f34d6c0165e09db', 'title' => ''], ], [ - 'name' => 'VpcIds', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the VPC instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'vpc-bp11w979o2s9rcr962w25', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ab7c95a01a7e42f28718f34497bbf47c', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE: the pre-release environment**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -16749,172 +11292,632 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F8B9DC8C-D6E2-5065-BD1F-0401866E7F10', + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '4eed13a57d4e42fbb51316be8a5329ff', 'title' => ''], + 'ResultType' => ['description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.', 'type' => 'string', 'example' => 'HTML', 'title' => ''], + 'DisableInternet' => ['description' => '- Specifies whether to set DisableInternet to **true** to limit API calls to within the VPC.'."\n" + ."\n" + .'- If you set DisableInternet to **false**, the limit is lifted.'."\n" + ."\n" + .'> If you do not set this parameter, the original value is not modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResultBodyModel' => ['description' => 'The return description of the API.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ResultSample' => ['description' => 'The sample response from the backend service.', 'type' => 'string', 'example' => '{code: 200, message:\'success\', data: \'\'}', 'title' => ''], + 'AllowSignatureMethod' => ['description' => 'The signature method used by the client. Valid values:'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'example' => 'HmacSHA256', 'title' => ''], + 'RegionId' => ['description' => 'The region to which the API group belongs.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'ForceNonceCheck' => ['description' => '- Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If you set **ForceNonceCheck** to **false**, the check is not performed. The default value is false when you create an API.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Visibility' => ['description' => 'Specifies whether to make the API public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.\\*\\*'."\n" + ."\n" + .'- **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'FailResultSample' => ['description' => 'The sample error response from the backend service.', 'type' => 'string', 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', 'title' => ''], + 'AuthType' => ['description' => 'The security authentication method of the API. Valid values:'."\n" + ."\n" + .'- **APP: Only authorized applications can call the API.**'."\n" + ."\n" + .'- **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" + ."\n" + .' - All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Error description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'Weather', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'bc77f5b49c974437a9912ea3755cd834', 'title' => ''], + 'DeployedTime' => ['description' => 'The deployment time. Format: yyyy-mm-ddhh:mm:ss.', 'type' => 'string', 'example' => '2022-07-25T17:47:51Z', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE: the pre-release environment**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API', 'type' => 'string', 'example' => 'weather', 'title' => ''], + 'RequestConfig' => [ + 'description' => 'Configuration items of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [RequestConfig](~~43985~~).', + 'type' => 'object', + 'properties' => [ + 'BodyModel' => ['description' => 'The body model.', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab', 'title' => ''], + 'RequestPath' => ['description' => 'The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is `/object/add `.', 'type' => 'string', 'example' => '/api/billing/test/[type]', 'title' => ''], + 'RequestHttpMethod' => ['description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'BodyFormat' => ['description' => 'This parameter takes effect only when the RequestMode parameter is set to MAPPING.'."\n" + ."\n" + .'The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.', 'type' => 'string', 'example' => 'STREAM', 'title' => ''], + 'RequestMode' => ['description' => 'The request mode. Valid values:'."\n" + ."\n" + .'- MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" + ."\n" + .'- PASSTHROUGH: Parameters are passed through.'."\n" + ."\n" + .'- MAPPING\\_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.', 'type' => 'string', 'example' => 'MAPPING', 'title' => ''], + 'PostBodyDescription' => ['description' => 'The description of the request body.', 'type' => 'string', 'example' => 'fwefwef', 'title' => ''], + 'RequestProtocol' => ['description' => 'The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS".', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ServiceConfig' => [ + 'description' => 'The configuration items of API requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceConfig](~~43987~~).', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-uf6kg9x8sx2tbxxxx', 'title' => ''], + 'MockStatusCode' => ['description' => 'The status code returned for service mocking.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ServicePath' => ['description' => 'The path used to call the back-end service. If the complete back-end service path is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServicePath is **/object/add**.\\`\\`', 'type' => 'string', 'example' => '/object/add', 'title' => ''], + 'Mock' => ['description' => 'Specifies whether to enable the Mock mode. Valid values:'."\n" + ."\n" + .'- **TRUE: The Mock mode is enabled.**'."\n" + ."\n" + .'- \\*\\*FALSE: The Mock mode is not enabled.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'ServiceAddress' => ['description' => 'The URL used to call the back-end service. If the complete back-end service URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the value of ServiceAddress is **http\\://api.a.com:8080**.\\`\\`', 'type' => 'string', 'example' => 'http://api.a.com:8080', 'title' => ''], + 'ServiceVpcEnable' => ['description' => 'Specifies whether to enable the VPC channel. Valid values:'."\n" + ."\n" + .'- **TRUE**: The VPC channel is enabled. You must create the corresponding VPC access authorization before you can enable a VPC channel.'."\n" + ."\n" + .'- **FALSE**: The VPC channel is not enabled.', 'type' => 'string', 'example' => 'TRUE', 'title' => ''], + 'MockResult' => ['description' => 'The result returned when the Mock mode is enabled.', 'type' => 'string', 'example' => 'test result', 'title' => ''], + 'ServiceHttpMethod' => ['description' => 'The HTTP method used to call a backend service. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ServiceProtocol' => ['description' => 'The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'ServiceTimeout' => ['description' => 'The timeout period of the backend service, in millisecond.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'MockHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MockHeader' => [ + 'description' => 'The simulated Headers.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HeaderValue' => ['description' => 'The value of the HTTP header parameter.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'HeaderName' => ['description' => 'The name of the HTTP header parameter.', 'type' => 'string', 'example' => 'Content-Type', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'VpcConfig' => [ + 'description' => 'Configuration items related to VPC channels', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-2zeafsc3fygk1***', 'title' => ''], + 'InstanceId' => ['description' => 'The IDs of the ELB and SLB instances in the VPC.', 'type' => 'string', 'example' => 'i-bp1h497hkijewv2***', 'title' => ''], + 'Port' => ['description' => 'The port number that corresponds to the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'Name' => ['description' => 'The name of the VPC access authorization.', 'type' => 'string', 'example' => 'glmall-app-test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FunctionComputeConfig' => [ + 'description' => 'Backend configuration items when the backend service is Function Compute', + 'type' => 'object', + 'properties' => [ + 'FcType' => ['description' => 'The type of the Function Compute instance.', 'type' => 'string', 'example' => 'HttpTrigger', 'title' => ''], + 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.', 'type' => 'string', 'example' => 'acs:ram::111***:role/aliyunserviceroleforsas', 'title' => ''], + 'Method' => ['description' => 'The request method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'FcBaseUrl' => ['description' => 'The root path of Function Compute.', 'type' => 'string', 'example' => 'https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/', 'title' => ''], + 'ContentTypeValue' => ['description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.', 'type' => 'string', 'example' => 'application/x-www-form-urlencoded; charset=UTF-8'."\n", 'title' => ''], + 'RegionId' => ['description' => 'The region where the API is located.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'OnlyBusinessPath' => ['description' => 'The backend only receives the service path.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'FunctionName' => ['description' => 'The function name defined in Function Compute.', 'type' => 'string', 'example' => 'domain_business_control', 'title' => ''], + 'ContentTypeCatagory' => ['description' => 'The ContentType header type used when you call the backend service over HTTP.'."\n" + ."\n" + .'- **DEFAULT: the default header type in API Gateway.**'."\n" + ."\n" + .'- **CUSTOM: a custom header type.**'."\n" + ."\n" + .'- \\*\\*CLIENT: the ContentType header type of the client.', 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'Path' => ['description' => 'The API request path.', 'type' => 'string', 'example' => '/api/offline/cacheData', 'title' => ''], + 'ServiceName' => ['description' => 'The service name defined in Function Compute.', 'type' => 'string', 'example' => 'fcservicename', 'title' => ''], + 'Qualifier' => ['description' => 'The alias of the function.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'OpenIdConnectConfig' => [ + 'description' => 'The configuration items of the third-party OpenID Connect authentication method.', + 'type' => 'object', + 'properties' => [ + 'OpenIdApiType' => ['description' => 'The configuration of OpenID Connect authentication. Valid values:'."\n" + ."\n" + .'- **IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required.**'."\n" + ."\n" + .'- \\*\\*BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.', 'type' => 'string', 'example' => 'IDTOKEN', 'title' => ''], + 'IdTokenParamName' => ['description' => 'The name of the parameter that corresponds to the token.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'PublicKeyId' => ['description' => 'The ID of the public key.', 'type' => 'string', 'example' => '88483727556929326703309904351185815489', 'title' => ''], + 'PublicKey' => ['description' => 'The public key of the API.', 'type' => 'string', 'example' => 'EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorCodeSamples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorCodeSample' => [ + 'description' => 'The sample error codes returned by the backend service.'."\n" + ."\n" + .'For more information, see [ErrorCodeSample](~~44392~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Error', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error message', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '错误描述', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ResultDescriptions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultDescription' => [ + 'description' => 'The return description of the API.', + 'type' => 'array', + 'items' => [ + 'description' => 'The return description of the API.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the result.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'Key' => ['description' => 'The primary key of the result.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'HasChild' => ['description' => 'Specifies whether a subnode exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'result description', 'title' => ''], + 'Pid' => ['description' => 'The ID of the parent node.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'Mandatory' => ['description' => 'Specifies whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the result.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Id' => ['description' => 'The ID of the result.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'description' => 'System parameters', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => ['description' => 'Examples', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'QueryParamDTO', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the corresponding backend parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'CustomSystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomSystemParameter' => [ + 'description' => 'The custom system parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => ['description' => 'Example', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the custom system parameter.', 'type' => 'string', 'example' => 'appid', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the corresponding backend parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ConstantParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConstantParameter' => [ + 'description' => 'The constant parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the backend service parameter.', 'type' => 'string', 'example' => 'constance', 'title' => ''], + 'ConstantValue' => ['description' => 'The constant value.', 'type' => 'string', 'example' => 'constance', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RequestParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParameter' => [ + 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [RequestParameter](~~43986~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => ['description' => 'JSON scheme', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'MaxValue' => ['description' => 'The maximum parameter value when ParameterType is set to Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'ArrayItemsType' => ['description' => 'The type of the array element.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'MinValue' => ['description' => 'The minimum parameter value when ParameterType is set to Int, Long, Float, or Double.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocShow' => ['description' => 'Specifies whether the document is public. Valid values: PUBLIC and PRIVATE.', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'MaxLength' => ['description' => 'The maximum parameter length when ParameterType is set to String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'ApiParameterName' => ['description' => 'The name of the API parameter.', 'type' => 'string', 'example' => 'age', 'title' => ''], + 'EnumValue' => ['description' => 'The hash values that can be entered when ParameterType is set to Int, Long, Float, Double, or String. Separate different values with commas (,), such as 1,2,3,4,9 or A,B,C,E,F.', 'type' => 'string', 'example' => 'boy,girl', 'title' => ''], + 'DemoValue' => ['description' => 'Example', 'type' => 'string', 'example' => '20', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required. Valid values: REQUIRED and OPTIONAL.', 'type' => 'string', 'example' => 'OPTIONAL', 'title' => ''], + 'Description' => ['description' => 'Description', 'type' => 'string', 'example' => 'parameter description', 'title' => ''], + 'ParameterType' => ['description' => 'The type of a request parameter. Valid values: String, Int, Long, Float, Double, and Boolean.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'RegularExpression' => ['description' => 'The regular expression used for parameter validation when ParameterType is set to String.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'MinLength' => ['description' => 'The minimum parameter length when ParameterType is set to String.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'DocOrder' => ['description' => 'The order in the document.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ServiceParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServiceParameter' => [ + 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceParameter](~~43988~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Location' => ['description' => 'The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.', 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'ParameterType' => ['description' => 'The data type of the back-end service parameter.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the backend service parameter.', 'type' => 'string', 'example' => 'clientIp', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ServiceParametersMap' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServiceParameterMap' => [ + 'description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [ServiceParameterMap](~~43989~~).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RequestParameterName' => ['description' => 'The name of the front-end input parameter.', 'type' => 'string', 'example' => 'sex', 'title' => ''], + 'ServiceParameterName' => ['description' => 'The name of the backend service parameter.', 'type' => 'string', 'example' => 'sex', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B9DC8C-D6E2-5065-BD1F-0401866E7F10\\"\\n}","type":"json"}]', - 'title' => 'ModifyApiGroupVpcWhitelist', - ], - 'SetVpcAccess' => [ - 'summary' => 'Creates a virtual private cloud (VPC) access authorization and enables reverse access.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDeployedApi', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDeployedApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDeployedApis' => [ + 'summary' => 'Queries the APIs that have been published to a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94487', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94352', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the authorization. The name must be unique.', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-uf657qec7lx42paw3qxxx', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of an ECS or SLB instance in the VPC.', - 'type' => 'string', - 'required' => true, - 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => false, 'example' => 'c076144d7878437b8f82fb85890ce6a0', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The port number that corresponds to the instance.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '80', - ], + 'schema' => ['description' => 'The name of the API. The name is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'weather', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the VPC.', - 'type' => 'string', - 'required' => false, - 'example' => 'description of the VPC', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'VpcTargetHostName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The host of the backend service.', - 'type' => 'string', - 'required' => false, - 'example' => 'iot.hu***ng.com', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable tag verification.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'appname', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'testapp', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ApiPath', + 'in' => 'query', + 'schema' => ['description' => 'The request path of the API.', 'type' => 'string', 'required' => false, 'example' => '/st4', 'title' => ''], + ], + [ + 'name' => 'ApiMethod', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP method of the API request.', 'type' => 'string', 'required' => false, 'example' => 'POST', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'VpcAccessId' => [ - 'description' => 'The ID of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => '4c68e061860f441ab72af7404137440e', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DeployedApis' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedApiItem' => [ + 'description' => 'The returned API information. It is an array consisting of DeployedApiItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**'."\n" + ."\n" + .'- **PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => 'c076144d7878437b8f82fb85890ce6a0', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => '分页显示对象列表', 'title' => ''], + 'GroupName' => ['description' => 'The name of the group to which the API belongs.', 'type' => 'string', 'example' => 'myGroup3', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '63be9002440b4778a61122f14c2b2bbb', 'title' => ''], + 'DeployedTime' => ['description' => 'The publising time (UTC) of the API.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'Get object list', 'title' => ''], + 'RegionId' => ['description' => 'The region where the API is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'ApiPath' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/trademark/search', 'title' => ''], + 'ApiMethod' => ['description' => 'The HTTP method of the API request.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"VpcAccessId\\": \\"4c68e061860f441ab72af7404137440e\\"\\n}","type":"json"}]', - 'title' => 'SetVpcAccess', - 'description' => '* This operation is intended for API providers.'."\n" - .'* This operation is used to authorize API Gateway to access your VPC instance.', + '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' => 'DescribeDeployedApis', + 'description' => '- This API is intended for API providers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApiGroupVpcWhitelist' => [ - 'summary' => 'Queries the VPC whitelist that is allowed to access an API group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeployedApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDeployedApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeDomain' => [ + 'summary' => 'Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16923,22 +11926,19 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94314', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94353', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f6c64214dc27400196eef954575d60d3', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], ], ], 'responses' => [ @@ -16946,170 +11946,214 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'VpcIds' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp11w979o2s9rcr962w25', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', - ], + 'CertificatePrivateKey' => ['description' => 'The private key of the SSL certificate.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'DomainName' => ['description' => 'The custom domain name.', 'type' => 'string', 'example' => 'api.demo.com', 'title' => ''], + 'DomainBindingStatus' => ['description' => 'The binding status of the custom domain name. Valid values:'."\n" + ."\n" + .'- BINDING: The domain name has been bound.'."\n" + ."\n" + .'- BOUND: The domain name has not been bound.', 'type' => 'string', 'example' => 'BINDING', 'title' => ''], + 'DomainRemark' => ['description' => 'Remarks about the domain name, such as the cause of an exception.', 'type' => 'string', 'example' => 'The domain name is not registered.', 'title' => ''], + 'CertificateId' => ['description' => 'The unique ID of the SSL certificate, which is automatically generated by the system.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], + 'DomainWebSocketStatus' => ['description' => 'The status of the domain name that uses WebSocket.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], + 'CertificateName' => ['description' => 'The name of the SSL certificate.', 'type' => 'string', 'example' => 'myCertificate', 'title' => ''], + 'DomainLegalStatus' => ['description' => 'The validity status of the domain name. Valid values:'."\n" + ."\n" + .'- NORMAL'."\n" + ."\n" + .'- ABNORMAL: This status affects API calls and must be resolved as soon as possible.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], + 'CertificateBody' => ['description' => 'The content of the certificate.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain name that is automatically assigned to the API group.', 'type' => 'string', 'example' => 'xxx-cn-hangzhou.alicloudapi.com', 'title' => ''], + 'DomainCNAMEStatus' => ['description' => 'The domain name resolution status. Valid values:'."\n" + ."\n" + .'- RESOLVED: The domain name has been resolved.'."\n" + ."\n" + .'- UNRESOLVED: The domain name has not been resolved.', 'type' => 'string', 'example' => 'RESOLVED', 'title' => ''], + 'CertificateValidStart' => ['description' => 'Certificate effective timestamp(milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1672502400000', 'title' => ''], + 'CertificateValidEnd' => ['description' => 'Certificate expiration timestamp(milliseconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1704038400000', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcIds\\": \\"vpc-bp11w979o2s9rcr962w25\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', - 'title' => 'DescribeApiGroupVpcWhitelist', - ], - 'DescribeVpcAccesses' => [ - 'summary' => 'Queries VPC access authorizations.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeDomain', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDomain'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDomain', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeGroupLatency' => [ + 'summary' => 'Queries the average latency of an API group in an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '94417', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'abilityTreeCode' => '94358', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '当前页码', - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-03-30T16:00:00Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示条目', - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-04-14T06:26:14Z', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'title' => 'VPC授权名称', - 'description' => 'The name of the authorization. The name must be unique.', - 'type' => 'string', - 'required' => false, - 'example' => 'wuying-edm-svc', - ], + 'schema' => ['description' => 'The environment in which you want to perform the query. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'VpcAccessId', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => 'd825094fdd114a869f5adb443d9b7ead', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Vpc授权ID', - 'description' => 'The ID of the VPC authorization.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-*****ssds24', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '75DC3AB0-421C-5371-8170-86AEABF77AD0', 'title' => ''], + 'LatencyPacket' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The latency information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The latency. Unit: ms.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'ItemTime' => ['description' => 'The point in time when the latency data was collected. The format is YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2023-03-30T16:10:00Z', 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- latency: the backend processing latency'."\n" + ."\n" + .'- gatewayLatency: the API Gateway processing latency', 'type' => 'string', 'example' => 'latency', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeGroupLatency', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupLatency'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'AccurateQuery', - 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to conduct precise queries', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + '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' => 'Queries the statistics on the number of requests directed to an API group within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'VpcId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94359', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => 'Vpc ID', - 'description' => 'The ID of the VPC.', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-uf657qec7lx42paw3qxxx', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-08-12T06:09:52Z', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the instance.', - 'type' => 'string', - 'required' => false, - 'example' => '10.199.26.***', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-08-23T07:27:44Z', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'title' => '端口号', - 'description' => 'The service port.', - 'type' => 'string', - 'required' => false, - 'example' => '8080', - ], + 'schema' => ['description' => 'The environment to which the API group is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The port number.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appname', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => true, 'example' => '264c60db9f764345a13ac5c825b229b9', 'title' => ''], ], ], 'responses' => [ @@ -17117,145 +12161,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'VpcAccessAttributes' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], + 'GroupQps' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'VpcAccessAttribute' => [ - 'description' => 'The information about the VPC access authorization. The information is an array consisting of VpcAccessAttribute data.'."\n", + 'MonitorItem' => [ + 'description' => 'The number of requests directed to the API group.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC的ID', - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf657qec7lx42paw3qxxx', - ], - 'Description' => [ - 'title' => 'VPC授权的描述', - 'description' => 'The description of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'InstanceId' => [ - 'title' => 'VPC中的后端服务信息', - 'description' => 'The ID of an Elastic Compute Service (ECS) or Server Load Balancer (SLB) instance in the VPC.'."\n", - 'type' => 'string', - 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', - ], - 'Port' => [ - 'title' => 'VPC中的后端服务端口', - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'Name' => [ - 'title' => 'VPC授权名称', - 'description' => 'The name of the authorization.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreatedTime' => [ - 'title' => 'VPC授权的创建时间', - 'description' => 'The time when the authorization was created.'."\n", - 'type' => 'string', - 'example' => '2017-01-30T04:10:19Z', - ], - 'RegionId' => [ - 'title' => '地域id', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'VpcAccessId' => [ - 'title' => 'vpc授权ID', - 'description' => 'The ID of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'vpc-*****ssds24', - ], - 'VpcTargetHostName' => [ - 'description' => 'The host of the backend service.'."\n", - 'type' => 'string', - 'example' => 'hos-a***.fh-**nc.com', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TagInfo' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'PROJECT', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => '6427a17ae6041d1be62414e4', - ], - ], - ], - ], - ], - ], + 'ItemValue' => ['description' => 'The number of requests at the specified point in time.', 'type' => 'string', 'example' => '17', 'title' => ''], + 'ItemTime' => ['description' => 'The point in time.', 'type' => 'string', 'example' => '2023-08-02T09:15:00Z', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"测试\\",\\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":"<DescribeVpcAccessesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <VpcAccessAttributes>\\r\\n <VpcAccessAttribute>\\r\\n <VpcId>vpc-uf657qec7lx42paw3qxxx</VpcId>\\r\\n <InstanceId>i-uf6bzcg1pr4oh5jjmxxx</InstanceId>\\r\\n <Port>80</Port>\\r\\n <Name>test</Name>\\r\\n <CreatedTime>2017-01-30T04:10:19Z</CreatedTime> \\r\\n </VpcAccessAttribute>\\r\\n </VpcAccessAttributes>\\r\\n</DescribeVpcAccessesResponse> ","errorExample":""}]', - 'title' => 'DescribeVpcAccesses', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeUpdateVpcInfoTask' => [ - 'summary' => 'Queries the update progress of an API that is being published after its associated VPC access authorization is updated.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeGroupQps', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupQps'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the traffic of an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17264,22 +12229,35 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94411', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94360', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'OperationUid', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7d341787517a47afaaef9cc1bdb7acce', - ], + 'schema' => ['description' => 'The start time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-29T01:27:43Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-06-16T02:16:53Z', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment to which the APIs in the API group are published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE ', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '16df9d11caa04900bcafe23b38a81600', 'title' => ''], ], ], 'responses' => [ @@ -17287,113 +12265,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'ApiUpdateVpcInfoResults' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], + 'TrafficPerSecond' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiUpdateVpcInfoResult' => [ - 'description' => '', + 'MonitorItem' => [ + 'description' => 'The traffic information per second.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fe952b95072747e2a8dfd336bcff8d7f', - ], - 'UpdateStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ApiUid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '86364e7c166c47ba819b3f8f95ac0913', - ], - 'ErrorMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success. Request Success.', - ], - 'StageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'api_test2', - ], + 'ItemValue' => ['description' => 'The traffic volume per second.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'ItemTime' => ['description' => 'The corresponding time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2023-01-29T01:30:00Z', 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- inbound: traffic consumed by requests'."\n" + ."\n" + .'- outbound: traffic consumed by responses', 'type' => 'string', 'example' => 'inbound', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeUpdateVpcInfoTask', - ], - 'ValidateVpcConnectivity' => [ - 'summary' => 'Tests the network connectivity between an API Gateway instance and a port on an Elastic Compute Service (ECS) or Server Load Balance (SLB) instance in a virtual private cloud (VPC) access authorization.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeGroupTraffic', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupTraffic'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeGroupTraffic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries the historical versions of an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '94362', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'VpcAccessId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the VPC access authorization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5f1b3216f9********e2c1297b6741dc', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '0ccb66aadb5345b78a40f57d192d8aa4', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API Gateway instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'apigateway-hz-72bc18******', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => false, 'example' => 'a12068f555964ca8a0c9c33288f1e5a7', 'title' => ''], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the API. The name is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'getPersonInfo', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the current page.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], ], 'responses' => [ @@ -17401,84 +12382,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1', - ], - 'Connected' => [ - 'description' => 'Indicates whether the API Gateway instance is connected to the port. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'IpType' => [ - 'description' => 'Indicates whether the instance in the authorization is an ECS instance or an SLB instance when the instance ID in the authorization is an IP address. Valid values:'."\n" - ."\n" - .'* **ECS**'."\n" - .'* **SLB**'."\n" - .'* **INVALID**: The instance type corresponding to the IP address is invalid.'."\n", - 'type' => 'string', - 'example' => 'ECS', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries to return on each page. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ApiHisItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiHisItem' => [ + 'description' => 'The returned API information. It is an array consisting of ApiHisItems.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether an API version is effective. Valid values: ONLINE and OFFLINE.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => '5af418828f0344a3b588c0cc1331a3bc', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'Create object API', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group to which the API belongs.', 'type' => 'string', 'example' => 'myGroup2', 'title' => ''], + 'GroupId' => ['description' => 'The API group ID.', 'type' => 'string', 'example' => '1084f9034c744137901057206b39d2b6', 'title' => ''], + 'DeployedTime' => ['description' => 'The time when the API was published. The time is displayed in UTC.', 'type' => 'string', 'example' => '2016-07-20T08:28:48Z', 'title' => ''], + 'StageName' => ['description' => 'The environment name. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'StageAlias' => ['description' => 'The environment alias.', 'type' => 'string', 'example' => 'Production', 'title' => ''], + 'HistoryVersion' => ['description' => 'The historical version of the API definition.', 'type' => 'string', 'example' => '20210915101416294', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'v2_role_assign', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1\\",\\n \\"Connected\\": true,\\n \\"IpType\\": \\"ECS\\"\\n}","type":"json"}]', - 'title' => 'ValidateVpcConnectivity', - ], - 'CreateAccessControlList' => [ - 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Creates an Access Control List (ACL). Each user is allowed to create five ACLs in each region.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeHistoryApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeHistoryApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeImportOASTask' => [ + 'summary' => 'Queries the result of an OAS API import task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'abilityTreeCode' => '155133', + 'abilityTreeNodes' => ['FEATUREapigateway9WMX21'], ], 'parameters' => [ [ - 'name' => 'AclName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ACL. The name must be 1 to 30 characters in length, and can contain letters, digits, periods (.), hyphens (-), forward slashes (/), and underscores (\\_). The name must be unique within the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testAcl', - ], - ], - [ - 'name' => 'AddressIPVersion', + 'name' => 'OperationId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP protocol version of the ACL. Valid values:'."\n" - ."\n" - .'* **IPv4**'."\n" - .'* **IPv6**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4', - 'default' => 'ipv4', - ], + 'schema' => ['description' => 'The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status of the API import task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4c53ccf1d40c489686d1adf5c2644a7f', 'title' => ''], ], ], 'responses' => [ @@ -17486,34 +12483,145 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], + 'ApiResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiResult' => [ + 'description' => 'The execution status of the subtask. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- WAIT'."\n" + ."\n" + .'- OVER'."\n" + ."\n" + .'- FAIL'."\n" + ."\n" + .'- CANCEL', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => 'c5a0c2900ff746b789c007545be22fb8', 'title' => ''], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/creator/getByCreatorId', 'title' => ''], + 'Method' => ['description' => 'The HTTP request HTTP method of the API.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'This API is used for queries.', 'title' => ''], + 'GroupId' => ['description' => 'The API group ID.', 'type' => 'string', 'example' => '736508d885074167ba8fbce3bc95ea0b', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'GetByCreatorIdUsingGET', 'title' => ''], + 'ErrorMessage' => ['description' => 'The cause of the failure if the API fails to be imported.', 'type' => 'string', 'example' => 'Internal Error', 'title' => ''], + 'UpdateStatus' => ['description' => 'The execution status of the subtask. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- WAIT'."\n" + ."\n" + .'- OVER'."\n" + ."\n" + .'- FAIL'."\n" + ."\n" + .'- CANCEL', 'type' => 'string', 'example' => 'WAIT', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'AclId' => [ - 'description' => 'The ACL ID.'."\n", - 'type' => 'string', - 'example' => 'acl-bp1uqwgwmkbutnzq2r59z', + 'ModelResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModelResult' => [ + 'description' => 'The execution status of the subtask. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- WAIT'."\n" + ."\n" + .'- OVER'."\n" + ."\n" + .'- FAIL'."\n" + ."\n" + .'- CANCEL', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'Pet', 'title' => ''], + 'ModelId' => ['description' => 'The ID of the imported model.', 'type' => 'string', 'example' => '6b48d724c921415486e190c494dd6bf8', 'title' => ''], + 'GroupId' => ['description' => 'The API group ID.', 'type' => 'string', 'example' => '736508d885074167ba8fbce3bc95ea0b', 'title' => ''], + 'ErrorMessage' => ['description' => 'The cause of the failure if the model fails to be imported.', 'type' => 'string', 'example' => 'Internal Error'."\n", 'title' => ''], + 'UpdateStatus' => ['description' => 'The execution status of the subtask. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- WAIT'."\n" + ."\n" + .'- OVER'."\n" + ."\n" + .'- FAIL'."\n" + ."\n" + .'- CANCEL', 'type' => 'string', 'example' => 'FAIL', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'TaskStatus' => ['description' => 'The status of the import task. Valid values:'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Finished', 'type' => 'string', 'example' => 'Finished', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"AclId\\": \\"acl-bp1uqwgwmkbutnzq2r59z\\"\\n}","type":"json"}]', - 'title' => 'CreateAccessControlList', - ], - 'DeleteAccessControlList' => [ - 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Deletes an access control policy.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeImportOASTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeImportOASTask'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeImportOASTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeInstanceClusterInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17522,19 +12630,17 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175318', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'AclId', + 'name' => 'InstanceClusterName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-uf6fpfdg3b5muska7uqem', - ], + 'schema' => ['description' => 'The name of the dedicated instance cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvpc', 'title' => ''], ], ], 'responses' => [ @@ -17542,28 +12648,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'InstanceClusterName' => ['description' => 'The cluster name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'InstanceClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'apigateway-ht-04e41d95e9c1'."\n", 'title' => ''], + 'InstanceClusterStatus' => ['description' => 'The cluster status.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'InstanceClusterVersion' => ['description' => 'The cluster version.'."\n", 'type' => 'string', 'example' => '3.5.3.856', 'title' => ''], + 'Description' => ['description' => 'The cluster description, which can be up to 200 characters in length.'."\n", 'type' => 'string', 'example' => 'v0.0.4', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the cluster.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the cluster was created.'."\n", 'type' => 'string', 'example' => '2022-10-10T18:29:27', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the cluster was last modified.'."\n", 'type' => 'string', 'example' => '2023-06-19 10:40:29 +0800', 'title' => ''], + 'InstanceClusterAttribute' => [ + 'description' => 'The cluster details.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpsPolicies' => ['description' => 'The HTTPS security policy.'."\n", 'type' => 'string', 'example' => 'HTTPS2_TLS1_0', 'title' => ''], + 'InternetEgressAddress' => ['description' => 'The outbound public IP address.'."\n", 'type' => 'string', 'example' => '39.106.XX.XX', 'title' => ''], + 'IntranetEgressAddress' => ['description' => 'The outbound private IP address.'."\n", 'type' => 'string', 'example' => '100.104.XX.XX/26', 'title' => ''], + 'VpcIntranetEnable' => ['description' => 'Indicates whether a virtual private cloud (VPC) domain name is enabled.'."\n", 'type' => 'boolean', 'title' => ''], + 'IntranetSegments' => ['description' => 'The custom CIDR block. The configured CIDR block is considered as a private block.'."\n", 'type' => 'string', 'example' => '123.0.0.1', 'title' => ''], + 'UserVpcId' => ['description' => 'The ID of the client VPC.'."\n", 'type' => 'string', 'example' => 'vpc-2zew2v4vcg78mXXXX', 'title' => ''], + 'UserVswitchId' => ['description' => 'The vSwitch of the client VPC.'."\n", 'type' => 'string', 'example' => 'vsw-2zecr5r7ao44tslsXXXX', 'title' => ''], + 'VpcOwnerId' => ['description' => 'The ID of the account to which the VPC belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '165438596694XXXX', 'title' => ''], + 'IPV4AclId' => ['description' => 'The ID of the IPv4 access control list (ACL).'."\n", 'type' => 'string', 'example' => 'acl-t4n8i4rvvp70kcyuoXXXX', 'title' => ''], + 'IPV4AclName' => ['description' => 'The name of the IPv4 ACL.'."\n", 'type' => 'string', 'example' => 'test-black', 'title' => ''], + 'IPV4AclStatus' => ['description' => 'Indicates whether IPv4 access control is enabled. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'IPV4AclType' => ['description' => 'The type of the IPv4 ACL.'."\n" + ."\n" + .'* black: blacklist'."\n" + .'* white: whitelist'."\n", 'type' => 'string', 'example' => 'black', 'title' => ''], + 'EgressIpv6Enable' => ['description' => 'Indicates whether outbound IPv6 traffic is supported.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SupportIpv6' => ['description' => 'Indicates whether IPv6 traffic is supported.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IPV6AclName' => ['description' => 'The name of the IPv6 ACL.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'IPV6AclId' => ['description' => 'The ID of the IPv6 ACL.'."\n", 'type' => 'string', 'example' => 'acl-t4nevzhwbpe7cup18XXXX', 'title' => ''], + 'IPV6AclStatus' => ['description' => 'Indicates whether IPv6 access control is enabled. Valid values:'."\n" + ."\n" + .'* **on**'."\n" + .'* **off**'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'IPV6AclType' => ['description' => 'The type of the IPv6 ACL. Valid values:'."\n" + ."\n" + .'* black: blacklist'."\n" + .'* white: whitelist'."\n", 'type' => 'string', 'example' => 'white', 'title' => ''], + 'VipTypeList' => ['description' => 'The VIPs of the cluster.'."\n", 'type' => 'string', 'example' => 'VPC_INTERNET_IPV6', 'title' => ''], + 'VpcSlbIntranetEnable' => ['description' => 'Indicates whether self-calling is enabled.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ConnectVpcId' => ['description' => 'The ID of the user VPC that is connected to the cluster if the cluster consists of VPC integration instances.'."\n", 'type' => 'string', 'example' => 'vpc-p0w3kxxxxxxxxxxxxxxxx', 'title' => ''], + 'ConnectCidrBlocks' => ['description' => 'The internal CIDR block of the user VPC that can be accessed by the cluster if the cluster consists of VPC integration instances.'."\n", 'type' => 'string', 'example' => '["192.168.1.0/24","192.168.0.0/24"]', 'title' => ''], + ], + 'title' => '', + ], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The dedicated instances contained in the cluster.'."\n", + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'tf-testacceu-central-1apigatewayinstance8752', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'apigateway-ht-04e41d95e9c1', 'title' => ''], + 'Status' => ['description' => 'The instance status.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.'."\n", 'type' => 'string', 'example' => 'Instance not found.', 'title' => ''], + ], + 'description' => '', + 'title' => '', + ], + ], + ], ], + 'InstanceClusterType' => ['description' => 'The cluster type.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', - 'title' => 'DeleteAccessControlList', - ], - 'SetAccessControlListAttribute' => [ - 'summary' => 'This feature provides instance-level access control for dedicated instances. Modifies the name of an access control policy.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeInstanceClusterInfo', + 'summary' => 'Queries the information about a dedicated instance cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterInfo'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeInstanceClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeInstanceClusterList' => [ + 'summary' => 'Queries dedicated instance clusters.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17572,30 +12764,32 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175317', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'AclName', + 'name' => 'InstanceClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testAcl', - ], + 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'test-cluster', 'title' => ''], ], [ - 'name' => 'AclId', + 'name' => 'InstanceClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-bp1ohqkonqybecf4llbrc', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -17603,65 +12797,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'InstanceClusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceCluster' => [ + 'description' => 'The instance cluster list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test-cluster', 'title' => ''], + 'InstanceClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx'."\n", 'title' => ''], + 'Description' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'Test TrafficControl', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the cluster was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-08-14T17:46:59+08:00', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the cluster was last modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-01-12T10:11:08+08:00', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the cluster.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'InstanceClusterStatus' => ['description' => 'The cluster status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'InstanceClusterType' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', - 'title' => 'SetAccessControlListAttribute', - ], - 'AddAccessControlListEntry' => [ - 'summary' => 'This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeInstanceClusterList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceClusterList'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'apigateway:DescribeInstanceClusterList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94363', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'AclId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the access control list (ACL).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-bp1ohqkonqybecf4llbrc', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-31T06:00:09Z', 'title' => ''], ], [ - 'name' => 'AclEntrys', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ACL settings.'."\n" - ."\n" - .'* entry: the entries that you want to add to the ACL. You can add CIDR blocks. Separate multiple CIDR blocks with commas (,).'."\n" - .'* comment: the description of the ACL.'."\n" - ."\n" - .'> You can add at most 50 IP addresses or CIDR blocks to an ACL in each call. If the IP address or CIDR block that you want to add to an ACL already exists, the IP address or CIDR block is not added. The entries that you add must be CIDR blocks.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{\'entry\': \'192.168.1.0/24\', \'comment\': \'test\'}]', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-31T07:00:09Z', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the dedicated instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-n6w1v1234501', 'title' => ''], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => ['description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'- Maximum'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Average', 'type' => 'string', 'required' => true, 'example' => 'Maximum', 'title' => ''], ], ], 'responses' => [ @@ -17669,61 +12910,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', 'title' => ''], + 'InstanceDropConnections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The list of dropped connections in the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The number of dropped packets in the instance.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2023-01-31T01:11:00Z', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', - 'title' => 'AddAccessControlListEntry', - ], - 'RemoveAccessControlListEntry' => [ - 'summary' => 'This feature provides instance-level access control for dedicated instances. Deletes an IP address entry from an access control policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceDropConnections', + 'summary' => 'Queries the number of lost connections to a dedicated instance within a period of time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropConnections'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the number of dropped packets within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94364', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'AclId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acl-bp12ag0xxcfhq1ll68wp9', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-06T04:00:36Z', 'title' => ''], ], [ - 'name' => 'AclEntrys', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{\\"entry\\":\\"192.168.1.0/24\\",\\"comment\\":\\"WhiteIp\\"}]', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-12-16T02:04:36Z', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v641b9dxc00p', 'title' => ''], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => ['description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'- Maximum'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Average', 'type' => 'string', 'required' => true, 'example' => 'Maximum', 'title' => ''], ], ], 'responses' => [ @@ -17731,53 +13015,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', 'title' => ''], + 'InstanceDropPacket' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The list of dropped packets in the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The number of dropped packets in the instance.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-06T04:00:36Z'."\n", 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- InstanceDropPacketRX: the number of inbound packets dropped in the instance per second.'."\n" + ."\n" + .'- InstanceDropPacketTX: the number of outbound packets dropped in the instance per second.', 'type' => 'string', 'example' => 'InstanceDropPacketRX', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\"\\n}","type":"json"}]', - 'title' => 'RemoveAccessControlListEntry', - ], - 'DescribeAccessControlListAttribute' => [ - 'summary' => 'This feature provides instance-level access control for dedicated instances. Queries the details of an access control policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceDropPacket', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDropPacket'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the distribution of HTTP status codes of requests to a dedicated instance within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '142235', - 'abilityTreeNodes' => [ - 'FEATUREapigatewaySKO2I5', - ], + 'abilityTreeCode' => '94365', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'AclId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'acl-3nsohdozz0ru8fi5onwz1', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-04-14T02:12:10Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-07-21T06:05:52Z', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the API is requested. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-m7r227yy2004', 'title' => ''], ], ], 'responses' => [ @@ -17785,129 +13124,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AclId' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'example' => 'acl-uf6fpfdg3b5muska7uqem', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'AclName' => [ - 'description' => 'The name of the access control policy.'."\n", - 'type' => 'string', - 'example' => 'testAcl', - ], - 'AclEntrys' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', 'title' => ''], + 'InstanceHttpCode' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'AclEntry' => [ - 'description' => 'The information about the access control policy.'."\n", + 'MonitorItem' => [ + 'description' => 'The HTTP status codes.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the access control policy.'."\n", 'type' => 'object', 'properties' => [ - 'AclEntryIp' => [ - 'description' => 'The ACL entry.'."\n", - 'type' => 'string', - 'example' => '192.168.1.0/24', - ], - 'AclEntryComment' => [ - 'description' => 'The entry description.'."\n", - 'type' => 'string', - 'example' => 'default', - ], + 'ItemValue' => ['description' => 'The corresponding value.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ItemTime' => ['description' => 'The HTTP status code returned.', 'type' => 'string', 'example' => '404', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'AddressIPVersion' => [ - 'description' => 'The IP protocol version. Valid values: **ipv4** and **ipv6**.'."\n", - 'type' => 'string', - 'example' => 'ipv4', + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeAccessControlListAttribute', - ], - 'DescribeAccessControlLists' => [ - 'summary' => 'This feature provides instance-level access control for dedicated instances. Queries access control policies.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceHttpCode', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceHttpCode'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '142234', - 'abilityTreeNodes' => [ - 'FEATUREapigatewaySKO2I5', - ], + 'abilityTreeCode' => '94366', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'AclName', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the access control policy.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testAcl', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-15T11:07:05Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-06T02:05:13Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The environment in which the API is requested. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'AddressIPVersion', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', - 'type' => 'string', - 'required' => false, - 'example' => 'ipv6', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v641jf5tt01v', 'title' => ''], ], ], 'responses' => [ @@ -17915,312 +13227,322 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Acls' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'InstanceLatency' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Acl' => [ - 'description' => 'The ACLs.'."\n", + 'MonitorItem' => [ + 'description' => 'The list of average latencies in the instance.', 'type' => 'array', 'items' => [ - 'description' => 'The ACL.', 'type' => 'object', 'properties' => [ - 'AclName' => [ - 'description' => 'The name of the access control policy.'."\n", - 'type' => 'string', - 'example' => 'testAcl', - ], - 'AclId' => [ - 'description' => 'The ID of the access control policy.'."\n", - 'type' => 'string', - 'example' => 'acl-3nsohdozz0ru8fi5onwz1', - ], - 'AddressIPVersion' => [ - 'description' => '访问控制策略组的IP版本。'."\n" - .'- **IPv4**。'."\n" - .'- **IPv6**。', - 'type' => 'string', - 'example' => 'ipv4', - ], + 'ItemValue' => ['description' => 'The value of the average latency.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-06T02:05:13Z'."\n", 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- gatewayLatency API: the processing latency of API Gateway'."\n" + ."\n" + .'- latency: the processing latency of the backend service.', 'type' => 'string', 'example' => 'latency', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DescribeAccessControlLists', - ], - 'DetachGroupPlugin' => [ - 'summary' => 'Unbind group plugin', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceLatency', + 'summary' => 'Queries the average latency of a dedicated instance over a period of time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceLatency'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the number of new connections to a dedicated instance within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '171235', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94367', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'API Gateway plugin ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a96926e82f994915a8da40a119374537 ', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-10-01T02:08:00Z', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'API group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-10-08T02:08:00Z', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specify the environment of the API to operate on.'."\n" - ."\n" - .'- **RELEASE**: Production'."\n" - .'- **PRE**: Pre-release'."\n" - .'- **TEST**: Test', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001', 'title' => ''], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => ['description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'- Maximum'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Average', 'type' => 'string', 'required' => true, 'example' => 'Maximum', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '3707E6FA-749C-5352-B72A-ABE95D9DEA49', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'InstanceNewConnections' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The list of new connections in the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The number of new connections in the instance.', 'type' => 'string', 'example' => '16', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-10-08T02:08:00Z'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3707E6FA-749C-5352-B72A-ABE95D9DEA49\\"\\n}","type":"json"}]', - 'title' => 'Unbind the plugin from the group', - 'translator' => 'machine', - ], - 'AttachGroupPlugin' => [ - 'summary' => 'Attach plugin to API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceNewConnections', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceNewConnections'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'abilityTreeCode' => '94368', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plug-in to be bound.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-05-18T01:14:26Z', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-05-24T10:14:53Z', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API is requested. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001', 'title' => ''], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => ['description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'- Maximum'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Average', 'type' => 'string', 'required' => true, 'example' => 'Maximum', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'InstancePackets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The list of inbound and outbound data packets in the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The number of inbound and outbound data packets in the instance.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-05-24T10:14:53Z'."\n", 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- InstancePacketRX: inbound data packets'."\n" + ."\n" + .'- InstancePacketTX: outbound data packets', 'type' => 'string', 'example' => 'InstancePacketRX', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","type":"json"}]', - 'title' => 'Attach plugin to group', - ], - 'DescribePluginsByGroup' => [ - 'summary' => 'Query Plugins Bound to API Group', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstancePackets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstancePackets'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the number of requests to a dedicated instance within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '171238', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94369', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-10T06:03:47Z', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the environment of the API to operate on.'."\n" - ."\n" - .'- **RELEASE**: Production'."\n" - .'- **PRE**: Pre-release'."\n" - .'- **TEST**: Test', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-29T06:25:00Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter: current page number', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The environment in which the API is requested. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter: number of items per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-bj-6c219f1fd5d4', 'title' => ''], ], ], 'responses' => [ @@ -18228,182 +13550,213 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'Pagination parameter: current page number', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '5F5574BA-F22B-563D-841E-C817964F517F', - ], - 'PageSize' => [ - 'description' => 'Pagination parameter: number of items per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'Total number of results returned', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'Plugins' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'InstanceQps' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'PluginAttribute' => [ - 'description' => 'Returns information about the plugins', + 'MonitorItem' => [ + 'description' => 'The list of requests sent to the APIs in the instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PluginId' => [ - 'description' => 'Plugin ID', - 'type' => 'string', - 'example' => '5e204eeb4aa94c919a49f471ad3fc716', - ], - 'ModifiedTime' => [ - 'description' => 'Last modified time, in GMT', - 'type' => 'string', - 'example' => '2022-03-15T02:30:18Z', - ], - 'PluginData' => [ - 'description' => 'Plugin definition statement', - 'type' => 'string', - 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}', - ], - 'Description' => [ - 'description' => 'Plugin description', - 'type' => 'string', - 'example' => 'traffic controll', - ], - 'PluginName' => [ - 'description' => 'Plugin name', - 'type' => 'string', - 'example' => 'firstPlugin', - ], - 'CreatedTime' => [ - 'description' => 'Creation time, in GMT', - 'type' => 'string', - 'example' => '2024-12-20T02:05:57Z', - ], - 'PluginType' => [ - 'description' => 'Plugin type', - 'type' => 'string', - 'example' => 'trafficControl', - ], - 'RegionId' => [ - 'description' => '插件所在Region', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'ItemValue' => ['description' => 'The number of requests sent to the APIs in the instance.', 'type' => 'string', 'example' => '500', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-03-29T06:25:00Z'."\n", 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"流控\\",\\n \\"PluginName\\": \\"firstPlugin\\",\\n \\"CreatedTime\\": \\"2024-12-20T02:05:57Z\\",\\n \\"PluginType\\": \\"trafficControl\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'Query Plugins Bound to API Group', - 'translator' => 'machine', - ], - 'DescribePluginGroups' => [ - 'summary' => 'Query the list of groups bound to a plugin based on the plugin ID', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceQps', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceQps'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Queries the number of concurrent connections to a dedicated instance within a period of time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '94371', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'API Gateway plugin ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1f3bde29b43d4d53989248327ff737f2', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-01T02:09:33Z', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'API group ID', - 'type' => 'string', - 'required' => false, - 'example' => '8cc2a3cbe3394524b6e71be5db9b02a3', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-15T15:07:06Z', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'API group name', - 'type' => 'string', - 'required' => false, - 'example' => 'crm_custom_service', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-sz-1574cc7c5a31', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'SbcName', 'in' => 'query', + 'schema' => ['description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'- Maximum'."\n" + ."\n" + .'- Minimum'."\n" + ."\n" + .'- Average', 'type' => 'string', 'required' => true, 'example' => 'Maximum', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'API group description', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', 'title' => ''], + 'InstanceSlbConnect' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MonitorItem' => [ + 'description' => 'The list of concurrent connections in the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemValue' => ['description' => 'The number of concurrent connections in the instance.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-09-15T15:07:06Z'."\n", 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- InstanceMaxConnection: the maximum number of connections'."\n" + ."\n" + .'- InstanceInactiveConnection: the number of inactive connections'."\n" + ."\n" + .'- InstanceActiveConnection: the number of active connections', 'type' => 'string', 'example' => 'InstanceActiveConnection', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeInstanceSlbConnect', + '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' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94372', + 'abilityTreeNodes' => ['FEATUREapigatewayWECSVA'], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter: number of items per page', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-03-31T03:42:00Z', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Pagination parameter: current page number', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-04-01T06:34:03Z', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the API runs. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST: the test environment**', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-2r426lavr001', 'title' => ''], ], ], 'responses' => [ @@ -18411,304 +13764,419 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'Pagination parameter: current page number', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '765BC99E-F583-5A80-9A42-42AC125C2CDC', - ], - 'PageSize' => [ - 'description' => 'Pagination parameter: number of items per page, default value 10', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'Total number of returned results', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'GroupSummarys' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'InstanceTraffic' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'GroupPluginSummary' => [ - 'description' => 'Collection of group information', + 'MonitorItem' => [ + 'description' => 'The traffic consumed by the requests and responses in the instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'Description', - 'type' => 'string', - 'example' => 'test', - ], - 'GroupName' => [ - 'description' => 'API group name', - 'type' => 'string', - 'example' => 'ECP_API', - ], - 'GroupId' => [ - 'description' => 'API group ID', - 'type' => 'string', - 'example' => '4ed31575e2de43de8c51eb1217a1f56b', - ], - 'BasePath' => [ - 'description' => 'API root path', - 'type' => 'string', - 'example' => '/rpew', - ], - 'StageName' => [ - 'description' => 'Environment name, possible values:'."\n" - ."\n" - .'- **RELEASE**: Production'."\n" - .'- **PRE**: Pre-release'."\n" - .'- **TEST**: Testing', - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'RegionId' => [ - 'description' => 'Region ID where the API group is located', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'StageAlias' => [ - 'description' => 'Stage name Alias', - 'type' => 'string', - 'example' => 'DEV', - ], + 'ItemValue' => ['description' => 'The amount of traffic consumed by the requests and responses in the instance.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'ItemTime' => ['description' => 'The monitoring time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'example' => '2022-04-01T06:34:03Z'."\n", 'title' => ''], + 'Item' => ['description' => 'The metric. Valid values:'."\n" + ."\n" + .'- inbound: traffic consumed by requests'."\n" + ."\n" + .'- outbound: traffic consumed by responses', 'type' => 'string', 'example' => 'inbound', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'Query the List of Groups Bound to a Plugin', - 'translator' => 'machine', - ], - 'CreatePlugin' => [ - 'summary' => 'Creates a plug-in.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeInstanceTraffic', + 'summary' => 'Queries the request traffic and response traffic of a dedicated instance within a period of time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceTraffic'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Describes the details of one or more shared or dedicated instances in a region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94278', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94370', + 'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'], ], 'parameters' => [ [ - 'name' => 'PluginName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). However, it cannot start with an underscore.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NewCors', - ], + 'schema' => ['description' => 'The instance ID. If you do not specify this parameter, all instances are queried.', 'type' => 'string', 'required' => false, 'example' => 'api-shared-vpc-001', 'title' => ''], ], [ - 'name' => 'PluginType', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the plug-in. Valid values:'."\n" - ."\n" - .'* **ipControl: IP address-based access control**'."\n" - .'* **trafficControl: throttling**'."\n" - .'* **backendSignature: backend signature**'."\n" - .'* **jwtAuth** :JWT (OpenId Connect) authentication'."\n" - .'* **cors** :cross-origin resource sharing (CORS)'."\n" - .'* **caching**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cors', - ], + 'schema' => ['description' => 'The language of the response. The descriptions of system policies are returned in this language.'."\n" + ."\n" + .'- en: English.'."\n" + ."\n" + .'- zh: Chinese.'."\n" + ."\n" + .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'PluginData', + 'name' => 'InstanceType', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The plug-in definition. Supported formats: JSON and YAML.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Plugin definition', + 'required' => false, + 'enum' => ['VPC_SHARED', 'VPC_DEDICATED'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Description', + 'name' => 'EnableTagAuthorization', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plug-in. The description can contain a maximum of 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'createPlugin', - ], + 'schema' => ['description' => 'Indicates whether to enable tag-based authorization.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The tags that are attached to the instance.', 'type' => 'array', 'items' => [ + 'description' => 'The tags that are attached to the instance.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '\' \'', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'Key, Value', 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '500', 'default' => '500', 'description' => '', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PluginId' => [ - 'description' => 'The ID of the plug-in.'."\n", - 'type' => 'string', - 'example' => '1f3bde29b43d4d53989248327ff737f2', - ], - 'TagStatus' => [ - 'description' => 'Indicates whether the plug-in is successfully marked.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceAttribute' => [ + 'description' => 'The details of the instances.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the instances.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'VpcSlbIntranetEnable' => ['description' => 'Indicates whether the internal-facing SLB for the VPC is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ClassicEgressAddress' => ['description' => 'The egress IP address of the classic network.', 'type' => 'string', 'example' => '10.0.0.1', 'title' => ''], + 'ZoneLocalName' => ['description' => 'The name of the zone.', 'type' => 'string', 'example' => 'Multi Zone 2', 'title' => ''], + 'UserVpcId' => ['description' => 'The ID of the user\'s VPC.', 'type' => 'string', 'example' => 'vpc-t***hx****yu9****t0g4', 'title' => ''], + 'VpcIntranetEnable' => ['description' => 'Indicates whether the internal-facing VPC is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'VpcOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1408453217640291****', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'api-shared-vpc-020', 'title' => ''], + 'InstanceRpsLimit' => ['description' => 'The records per second (RPS) limit of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'InstanceType' => ['description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'- VPC\\_SHARED: shared instance (VPC)'."\n" + ."\n" + .'- VPC\\_DEDICATED: dedicated instance (VPC)', 'type' => 'string', 'example' => 'VPC_SHARED', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the instance resides.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'InstanceSpec' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'api.s1.small', 'title' => ''], + 'InstanceChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- PrePaid: subscription.'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], + 'HttpsPolicies' => ['description' => 'The HTTPS security policy.', 'type' => 'string', 'example' => 'HTTPS2_TLS1_2', 'title' => ''], + 'VpcEgressAddress' => ['description' => 'The egress CIDR block of the internal-facing VPC.', 'type' => 'string', 'example' => '100.104.254.0/26', 'title' => ''], + 'NewVpcEgressAddress' => ['description' => 'The new egress CIDR block of the internal-facing VPC.', 'type' => 'string', 'example' => '100.104.253.0/26', 'title' => ''], + 'EgressIpv6Enable' => ['description' => 'Indicates whether IPv6 egress is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time of the instance.', 'type' => 'string', 'example' => '1659801600000', 'title' => ''], + 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-MAZ5(g,h)', 'title' => ''], + 'SupportIpv6' => ['description' => 'Indicates whether IPv6 is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InternetEgressAddress' => ['description' => 'The public egress IP address.', 'type' => 'string', 'example' => '47.241.89.244', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2021-10-22 15:36:53.0', 'title' => ''], + 'InstanceSpecAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SpecAttribute' => [ + 'description' => 'The details of the instance specifications.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the instance specifications.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the specification.', 'type' => 'string', 'example' => '2500', 'title' => ''], + 'LocalName' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => '最大每秒请求数', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'UserVswitchId' => ['description' => 'The ID of the user\'s vSwitch.', 'type' => 'string', 'example' => 'vsw-t4***eh****d7q****i2f', 'title' => ''], + 'AclName' => ['description' => 'The name of the access control list (ACL).', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AclType' => ['description' => 'The type of the ACL. Valid values:'."\n" + ."\n" + .'- black: blacklist'."\n" + ."\n" + .'- white: whitelist', 'type' => 'string', 'example' => 'white', 'title' => ''], + 'AclStatus' => ['description' => 'Indicates whether the ACL is enabled. Valid values:'."\n" + ."\n" + .'- **on**: enabled.'."\n" + ."\n" + .'- **off**: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AclId' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'example' => 'acl-uf6f9zfxfxtp5j9ng3yv4', 'title' => ''], + 'IntranetSegments' => ['description' => 'The internal network CIDR blocks from which the API Gateway instance can be accessed.', 'type' => 'string', 'example' => '[\\"172.36.0.0/16\\",\\"172.31.16.0/20\\"]', 'title' => ''], + 'IPV6AclName' => ['description' => 'The name of the IPv6 ACL.', 'type' => 'string', 'example' => 'testIPV6', 'title' => ''], + 'IPV6AclId' => ['description' => 'The ID of the IPv6 ACL.', 'type' => 'string', 'example' => 'acl-124resFfs235', 'title' => ''], + 'IPV6AclType' => ['description' => 'The type of the IPv6 ACL. Valid values:'."\n" + ."\n" + .'- black: blacklist'."\n" + ."\n" + .'- white: whitelist', 'type' => 'string', 'example' => 'black', 'title' => ''], + 'IPV6AclStatus' => ['description' => 'Indicates whether the IPv6 ACL is enabled. Valid values:'."\n" + ."\n" + .'- **on**: enabled.'."\n" + ."\n" + .'- **off**: disabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'DedicatedInstanceType' => ['description' => 'The type of the dedicated instance. Valid values:'."\n" + ."\n" + .'- vpc\\_connect: VPC-connected dedicated instance'."\n" + ."\n" + .'- normal: classic network-based dedicated instance', 'type' => 'string', 'example' => 'vpc_connect', 'title' => ''], + 'InstanceCidrBlock' => ['description' => 'The CIDR block where the dedicated instance resides.'."\n" + ."\n" + .'- 172.16.0.0/12'."\n" + ."\n" + .'- 192.168.0.0/16', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''], + 'ConnectVpcId' => ['description' => 'The ID of the user VPC that is connected to the VPC-connected dedicated instance.', 'type' => 'string', 'example' => 'vpc-m5eo7khlb4h4f8y9egsdg', 'title' => ''], + 'NetworkInterfaceAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetworkInterfaceAttribute' => [ + 'description' => 'The network interface details of the user VPC connected to the dedicated instance.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The network interface details of the user VPC connected to the dedicated instance.', + 'type' => 'object', + 'properties' => [ + 'VswitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-2zeqals6rbj51bhjn8b89', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group. Services in the same security group can access each other.', 'type' => 'string', 'example' => 'sg-2zeehz13zcyj1kfk3o85', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the vSwitch.', 'type' => 'string', 'example' => '192.168.17.0/24', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-shenzhen-d', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'InstanceClusterId' => ['description' => 'The ID of the dedicated instance cluster that manages this dedicated instance.', 'type' => 'string', 'example' => 'apigateway-cluster-sh-1523cafbgffd', 'title' => ''], + 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. The time is in the HH:mmZ format and is in UTC.', 'type' => 'string', 'example' => '22:00Z', 'title' => ''], + 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. The time is in the HH:mmZ format and is in UTC.', 'type' => 'string', 'example' => '01:00Z', 'title' => ''], + 'ConnectCidrBlocks' => ['description' => 'The internal CIDR blocks of the user VPC that can be accessed by the VPC-connected dedicated instance.', 'type' => 'string', 'example' => '[\\"172.16.0.0/24\\",\\"172.16.1.0/24\\"]', 'title' => ''], + 'PrivateDnsList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PrivateDns' => [ + 'description' => 'A list of internal domain names.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The internal domain name.', 'type' => 'string', 'example' => 'www.private.com', 'title' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagInfo' => [ + 'description' => 'A list of tags.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag3', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '50699_0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PluginId\\": \\"1f3bde29b43d4d53989248327ff737f2\\",\\n \\"TagStatus\\": true,\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', - 'title' => 'CreatePlugin', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The number of plug-ins of the same type that each user can create is limited. Different limits apply to different plug-in types.'."\n" - .'* The plug-in definitions for advanced features are restricted.'."\n" - .'* Plug-ins must be bound to APIs to take effect. After a plug-in is bound, it takes effect on that API immediately.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeletePlugin' => [ - 'summary' => 'Deletes a plug-in.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeInstances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Instance', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeIpControlPolicyItems' => [ + 'summary' => 'Queries the rule entries of an IP address-based traffic control policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94295', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94373', + 'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plug-in to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => false, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'PolicyItemId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '\' \'', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The ID of the policy.', 'type' => 'string', 'required' => false, 'example' => 'P151617000829241', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -18716,105 +14184,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IpControlPolicyItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IpControlPolicyItem' => [ + 'description' => 'The information about policies. The information is an array of IpControlPolicyItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => ['description' => 'The time when the policy was modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2018-01-17T06:25:13Z', 'title' => ''], + 'PolicyItemId' => ['description' => 'The ID of the policy.', 'type' => 'string', 'example' => 'P151617000829241', 'title' => ''], + 'CidrIp' => ['description' => 'The IP addresses or CIDR blocks.', 'type' => 'string', 'example' => '113.125.XX.XX;101.11.XX.XX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the policy was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2018-01-17T06:20:08Z', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => '11112', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePluginResponse>\\r\\n <RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>\\r\\n</DeletePluginResponse>","errorExample":""}]', - 'title' => 'DeletePlugin', - 'description' => '* This operation is intended for API providers.'."\n" - .'* You must first unbind the plug-in from the API. Otherwise, an error is reported when you delete the plug-in.'."\n", + 'title' => 'DescribeIpControlPolicyItems', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- You can filter the query results by policy ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AttachPlugin' => [ - 'summary' => 'Binds a plug-in to an API.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControlPolicyItems'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeIpControls' => [ + 'summary' => 'Queries custom access control lists (ACLs) on separate pages.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94249', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94374', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plug-in to be bound.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9a3f1a5279434f2ba74ccd91c295af9f ', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => false, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'IpControlName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group that contains the API to which the plug-in is to be bound.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '285bb759342649a1b70c2093a772e087', - ], + 'schema' => ['description' => 'The name of the ACL.', 'type' => 'string', 'example' => 'Access control test', 'required' => false, 'title' => ''], ], [ - 'name' => 'ApiIds', + 'name' => 'IpControlType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the API to be operated. Separate multiple numbers with commas (,). A maximum of 100 numbers can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => 'The type of the ACL. Valid values:'."\n" + ."\n" + .'- **ALLOW**: a whitelist'."\n" + ."\n" + .'- **REFUSE**: a blacklist', 'type' => 'string', 'required' => false, 'example' => 'ALLOW', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE: the pre-release environment**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the API to be bound.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '8afff6c8c4c6447abb035812e4d66b65 ', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -18822,123 +14303,194 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IpControlInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IpControlInfo' => [ + 'description' => 'The information about the ACL. The information is an array that consists of IpControlInfo data. The information does not include specific policies.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IpControlId' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], + 'IpControlType' => ['description' => 'The type of the ACL.', 'type' => 'string', 'example' => 'ALLOW', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the ACL was modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2018-01-17T06:00:38Z', 'title' => ''], + 'IpControlName' => ['description' => 'The name of the ACL.', 'type' => 'string', 'example' => 'testControl11', 'title' => ''], + 'Description' => ['description' => 'The description of the ACL.', 'type' => 'string', 'example' => 'description', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the ACL was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2018-01-17T05:48:11Z', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region in which the ACL is deployed.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachPluginResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\r\\n</AttachPluginResponse>","errorExample":""}]', - 'title' => 'AttachPlugin', - 'description' => '* This operation is intended for API providers.'."\n" - .'* You can only bind plug-ins to published APIs.'."\n" - .'* The plug-in takes effect immediately after it is bound to an API.'."\n" - .'* If you bind a different plug-in to an API, this plug-in takes effect immediately.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeIpControls', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- query the ACLs in a region. Region is a system parameter.'."\n" + ."\n" + .'- You can filter the query results by ACL ID, name, or type.'."\n" + ."\n" + .'- This operation cannot be used to query specific policies. If you want to query specific policies, call the [DescribeIpControlPolicyItems](~~DescribeIpControlPolicyItems~~) operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyPlugin' => [ - 'summary' => 'Modifies the information of a plug-in.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIpControls'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeIpControls', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeLogConfig' => [ + 'summary' => 'Queries log configurations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94447', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94375', + 'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the plug-in whose information you want to modify.'."\n", + 'description' => 'Log type.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a96926e82f994915a8da40a119374537 ', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => ['PROVIDER'], + 'example' => 'PROVIDER', + 'title' => '', ], ], - [ - 'name' => 'PluginName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). However, it cannot start with an underscore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'modifyCors', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E3BC2706-ABDB-5B64-A12F-08DFD9E3F339', 'title' => ''], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfo' => [ + 'description' => 'Log information.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SlsLogStore' => ['description' => 'The SLS log store value.', 'type' => 'string', 'example' => 'slsstore', 'title' => ''], + 'LogType' => ['description' => 'Log type.', 'type' => 'string', 'example' => 'PROVIDER', 'title' => ''], + 'SlsProject' => ['description' => 'The SLS project.', 'type' => 'string', 'example' => 'slsproject', 'title' => ''], + 'RegionId' => ['description' => 'The Simple Log Service region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeLogConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogConfig'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'PluginData', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statement that is used to modify the plug-in definition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Plugin definition', + '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' => 'Queries the number of remaining ordered relationships for a purchaser.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plug-in. The description can contain a maximum of 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'modify plugin first', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94376', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], + ], + 'parameters' => [ [ - 'name' => 'Tag', + 'name' => 'DomainName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '\' \'', - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => 'Key, Value', - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.demo.com', 'title' => ''], ], ], 'responses' => [ @@ -18946,83 +14498,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], + 'RemainsQuota' => ['description' => 'The remaining quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyPluginResponse>\\r\\n <RequestId>CE5722A6-AE78-4741-A9B0-6C817D360510</RequestId>\\r\\n</ModifyPluginResponse>","errorExample":""}]', - 'title' => 'ModifyPlugin', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The name of the plug-in must be unique.'."\n", - ], - 'DetachPlugin' => [ - 'summary' => 'Unbinds a plug-in from an API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeMarketRemainsQuota', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMarketRemainsQuota'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeMarketRemainsQuota', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94377', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'PluginId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '93b87279e54c4c0baeb7113cdf9c67f5', - ], + 'schema' => ['description' => 'The name of the model.', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the model.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => '19a2846d8e8541c788c6be740035eb68', + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -19031,28 +14601,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'PageNumber' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '40306469-2FB5-417A-B723-AF1F4A4FA204', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ModelDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModelDetail' => [ + 'description' => 'The returned information about models. It is an array consisting of ModelDetail data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => ['description' => 'The time when the model was last modified.', 'type' => 'string', 'example' => '2019-01-29T11:07:48Z', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group to which the model belongs.', 'type' => 'string', 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], + 'Description' => ['description' => 'The description of the model definition.', 'type' => 'string', 'example' => 'Model Description', 'title' => ''], + 'Schema' => ['description' => 'The definition of the model.', 'type' => 'string', 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the model was created.', 'type' => 'string', 'example' => '2019-01-29T11:07:48Z', 'title' => ''], + 'ModelId' => ['description' => 'The ID of the model.', 'type' => 'string', 'example' => '766c0b9538a04bdf974953b5576783ba', 'title' => ''], + 'ModelRef' => ['description' => 'The URI of the model.', 'type' => 'string', 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagInfo' => [ + 'description' => 'The tags of the model.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'ENV', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'ST4', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\"\\n}","type":"json"}]', - 'title' => 'DetachPlugin', + 'title' => 'DescribeModels', + 'summary' => 'Queries the created models of an API group.', + 'description' => '- Fuzzy queries are supported.', + '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribePluginApis' => [ 'summary' => 'Queries the APIs to which a specified plug-in is bound.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19063,303 +14710,176 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94378', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the gateway plug-in.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'bf6583efcef44c51adb00c4e********', - ], + 'schema' => ['description' => 'The ID of the gateway plug-in.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bf6583efcef44c51adb00c4e********', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '231a4bb81ee94da785733c29********', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => '231a4bb81ee94da785733c29********', 'title' => ''], ], [ 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.', - 'type' => 'string', - 'required' => false, - 'example' => 'c6b0dd188b0e4e408e12f926********', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => false, 'example' => 'c6b0dd188b0e4e408e12f926********', 'title' => ''], ], [ 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'API', - ], + 'schema' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'API name', 'required' => false, 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The request path of the API.', - 'type' => 'string', - 'required' => false, - 'example' => '/sendVerifyCode', - ], + 'schema' => ['description' => 'The request path of the API.', 'type' => 'string', 'required' => false, 'example' => '/sendVerifyCode', 'title' => ''], ], [ 'name' => 'Method', 'in' => 'query', - 'schema' => [ - 'description' => 'The request HTTP method of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], + 'schema' => ['description' => 'The request HTTP method of the API.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the API.', - 'type' => 'string', - 'required' => false, - 'example' => 'API description', - ], + 'schema' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'API description', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n" - .'Default value:10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries returned per page. Default value:10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the page to return.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F9C5C4A5-BC6C-57A3-839F-AB08********', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], + 'PageNumber' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F9C5C4A5-BC6C-57A3-839F-AB08********', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'ApiSummarys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ApiPluginSummary' => [ - 'description' => 'The information about APIs.'."\n", + 'description' => 'The information about APIs.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => 'accc8c68b7294b1cb4928741********', - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'API description', - ], - 'GroupName' => [ - 'description' => 'The API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'myGroup2', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '5f51f89261854fd9ad5116be********', - ], - 'Path' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/mqTest', - ], - 'Method' => [ - 'description' => 'The HTTP method of the API.'."\n", - 'type' => 'string', - 'example' => 'GET', - ], - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'fhosQueryDayOfStock_V2', - ], - 'RegionId' => [ - 'description' => 'The ID of the region in which the API resides.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'StageAlias' => [ - 'description' => 'The environment alias.'."\n", - 'type' => 'string', - 'example' => 'Production'."\n", - ], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => 'accc8c68b7294b1cb4928741********', 'title' => ''], + 'Description' => ['description' => 'The API description.', 'type' => 'string', 'example' => 'API description', 'title' => ''], + 'GroupName' => ['description' => 'The API group to which the API belongs.', 'type' => 'string', 'example' => 'myGroup2', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '5f51f89261854fd9ad5116be********', 'title' => ''], + 'Path' => ['description' => 'The request path of the API.', 'type' => 'string', 'example' => '/mqTest', 'title' => ''], + 'Method' => ['description' => 'The HTTP method of the API.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'StageName' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'fhosQueryDayOfStock_V2', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region in which the API resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'StageAlias' => ['description' => 'The environment alias.', 'type' => 'string', 'example' => 'Production', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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描述信息\\",\\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\\": \\"线上\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + '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' => 'DescribePluginApis', - ], - 'DescribePluginsByApi' => [ - 'summary' => 'Queries the plug-ins that are bound to a running API in a specified environment.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribePluginGroups' => [ + 'summary' => 'Query the list of groups bound to a plugin based on the plugin ID', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94380', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the group to which the API belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3c7a38392e764718ad7673e7b7f535d4', - ], + 'schema' => ['description' => 'API Gateway plugin ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1f3bde29b43d4d53989248327ff737f2', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '93f4ead4080c4b2da70b7f81f50ae459', - ], + 'schema' => ['description' => 'API group ID', 'type' => 'string', 'required' => false, 'example' => '8cc2a3cbe3394524b6e71be5db9b02a3', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the API is running. Valid values:'."\n" - ."\n" - .'* **RELEASE**: production'."\n" - .'* **PRE**: staging'."\n" - .'* **TEST**: test'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'API group name', 'type' => 'string', 'required' => false, 'example' => 'crm_custom_service', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'API group description', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Pagination parameter: number of items per page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Pagination parameter: current page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -19367,108 +14887,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Plugins' => [ + 'PageNumber' => ['description' => 'Pagination parameter: current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '765BC99E-F583-5A80-9A42-42AC125C2CDC', 'title' => ''], + 'PageSize' => ['description' => 'Pagination parameter: number of items per page, default value 10', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of returned results', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'GroupSummarys' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'PluginAttribute' => [ - 'description' => 'The plug-in information. The information is an array that consists of PluginAttribute data.'."\n", + 'GroupPluginSummary' => [ + 'description' => 'Collection of group information', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PluginId' => [ - 'description' => 'The plug-in ID.'."\n", - 'type' => 'string', - 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the plug-in was last modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2019-01-11T09:29:58Z', - ], - 'PluginData' => [ - 'description' => 'The definition statement of the plug-in.'."\n", - 'type' => 'string', - 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}', - ], - 'Description' => [ - 'description' => 'The plug-in description.'."\n", - 'type' => 'string', - 'example' => 'Traffic throttling'."\n", - ], - 'PluginName' => [ - 'description' => 'The plug-in name.'."\n", - 'type' => 'string', - 'example' => 'firstPlugin', - ], - 'CreatedTime' => [ - 'description' => 'The time when the plug-in was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2019-01-11T09:29:58Z', - ], - 'PluginType' => [ - 'description' => 'The plug-in type.'."\n", - 'type' => 'string', - 'example' => 'trafficControl', - ], - 'RegionId' => [ - 'description' => 'The region where the plug-in resides.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], + 'Description' => ['description' => 'Description', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupName' => ['description' => 'API group name', 'type' => 'string', 'example' => 'ECP_API', 'title' => ''], + 'GroupId' => ['description' => 'API group ID', 'type' => 'string', 'example' => '4ed31575e2de43de8c51eb1217a1f56b', 'title' => ''], + 'BasePath' => ['description' => 'API root path', 'type' => 'string', 'example' => '/rpew', 'title' => ''], + 'StageName' => ['description' => 'Environment name, possible values:'."\n" + ."\n" + .'- **RELEASE**: Production'."\n" + ."\n" + .'- **PRE**: Pre-release'."\n" + ."\n" + .'- **TEST**: Testing', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'RegionId' => ['description' => 'Region ID where the API group is located', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'StageAlias' => ['description' => 'Stage name Alias', 'type' => 'string', 'example' => 'DEV', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"流控\\",\\n \\"PluginName\\": \\"firstPlugin\\",\\n \\"CreatedTime\\": \\"2019-01-11T09:29:58Z\\",\\n \\"PluginType\\": \\"trafficControl\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribePluginsByApi', - 'description' => '* This operation is intended for API callers.'."\n" - .'* This operation supports pagination.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribePluginSchemas' => [ - 'summary' => 'Describes the plug-in modes supported by API Gateway.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query the List of Groups Bound to a Plugin', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginGroups'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Describes the schemas for plug-ins supported by API Gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19479,20 +14972,19 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94381', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'The language of the plug-in descriptions in the response. Valid values:'."\n" + ."\n" + .'- zh-CN (default): Chinese.'."\n" + ."\n" + .'- en: English.'."\n" + ."\n" + .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], ], 'responses' => [ @@ -19500,69 +14992,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', 'title' => ''], 'PluginSchemas' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PluginSchema' => [ - 'description' => '', + 'description' => 'The list of plug-in schemas.', + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The list of plug-in schemas.', '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' => '', - 'type' => 'string', - 'example' => '4107**', - ], - 'SupportClassic' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Title' => ['description' => 'The title of the plug-in.', 'type' => 'string', 'example' => 'plugin schema title', 'title' => ''], + 'Description' => ['description' => 'The description of the plug-in.', 'type' => 'string', 'example' => 'plugin scheme description', 'title' => ''], + 'Name' => ['description' => 'The name of the plug-in.', 'type' => 'string', 'example' => 'VPC_C', 'title' => ''], + 'DocumentId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => '4107**', 'title' => ''], + 'SupportClassic' => ['description' => 'Indicates whether categorization is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', 'title' => 'DescribePluginSchemas', - ], - 'DescribePluginTemplates' => [ - 'summary' => '查询插件模板', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginSchemas'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Query plugin templates', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19573,34 +15065,24 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94382', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ 'name' => 'PluginName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jwtAuth', - ], + 'schema' => ['description' => 'The name of the API Gateway plugin.', 'type' => 'string', 'required' => false, 'example' => 'jwtAuth', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The language that is used to return the description of the system policy. Valid values:'."\n" - ."\n" - .'* en: English'."\n" - .'* zh-CN: Chinese.'."\n" - .'* ja: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language. The description of the system policy is returned in this language.'."\n" + ."\n" + .'- en: English.'."\n" + ."\n" + .'- zh-CN: Chinese.'."\n" + ."\n" + .'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -19608,69 +15090,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], 'Templates' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Template' => [ - 'description' => 'The templates.'."\n", + 'description' => 'The list of templates.', + 'title' => '', 'type' => 'array', 'items' => [ - 'description' => 'The templates.'."\n", + 'description' => 'Template list', 'type' => 'object', 'properties' => [ - 'Title' => [ - 'description' => 'The title of the plug-in template title.'."\n", - 'type' => 'string', - 'example' => 'template title', - ], - 'DocumentAnchor' => [ - 'description' => 'The document anchor point.'."\n", - 'type' => 'string', - 'example' => 'anchor', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'balabala', - ], - 'DocumentId' => [ - 'description' => 'The ID of the document.'."\n", - 'type' => 'string', - 'example' => '41079', - ], - 'Sample' => [ - 'description' => 'The sample.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'Title' => ['description' => 'The title of the plugin template.', 'type' => 'string', 'example' => 'template title', 'title' => ''], + 'DocumentAnchor' => ['description' => 'The document anchor.', 'type' => 'string', 'example' => 'anchor', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'balabala', 'title' => ''], + 'DocumentId' => ['description' => 'The document ID.', 'type' => 'string', 'example' => '41079', 'title' => ''], + 'Sample' => ['description' => 'The sample.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', 'title' => 'DescribePluginTemplates', + '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' => 'All Resource', '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' => 'Queries API Gateway plug-ins and the details of the plug-ins.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19681,100 +15163,60 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '94379', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a96926e82f994915a8da40a119374537 ', - ], + 'schema' => ['description' => 'The ID of the plug-in.', 'type' => 'string', 'required' => false, 'example' => 'a96926e82f994915a8da40a119374537 ', 'title' => ''], ], [ 'name' => 'PluginType', 'in' => 'query', - 'schema' => [ - 'description' => 'The business type of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cors', - ], + 'schema' => ['description' => 'The business type of the plug-in.', 'type' => 'string', 'required' => false, 'example' => 'cors', 'title' => ''], ], [ 'name' => 'PluginName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testPlugin', - ], + 'schema' => ['description' => 'The name of the plug-in.', 'type' => 'string', 'required' => false, 'example' => 'testPlugin', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", + 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n" - ."\n" - .'N can be an integer from 1 to 20.``'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\' \'', - ], + 'Key' => ['description' => 'The key of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => false, 'example' => '\' \'', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'example' => 'Key, Value', 'maxItems' => 500, + 'title' => '', ], ], ], @@ -19783,211 +15225,153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Plugins' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PluginAttribute' => [ - 'description' => 'The returned information about the plug-in. It is an array consisting of PluginAttribute data.'."\n", + 'description' => 'The returned information about the plug-in. It is an array consisting of PluginAttribute data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PluginId' => [ - 'description' => 'The ID of the plug-in.'."\n", - 'type' => 'string', - 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the plug-in.'."\n", - 'type' => 'string', - 'example' => '2019-01-11T09:29:58Z', - ], - 'PluginData' => [ - 'description' => 'The definition statement of the plug-in.'."\n", - 'type' => 'string', - 'example' => '{"unit":"MINUTE","apiDefault":20}', - ], - 'Description' => [ - 'description' => 'The plug-in description.'."\n", - 'type' => 'string', - 'example' => 'Throttling'."\n", - ], - 'PluginName' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'firstPlugin', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the plug-in.'."\n", - 'type' => 'string', - 'example' => '2019-01-11T09:29:58Z', - ], - 'PluginType' => [ - 'description' => 'The type of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'trafficControl', - ], - 'RegionId' => [ - 'description' => 'The region where the plug-in is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], + 'PluginId' => ['description' => 'The ID of the plug-in.', 'type' => 'string', 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the plug-in.', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z', 'title' => ''], + 'PluginData' => ['description' => 'The definition statement of the plug-in.', 'type' => 'string', 'example' => '{"unit":"MINUTE","apiDefault":20}', 'title' => ''], + 'Description' => ['description' => 'The plug-in description.', 'type' => 'string', 'example' => 'Throttling', 'title' => ''], + 'PluginName' => ['description' => 'The name of the plug-in.', 'type' => 'string', 'example' => 'firstPlugin', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time (UTC) of the plug-in.', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z', 'title' => ''], + 'PluginType' => ['description' => 'The type of the plug-in.', 'type' => 'string', 'example' => 'trafficControl', 'title' => ''], + 'RegionId' => ['description' => 'The region where the plug-in is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagInfo' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'testkey', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'tetstvalue', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'testkey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'tetstvalue', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"流控\\",\\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":"<DescribePluginsResponse>\\r\\n <RequestId>46373DC4-19F1-4DC8-8C31-1107289BB5E0</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <Plugins>\\r\\n <PluginAttribute>\\r\\n <PluginId>9a3f1a5279434f2ba74ccd91c295af9f</PluginId>\\r\\n <PluginName>firstPlugin</PluginName>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <PluginType>trafficControl</PluginType>\\r\\n <PluginData>{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}</PluginData>\\r\\n <Description>流控</Description>\\r\\n <CreatedTime>2019-01-11T09:29:58Z</CreatedTime>\\r\\n <ModifiedTime>2019-01-11T09:29:58Z</ModifiedTime>\\r\\n </PluginAttribute>\\r\\n </Plugins>\\r\\n</DescribePluginsResponse>","errorExample":""}]', + '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 \\"Tags\\": {\\n \\"TagInfo\\": [\\n {\\n \\"Key\\": \\"testkey\\",\\n \\"Value\\": \\"tetstvalue\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribePlugins', - 'description' => '* This operation supports pagination.'."\n" - .'* This operation allows you to query plug-ins by business type.'."\n" - .'* This operation allows you to query plug-ins by ID.'."\n" - .'* This operation allows you to query plug-ins by name.'."\n", + 'description' => '- This operation supports pagination.'."\n" + ."\n" + .'- This operation allows you to query plug-ins by business type.'."\n" + ."\n" + .'- This operation allows you to query plug-ins by ID.'."\n" + ."\n" + .'- This operation allows you to query plug-ins by name.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDataset' => [ - 'summary' => 'Creates a custom dataset.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlugins'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribePluginsByApi' => [ + 'summary' => 'Queries the plug-ins that are bound to a running API in a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayE6KZ22', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94380', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'DatasetName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DatasetName', - ], + 'schema' => ['description' => 'The ID of the group to which the API belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3c7a38392e764718ad7673e7b7f535d4', 'title' => ''], ], [ - 'name' => 'DatasetType', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the dataset. Valid values:'."\n" - ."\n" - .'* JWT_BLOCKING: a JSON Web Token (JWT) blacklist'."\n" - .'* IP_WHITELIST_CIDR : an IP address whitelist'."\n" - .'* PARAMETER_ACCESS : parameter-based access control', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'JWT_BLOCKING', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '93f4ead4080c4b2da70b7f81f50ae459', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The environment in which the API is running. Valid values:'."\n" + ."\n" + .'- **RELEASE**: production'."\n" + ."\n" + .'- **PRE**: staging'."\n" + ."\n" + .'- **TEST**: test', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -19995,86 +15379,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'example' => 'a25a6589b2584ff490e891cc********', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4173F95B-360C-460C-9F6C-4A96********', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '46373DC4-19F1-4DC8-8C31-1107289BB5E0', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Plugins' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PluginAttribute' => [ + 'description' => 'The plug-in information. The information is an array that consists of PluginAttribute data.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PluginId' => ['description' => 'The plug-in ID.', 'type' => 'string', 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the plug-in was last modified. The time is displayed in UTC.', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z', 'title' => ''], + 'PluginData' => ['description' => 'The definition statement of the plug-in.', 'type' => 'string', 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}', 'title' => ''], + 'Description' => ['description' => 'The plug-in description.', 'type' => 'string', 'example' => 'Throttling', 'title' => ''], + 'PluginName' => ['description' => 'The plug-in name.', 'type' => 'string', 'example' => 'firstPlugin', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the plug-in was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2019-01-11T09:29:58Z', 'title' => ''], + 'PluginType' => ['description' => 'The plug-in type.', 'type' => 'string', 'example' => 'trafficControl', 'title' => ''], + 'RegionId' => ['description' => 'The region where the plug-in resides.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DatasetId\\": \\"a25a6589b2584ff490e891cc********\\",\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A96********\\"\\n}","type":"json"}]', - 'title' => 'CreateDataset', - ], - 'CreateDatasetItem' => [ - 'summary' => 'Creates a data entry in a custom dataset.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribePluginsByApi', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- This operation supports pagination.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginsByApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribePluginsByGroup' => [ + 'summary' => 'Query Plugins Bound to API Group', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'abilityTreeCode' => '171238', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********', - ], + 'schema' => ['description' => 'Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], ], [ - 'name' => 'Value', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '106.43.XXX.XXX', - ], + 'schema' => ['description' => 'Specifies the environment of the API to operate on.'."\n" + ."\n" + .'- **RELEASE**: Production'."\n" + ."\n" + .'- **PRE**: Pre-release'."\n" + ."\n" + .'- **TEST**: Test', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'ExpiredTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-09-22T12:00:00Z', - ], + 'schema' => ['description' => 'Pagination parameter: current page number', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Pagination parameter: number of items per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -20082,54 +15500,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DatasetItemId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5045****', - ], - 'RequestId' => [ + 'PageNumber' => ['description' => 'Pagination parameter: current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '5F5574BA-F22B-563D-841E-C817964F517F', 'title' => ''], + 'PageSize' => ['description' => 'Pagination parameter: number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of results returned', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'Plugins' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PluginAttribute' => [ + 'description' => 'Returns information about the plugins', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PluginId' => ['description' => 'Plugin ID', 'type' => 'string', 'example' => '5e204eeb4aa94c919a49f471ad3fc716', 'title' => ''], + 'ModifiedTime' => ['description' => 'Last modified time, in GMT', 'type' => 'string', 'example' => '2022-03-15T02:30:18Z', 'title' => ''], + 'PluginData' => ['description' => 'Plugin definition statement', 'type' => 'string', 'example' => '{\\"unit\\":\\"MINUTE\\",\\"apiDefault\\":20}', 'title' => ''], + 'Description' => ['description' => 'Plugin description', 'type' => 'string', 'example' => 'Throttling', 'title' => ''], + 'PluginName' => ['description' => 'Plugin name', 'type' => 'string', 'example' => 'firstPlugin', 'title' => ''], + 'CreatedTime' => ['description' => 'Creation time, in GMT', 'type' => 'string', 'example' => '2024-12-20T02:05:57Z', 'title' => ''], + 'PluginType' => ['description' => 'Plugin type', 'type' => 'string', 'example' => 'trafficControl', 'title' => ''], + 'RegionId' => ['description' => 'Where the plug-in resides Region', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '8A5E2053-4D9F-5280-B7A9-D357********', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"RequestId\\": \\"8A5E2053-4D9F-5280-B7A9-D357********\\"\\n}","type":"json"}]', - 'title' => 'CreateDatasetItem', - ], - 'DeleteDataset' => [ - 'summary' => 'Deletes a custom dataset.', - 'methods' => [ - 'post', - 'get', + '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' => 'Query Plugins Bound to API Group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePluginsByGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginsByGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribePurchasedApiGroup' => [ + 'summary' => 'Queries the details about an API group purchased from Alibaba Cloud Marketplace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'abilityTreeCode' => '94387', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'example' => '102b631ae1094e33a77c45312226184e', 'title' => ''], ], ], 'responses' => [ @@ -20137,60 +15594,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'Status' => ['description' => 'The status of the API group.'."\n" + ."\n" + .'- **NORMAL**: The API group is normal.'."\n" + ."\n" + .'- **DELETE**: The API group is deleted.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'PurchasedTime' => ['description' => 'The time when the API group was purchased.', 'type' => 'string', 'example' => '2021-12-19T00:00:00', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '48977d7b96074966a7c9c2a8872d7e06', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'Weather', 'title' => ''], + 'Description' => ['description' => 'The description of the API group.', 'type' => 'string', 'example' => 'api group description', 'title' => ''], + 'RegionId' => ['description' => 'The region where the API group is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Domains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainItem' => [ + 'description' => 'The list of domain names.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of domain names.', + 'type' => 'object', + 'properties' => [ + 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'test_domain.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '048C8EFB-528F-5E97-8A3D-D17B********', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"048C8EFB-528F-5E97-8A3D-D17B********\\"\\n}","type":"json"}]', - 'title' => 'DeleteDataset', - ], - 'DeleteDatasetItem' => [ - 'summary' => 'Deletes a data entry from a custom dataset.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribePurchasedApiGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'abilityTreeCode' => '94388', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********'."\n", - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DatasetItemId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data entry.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5045****', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -20198,155 +15690,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FF433E09-663A-5F5D-9DBA-A611********', + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PurchasedApiGroupAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PurchasedApiGroupAttribute' => [ + 'description' => 'The attributes of the API group.'."\n", + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'The attributes of the API group.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the API group.'."\n" + ."\n" + .'* **NORMAL**: The API group is normal.'."\n" + .'* **DELETE**: The API group is deleted.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'PurchasedTime' => ['description' => 'The time when the API group was purchased.'."\n", 'type' => 'string', 'example' => '2021-12-19T00:00:00', 'title' => ''], + 'ExpireTime' => ['description' => 'The time when the API group expires.'."\n", 'type' => 'string', 'example' => '2021-12-19T00:00:00', 'title' => ''], + 'Description' => ['description' => 'The description of the API group.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.'."\n", 'type' => 'string', 'example' => 'group1', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.'."\n", 'type' => 'string', 'example' => '8e91f23f88f94348855b82c9a73209f3', 'title' => ''], + 'InvokeTimesMax' => ['description' => 'The maximum number of calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'InvokeTimesNow' => ['description' => 'The current number of calls.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'BillingType' => ['description' => 'The billing method.'."\n", 'type' => 'string', 'example' => 'POSTPAID', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the API group is located.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + ], + 'title' => '', + ], + ], + ], ], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF433E09-663A-5F5D-9DBA-A611********\\"\\n}","type":"json"}]', - 'title' => 'DeleteDatasetItem', - ], - 'ModifyDataset' => [ - 'summary' => 'Modifies the name of a custom dataset.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribePurchasedApiGroups', + 'summary' => 'Queries the API groups purchased from Alibaba Cloud Marketplace.', + 'changeSet' => [ + ['createdAt' => '2022-07-22T07:30:50.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApiGroups'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePurchasedApiGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'], + ], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayE6KZ22', + ], + 'DescribePurchasedApis' => [ + 'summary' => 'Queries the APIs purchased in the Alibaba Cloud Marketplace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********'."\n", - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'example' => 'd27ad517be5f4c95ac3631780a8f4d50', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'NewDatasetName', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876********', - ], - ], - 'description' => '', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876********\\"\\n}","type":"json"}]', - 'title' => 'ModifyDataset', - ], - 'ModifyDatasetItem' => [ - 'summary' => 'Modifies the timeout period and description of a data entry in a custom dataset.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********', - ], + 'schema' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'CZ IP database query API', 'required' => false, 'title' => ''], ], [ - 'name' => 'DatasetItemId', + 'name' => 'Visibility', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data entry.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5045****'."\n", - ], + 'schema' => ['description' => 'Specifies whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: indicates that the API is public. If you set this parameter to PUBLIC, this API is displayed on the API List page in the console for all users after the API is published to the production environment.'."\n" + ."\n" + .'- **PRIVATE**: indicates that the API is private. If you set this parameter to PRIVATE, this API is not displayed in Alibaba Cloud Marketplace after the API group to which this API belongs is made available.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', 'title' => ''], ], [ - 'name' => 'ExpiredTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2022-09-22T12:00:00Z', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data entry. The description cannot exceed 180 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -20354,56 +15820,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F7DE77BC-0F7D-5A18-B494-BD2C********', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PurchasedApis' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PurchasedApi' => [ + 'description' => 'The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The monitoring information about API call delays. The returned information is an array consisting of purchased APIs.', + 'type' => 'object', + 'properties' => [ + 'Visibility' => ['description' => 'Indicates whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**'."\n" + ."\n" + .'- **PRIVATE**', 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'PurchasedTime' => ['description' => 'The time when the API was purchased.', 'type' => 'string', 'example' => '2021-06-11T13:57:38+08:00', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => 'eb6e54c1576d41149746e8e69b0a0792', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the API.', 'type' => 'string', 'example' => '2021-06-11T13:57:38+08:00', 'title' => ''], + 'Description' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'DMS_DEFAULT_GROUP_408589', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group to which the API belongs. This ID is generated by the system and globally unique.', 'type' => 'string', 'example' => '3013a55c0c44483f984d26df27120513', 'title' => ''], + 'DeployedTime' => ['description' => 'The deployment time. Format: yyyy-mm-ddhh:mm:ss.', 'type' => 'string', 'example' => '2021-06-1113:57:38', 'title' => ''], + 'StageName' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'example' => 'TEST', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'gw_rado_tissot_', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region in which the API is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7DE77BC-0F7D-5A18-B494-BD2C********\\"\\n}","type":"json"}]', - 'title' => 'ModifyDatasetItem', - ], - 'DescribeDatasetInfo' => [ - 'summary' => 'Queries the information about a single dataset.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribePurchasedApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePurchasedApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the Alibaba Cloud regions that are supported by API Gateway.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '155066', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeCode' => '94396', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25a6589b2584ff490e891cc********', - ], + 'schema' => ['description' => 'The language in which you want to return the descriptions of the access control policies. Valid values:'."\n" + ."\n" + .'- zh-CN (default value): Chinese'."\n" + ."\n" + .'- en: English'."\n" + ."\n" + .'- ja: Japanese', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -20411,155 +15932,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A2C8F75E-EE84-5C64-960F-45C8********', - ], - 'DatasetInfo' => [ - 'description' => 'The dataset info.', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', 'title' => ''], + 'Regions' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'DatasetId' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'example' => '62b91a790a693238********', - ], - 'DatasetName' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'example' => 'DatasetName', - ], - 'DatasetType' => [ - 'description' => 'The type of the dataset. Valid values:'."\n" - ."\n" - .'* JWT_BLOCKING: a JSON Web Token (JWT) blacklist'."\n" - .'* IP_WHITELIST_CIDR : an IP address whitelist'."\n" - .'* PARAMETER_ACCESS : parameter-based access control'."\n", - 'type' => 'string', - 'example' => 'JWT_BLOCKING', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the dataset.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the dataset.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z', - ], - 'Description' => [ - 'type' => 'string', + 'Region' => [ + 'description' => 'The returned region information. It is an array that consists of Region data.', + 'example' => 'cn-huhehaote', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['description' => 'The endpoint of the service for the region.', 'type' => 'string', 'example' => 'apigateway.cn-shenzhen.aliyuncs.com', 'title' => ''], + 'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Shenzhen)', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeDatasetInfo', - ], - 'DescribeDatasetList' => [ - 'summary' => 'Queries custom datasets.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeRegions', + 'description' => 'This operation queries regions in which API Gateway is available.'."\n" + ."\n" + .'- This operation is intended for API providers and callers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'DescribeSignatures' => [ + 'summary' => 'Queries backend signature keys.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '155070', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeCode' => '94399', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'DatasetIds', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the datasets.', - 'type' => 'string', - 'required' => false, - 'example' => '4add6a61804e47858266883e********', - ], + 'schema' => ['description' => 'The IDs of the keys to query.', 'type' => 'string', 'required' => false, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'DatasetName', + 'name' => 'SignatureName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IPwhitelist', - ], + 'schema' => ['description' => 'The names of the keys to query.', 'type' => 'string', 'required' => false, 'example' => 'backendsignature', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Specify the object labels to which the rule applies, and multiple labels can be set', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -20567,154 +16023,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D403C6E6-21B3-5B78-82DA-E3B6********', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'DatasetInfoList' => [ - 'description' => 'The returned dataset information. It is an array consisting of datasetinfo.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DatasetId' => [ - 'description' => 'The dataset ID.'."\n", - 'type' => 'string', - 'example' => '6304ce6b4ae6453f********', - ], - 'DatasetName' => [ - 'description' => 'The dataset name.'."\n", - 'type' => 'string', - 'example' => 'DatasetName', - ], - 'DatasetType' => [ - 'description' => 'The dataset type. Valid values:'."\n" - ."\n" - .'* JWT_BLOCKING : a JSON Web Token (JWT) blacklist'."\n" - .'* IP_WHITELIST_CIDR : an IP address whitelist'."\n" - .'* PARAMETER_ACCESS: a list of parameters for parameter-based access control'."\n", - 'type' => 'string', - 'example' => 'IP_WHITELIST_CIDR', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the dataset was last modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z'."\n", - ], - 'CreatedTime' => [ - 'description' => 'The time when the dataset was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z'."\n", - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'example' => 'ENV', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'example' => '123', - ], - ], - 'description' => 'The tags.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'SignatureInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SignatureInfo' => [ + 'description' => 'The returned signature information. It is an array consisting of SignatureInfo data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => ['description' => 'The last modification time of the key.', 'type' => 'string', 'example' => '2016-07-24T08:28:48Z', 'title' => ''], + 'SignatureId' => ['description' => 'The ID of the backend signature key.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'SignatureSecret' => ['description' => 'The Secret value of the backend signature key.', 'type' => 'string', 'example' => 'asdfghjkl', 'title' => ''], + 'SignatureName' => ['description' => 'The name of the backend signature key.', 'type' => 'string', 'example' => 'backendsignature', 'title' => ''], + 'SignatureKey' => ['description' => 'The Key value of the backend signature key.', 'type' => 'string', 'example' => 'qwertyuiop', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time of the key.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'RegionId' => ['description' => 'The region where the key is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'type' => 'string', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeDatasetList', - ], - 'DescribeDatasetItemInfo' => [ - 'summary' => 'Queries a data entry in a custom dataset.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeSignatures', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- query the backend signature keys in a Region. Region is a system parameter.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignatures'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeSignatures', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Signature', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:secretkey/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeSignaturesByApi' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '155080', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'abilityTreeCode' => '94400', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '62b91a790a693238********', - ], + 'schema' => ['description' => 'The ID of the group to which the API belongs.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'DatasetItemId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data entry.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '5045****', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], ], [ - 'name' => 'Value', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The value of the data entry.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '106.43.XXX.XXX'."\n", - ], + 'schema' => ['description' => 'The runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -20722,70 +16132,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5BAFA85F-38E3-5D9E-9E32-4B09********', - ], - 'DatasetItemInfo' => [ - 'description' => 'The Dataset information.', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'Signatures' => [ 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'DatasetId' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'example' => '626238665db4a5140eea3e40********', - ], - 'DatasetItemId' => [ - 'description' => 'The ID of the data entry.'."\n", - 'type' => 'string', - 'example' => '5045****', - ], - 'Value' => [ - 'description' => 'The value of the data entry.'."\n", - 'type' => 'string', - 'example' => '106.43.XXX.XXX', - ], - 'ExpiredTime' => [ - 'description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format. If this parameter is empty, the data entry does not expire.'."\n", - 'type' => 'string', - 'example' => '2022-09-22T12:00:00Z'."\n", - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the data entry.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z'."\n", - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the data entry.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z'."\n", - ], - 'Description' => [ - 'description' => 'The description of the data entry.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", + 'SignatureItem' => [ + 'description' => 'The returned signature key information. It is an array consisting of SignatureItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundTime' => ['description' => 'The time when the key was bound.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'SignatureId' => ['description' => 'The ID of the backend signature key.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'SignatureName' => ['description' => 'The name of the backend signature key.', 'type' => 'string', 'example' => 'mysecret', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"描述信息\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeDatasetItemInfo', - ], - 'DescribeDatasetItemList' => [ - 'summary' => 'Queries the data entries of a custom dataset.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeSignaturesByApi', + 'summary' => 'Queries the backend signature keys that are bound to a specified API.', + 'description' => '- This API is intended for API providers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSignaturesByApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeSignaturesByApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeStageModels' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20794,54 +16202,30 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '155090', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '103436', + 'abilityTreeNodes' => ['FEATUREapigatewayN14L0I'], ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'StageAlias', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '602e1f6b3543200eaab0a89e********', - ], + 'schema' => ['description' => 'The alias of the stage.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '生产环境', 'title' => ''], ], [ - 'name' => 'DatasetItemIds', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data entry. You can enter multiple IDs. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5045****'."\n", - ], + 'schema' => ['description' => 'The name of the stage.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RELEASE', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -20849,179 +16233,243 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C6E9C6E4-608B-5C0F-9783-E288********', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'DatasetItemInfoList' => [ + 'PageNumber' => ['description' => 'The number of the page returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZxxx', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'StageModelInfoList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'description' => 'The ID of the dataset.'."\n", - 'type' => 'string', - 'example' => ' '."\n" - .'4add6a61804e47858266883e********'."\n", - ], - 'DatasetItemId' => [ - 'description' => 'The ID of the data entry.'."\n", - 'type' => 'string', - 'example' => '5045****', - ], - 'Value' => [ - 'description' => 'The value of the data entry.'."\n", - 'type' => 'string', - 'example' => '106.43.XXX.XXX', - ], - 'ExpiredTime' => [ - 'description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format. If this parameter is empty, the data entry does not expire.'."\n", - 'type' => 'string', - 'example' => '2022-09-22T12:00:00Z', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the data entry.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z', - ], - 'CreatedTime' => [ - 'description' => 'The time when the data entry was created.'."\n", - 'type' => 'string', - 'example' => '2022-09-21T12:58:43Z', - ], - 'Description' => [ - 'description' => 'The description of the data entry.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], + 'StageModelId' => ['description' => 'The ID of the stage model.', 'type' => 'string', 'example' => 'j3j435j23l4j23l55xxx', 'title' => ''], + 'StageAlias' => ['description' => 'The alias of the stage.', 'type' => 'string', 'example' => '生产环境', 'title' => ''], + 'StageName' => ['description' => 'The name of the stage.', 'type' => 'string', 'example' => 'PRE', 'title' => ''], + 'Type' => ['description' => 'The stage type.', 'type' => 'string', 'example' => 'CUSTOM', 'title' => ''], + 'Description' => ['description' => 'The description of the stage.', 'type' => 'string', 'example' => 'Stage description', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2024-12-10T00:01:09Z', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-08-13T01:54:03Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => 'The Dataset information.', + 'description' => 'A list of stage models.', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"描述信息\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDatasetItemList', + 'title' => 'DescribeStageModels', + 'summary' => 'Retrieves a list of stage models.', + 'description' => '- This operation supports fuzzy search.', + '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"}]', ], - 'CreateModel' => [ - 'summary' => 'Creates a model for an API group.', - 'methods' => [ - 'post', - 'get', + 'DescribeSummaryData' => [ + 'summary' => 'Queries the number of API Gateway resources in a 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' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'UsageGroupNum' => ['description' => 'The number of API groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UsageInstanceNum' => ['description' => 'The number of running dedicated instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'UsageApiNum' => ['description' => 'The number of APIs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ExpireInstanceNum' => ['description' => 'The number of subscription dedicated instances that expire in 14 days or less.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DescribeSummaryData', + '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' => 'All Resource', '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' => 'Queries the common parameters supported by the system.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94275', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', + 'operationType' => 'get', + 'abilityTreeCode' => '94406', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0CCDF65E-6050-412D-AD68-FA3D9196836C', 'title' => ''], + 'SystemParams' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParamItem' => [ + 'description' => 'The returned information about system parameters. It is an array that consists of SystemParam data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => ['description' => 'Examples', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''], + 'Description' => ['description' => 'The description of a parameter.', 'type' => 'string', 'example' => 'Client IP', 'title' => ''], + 'ParamName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'CaClientIp', 'title' => ''], + 'ParamType' => ['description' => 'The type of the parameter.', 'type' => 'string', 'example' => 'string', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeSystemParameters', + 'description' => '- This API is intended for API callers.'."\n" + ."\n" + .'- The response of this API contains the system parameters that are optional in API definitions.', + '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' => 'All Resource', 'arn' => '*'], + ], + ], ], ], + 'translator' => 'manual', + ], + 'DescribeTrafficControls' => [ + 'summary' => 'Queries custom throttling policies and their details. Conditional queries are supported.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94409', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], + ], 'parameters' => [ [ - 'name' => 'ModelName', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model. The name must be unique within the group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test', - ], + 'schema' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'required' => false, 'example' => 'tf123456', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group to which the model belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], + 'schema' => ['description' => 'The specified group ID. This parameter must be specified together with ApiId and StageName.', 'type' => 'string', 'required' => false, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The definition of the model in JSON Schema.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}', - ], + 'schema' => ['description' => 'The specified API ID. This parameter must be specified together with GroupId and StageName.', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the model definition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Model Description', - ], + 'schema' => ['description' => 'The environment name. This parameter must be specified together with GroupId and ApiId. Valid values:\\*\\*\\*\\*\\*\\*\\*\\*'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'TrafficControlName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The values of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The name of the throttling policy.', 'type' => 'string', 'example' => 'Throttling test', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -21029,113 +16477,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the model is last modified.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T09:33:01Z', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', - ], - 'Description' => [ - 'description' => 'The description of the created model.'."\n", - 'type' => 'string', - 'example' => 'Model Description', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group to which the created model belongs.'."\n", - 'type' => 'string', - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], - 'Schema' => [ - 'description' => 'The definition of the created model.'."\n", - 'type' => 'string', - 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', - ], - 'ModelName' => [ - 'description' => 'The name of the created model.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - 'CreatedTime' => [ - 'description' => 'The time when the model was created.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T09:33:01Z', - ], - 'ModelId' => [ - 'description' => 'The ID of the created model.'."\n", - 'type' => 'string', - 'example' => '766c0b9538a04bdf974953b5576783ba', - ], - 'RegionId' => [ - 'description' => 'The region to which the created model belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'ModelRef' => [ - 'description' => 'The URI of the created model.'."\n", - 'type' => 'string', - 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '93D91A99-F093-4596-87BA-3C4FBFD3FD8A', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TrafficControls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficControl' => [ + 'description' => 'The returned throttling policy information. It is an array consisting of TrafficControl data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserDefault' => ['description' => 'The default throttling value for each user.', 'type' => 'integer', 'format' => 'int32', 'example' => '15000', 'title' => ''], + 'ApiDefault' => ['description' => 'The default throttling value for each API.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time (UTC) of the throttling policy.', 'type' => 'string', 'example' => '2016-01-27T10:34:38Z', 'title' => ''], + 'Description' => ['description' => 'The description of the throttling policy.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TrafficControlUnit' => ['description' => 'The unit to be used in the throttling policy. Valid values:'."\n" + ."\n" + .'- MINUTE'."\n" + ."\n" + .'- HOUR'."\n" + ."\n" + .'- DAY', 'type' => 'string', 'example' => 'Minute', 'title' => ''], + 'TrafficControlName' => ['description' => 'The name of the throttling policy.', 'type' => 'string', 'example' => 'wulingtestq1', 'title' => ''], + 'AppDefault' => ['description' => 'The default throttling value for each app.', 'type' => 'integer', 'format' => 'int32', 'example' => '8000', 'title' => ''], + 'TrafficControlId' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'example' => 'cfed6c970d45481dbe136d6b5ac68c41', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time (UTC) of the throttling policy.', 'type' => 'string', 'example' => '2016-01-27T10:19:39Z', 'title' => ''], + 'SpecialPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SpecialPolicy' => [ + 'description' => 'The returned information about a special throttling policy. It is an array consisting of SpecialPolicy data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpecialType' => ['description' => 'The type of the special throttling policy. Valid values:'."\n" + ."\n" + .'- **APP**'."\n" + ."\n" + .'- **USER**', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'Specials' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Special' => [ + 'description' => 'The returned information about a special throttling policy. It is an array consisting of Special data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => ['description' => 'The throttling value.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'SpecialKey' => ['description' => 'The AppId or user account corresponding to SpecialType.', 'type' => 'string', 'example' => 'test_wg@aliyun.com', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<CreateModelResponse>\\r\\n <ModelId>766c0b9538a04bdf974953b5576783ba</ModelId>\\r\\n <Description>Model Description</Description>\\r\\n <CreatedTime>2019-01-29T09:33:01Z</CreatedTime>\\r\\n <ModelName>Test</ModelName>\\r\\n <RequestId>4173F95B-360C-460C-9F6C-4A960B904411</RequestId>\\r\\n <Schema>{\\\\\\"type\\\\\\":\\\\\\"object\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"id\\\\\\":{\\\\\\"format\\\\\\":\\\\\\"int64\\\\\\",\\\\\\"maximum\\\\\\":100,\\\\\\"exclusiveMaximum\\\\\\":true,\\\\\\"type\\\\\\":\\\\\\"integer\\\\\\"},\\\\\\"name\\\\\\":{\\\\\\"maxLength\\\\\\":10,\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"}}}\\"</Schema>\\r\\n <ModelRef>https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba</ModelRef>\\r\\n <ModifiedTime>2019-01-29T09:33:01Z</ModifiedTime>\\r\\n <GroupId>30e792398d6c4569b04c0e53a3494381</GroupId>\\r\\n</CreateModelResponse>","errorExample":""}]', - 'title' => 'CreateModel', - 'description' => '* For more information about the model definition, see [JSON Schema Draft 4](https://tools.ietf.org/html/draft-zyp-json-schema-04?spm=a2c4g.11186623.2.10.2e977ff7p4BpQd).'."\n" - .'* JSON Schema supports only element attributes of the Object type.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteModel' => [ - 'summary' => 'Deletes a model.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeTrafficControls', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- This API can be used to query all existing throttling policies (including special throttling policies) and their details.'."\n" + ."\n" + .'- You can specify query conditions. For example, you can query the throttling policies bound to a specified API or in a specified environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControls'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeTrafficControls', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeTrafficControlsByApi' => [ + 'summary' => 'Queries the throttling policy that is bound to a specific API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94294', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '94410', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'ModelName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test', - ], + 'schema' => ['description' => 'The ID of the group to which the API to be queried belongs.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group to which the model belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The runtime environment of the API. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -21143,97 +16649,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'TrafficControlItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficControlItem' => [ + 'description' => 'The returned throttling policy information. It is an array consisting of TrafficControlItem data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrafficControlItemId' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'BoundTime' => ['description' => 'The binding time of the policy.', 'type' => 'string', 'example' => '2016-07-23T08:28:48Z', 'title' => ''], + 'TrafficControlItemName' => ['description' => 'The name of the throttling policy.', 'type' => 'string', 'example' => 'mysecret', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteModelResponse>\\r\\n <RequestId>4173F95B-360C-460C-9F6C-4A960B904411</RequestId>\\r\\n</DeleteModelResponse>","errorExample":""}]', - 'title' => 'DeleteModel', + 'title' => 'DescribeTrafficControlsByApi', + 'description' => '- This API is intended for API providers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyModel' => [ - 'summary' => 'Updates the model of an API group.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTrafficControlsByApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeUpdateBackendTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94446', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayY6W7D1', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '119939', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'ModelName', + 'name' => 'OperationUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test', - ], + 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4e13c3e0c44c4a4ebb5231264eeb9bc1', 'title' => ''], ], - [ - 'name' => 'Description', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the new model definition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Model Description', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], + 'ApiUpdateBackendResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiUpdateBackendResult' => [ + 'description' => 'API update results', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'API update results', + 'type' => 'object', + 'properties' => [ + 'StageId' => ['description' => 'Environment ID', 'type' => 'string', 'example' => 'd8f2f54f3309458b8aaceb36c01c2dd9', 'title' => ''], + 'UpdateStatus' => ['description' => 'API update status', 'type' => 'string', 'example' => 'OVER', 'title' => ''], + 'GroupName' => ['description' => 'Group name', 'type' => 'string', 'example' => 'imotob1', 'title' => ''], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => '3013a55c0c44483f984d26df27120513', 'title' => ''], + 'ApiUid' => ['description' => 'API ID', 'type' => 'string', 'example' => '14faa7ba0572445685866ddb6a6f19da', 'title' => ''], + 'ErrorMsg' => ['description' => 'Error message for failed updates', 'type' => 'string', 'example' => 'Failed', 'title' => ''], + 'StageName' => ['description' => 'Environment name', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'API name', 'type' => 'string', 'example' => 'checkin_linechart_today', 'title' => ''], + 'BackendId' => ['description' => 'Backend service ID', 'type' => 'string', 'example' => 'c09b078bcb8f4ade9677bd8b18cdf43f', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeUpdateBackendTask', + 'summary' => 'When you modify the definition of a backend service in an environment, all associated published APIs are updated in a batch. You can query the results of the update.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateBackendTask'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'Schema', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new definition of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeUpdateBackendTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'When you update Virtual Private Cloud (VPC) authorization, the associated published APIs are updated asynchronously. retrieve the progress of those updates.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group to which the model belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94411', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], + ], + 'parameters' => [ [ - 'name' => 'NewModelName', + 'name' => 'OperationUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The new name of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NewTest', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7d341787517a47afaaef9cc1bdb7acce', 'title' => ''], ], ], 'responses' => [ @@ -21241,127 +16827,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'ApiUpdateVpcInfoResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiUpdateVpcInfoResult' => [ + 'description' => 'A list of task results.', + 'title' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StageId' => ['description' => 'The stage ID.', 'type' => 'string', 'example' => 'fe952b95072747e2a8dfd336bcff8d7f', 'title' => ''], + 'UpdateStatus' => ['description' => 'The update status.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'e8da6f6346184da9a30d0dc1888b1f3b', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ApiUid' => ['description' => 'The API ID.', 'type' => 'string', 'example' => '86364e7c166c47ba819b3f8f95ac0913', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Success. Request Success.', 'title' => ''], + 'StageName' => ['description' => 'The environment where the API is published.', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'api_test2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyModelResponse>\\r\\n <RequestId>4173F95B-360C-460C-9F6C-4A960B904411</RequestId>\\r\\n</ModifyModelResponse>","errorExample":""}]', - 'title' => 'ModifyModel', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeModels' => [ - 'summary' => 'Queries the created models of an API group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeUpdateVpcInfoTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUpdateVpcInfoTask'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeUpdateVpcInfoTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Queries VPC access authorizations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '94377', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94417', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ModelName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the authorization. The name must be unique.', 'type' => 'string', 'required' => false, 'example' => 'wuying-edm-svc', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'VpcAccessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the VPC authorization.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc-*****ssds24'], ], [ - 'name' => 'ModelId', + 'name' => 'AccurateQuery', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the model.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'Whether to conduct precise queries', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['title' => 'Vpc ID', 'description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf657qec7lx42paw3qxxx'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '10.199.26.***'], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The service port.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '8080'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The port number.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'appname', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -21370,207 +16979,224 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '40306469-2FB5-417A-B723-AF1F4A4FA204', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ModelDetails' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '8883AC74-259D-4C0B-99FC-0B7F9A588B2F', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'VpcAccessAttributes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ModelDetail' => [ - 'description' => 'The returned information about models. It is an array consisting of ModelDetail data.'."\n", + 'VpcAccessAttribute' => [ + 'description' => 'The information about the VPC access authorization. The information is an array consisting of VpcAccessAttribute data.', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the model was last modified.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T11:07:48Z', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group to which the model belongs.'."\n", - 'type' => 'string', - 'example' => '30e792398d6c4569b04c0e53a3494381', - ], - 'Description' => [ - 'description' => 'The description of the model definition.'."\n", - 'type' => 'string', - 'example' => 'Model Description', - ], - 'Schema' => [ - 'description' => 'The definition of the model.'."\n", - 'type' => 'string', - 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', - ], - 'ModelName' => [ - 'description' => 'The name of the model.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - 'CreatedTime' => [ - 'description' => 'The time when the model was created.'."\n", - 'type' => 'string', - 'example' => '2019-01-29T11:07:48Z', - ], - 'ModelId' => [ - 'description' => 'The ID of the model.'."\n", - 'type' => 'string', - 'example' => '766c0b9538a04bdf974953b5576783ba', - ], - 'ModelRef' => [ - 'description' => 'The URI of the model.'."\n", - 'type' => 'string', - 'example' => 'https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba', - ], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'title' => '', 'example' => 'vpc-uf657qec7lx42paw3qxxx'], + 'Description' => ['description' => 'The description of the VPC access authorization.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of an Elastic Compute Service (ECS) or Server Load Balancer (SLB) instance in the VPC.', 'type' => 'string', 'title' => '', 'example' => 'i-uf6bzcg1pr4oh5jjmxxx'], + 'Port' => ['description' => 'The port number that corresponds to the instance.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '80'], + 'Name' => ['description' => 'The name of the authorization.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'CreatedTime' => ['description' => 'The time when the authorization was created.', 'type' => 'string', 'title' => '', 'example' => '2017-01-30T04:10:19Z'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'VpcAccessId' => ['description' => 'The ID of the VPC access authorization.', 'type' => 'string', 'title' => '', 'example' => 'vpc-*****ssds24'], + 'VpcTargetHostName' => ['description' => 'The host of the backend service.', 'type' => 'string', 'example' => 'hos-a***.fh-**nc.com', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagInfo' => [ - 'description' => 'The tags of the model.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'ENV', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'ST4', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'PROJECT', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '6427a17ae6041d1be62414e4', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeModelsResponse>\\r\\n <PageNumber>1</PageNumber>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <RequestId>40306469-2FB5-417A-B723-AF1F4A4FA204</RequestId>\\r\\n <ModelDetails>\\r\\n <ModelDetail>\\r\\n <Description>Model Description</Description>\\r\\n <ModelId>766c0b9538a04bdf974953b5576783ba</ModelId>\\r\\n <CreatedTime>2019-01-29T11:07:48Z</CreatedTime>\\r\\n <ModelName>Test</ModelName>\\r\\n <Schema>{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}</Schema>\\r\\n <ModelRef>https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba</ModelRef>\\r\\n <ModifiedTime>2019-01-29T11:07:48Z</ModifiedTime>\\r\\n <GroupId>30e792398d6c4569b04c0e53a3494381</GroupId>\\r\\n </ModelDetail>\\r\\n </ModelDetails>\\r\\n</DescribeModelsResponse>","errorExample":""}]', - 'title' => 'DescribeModels', - 'description' => '* Fuzzy queries are supported.'."\n", + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DescribeVpcAccesses', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetApisAuthorities' => [ - 'summary' => 'Authorizes a specified application to call multiple APIs.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVpcAccesses'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeVpcAccesses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeZones' => [ + 'summary' => 'Queries zones in a region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '94419', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'The language in which you want to use to return the description of the system policy. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + ."\n" + .'- zh-CN: Chinese'."\n" + ."\n" + .'- ja: Japanese', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], - [ - 'name' => 'AppId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the application. This ID is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9324B68F-9863-5722-A0FD-0798E2B02A0E', 'title' => ''], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The zones available in the current region.', + 'example' => '{\'Zone\': [{\'ZoneId\': \'cn-hangzhou-i\'}]}', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-MAZ2(j,g)', 'title' => ''], + 'LocalName' => ['description' => 'The name of the zone.', 'type' => 'string', 'example' => 'China (Hangzhou) Multi-zone 2(j,g)', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TEST', - ], + ], + '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' => 'DescribeZones', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'DetachApiProduct' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApiIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the authorization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Queries weather based on the region name'."\n", - ], + 'schema' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], [ - 'name' => 'AuthValidTime', + 'name' => 'Apis', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Fri,05Oct201816:00:00GMT', + 'description' => 'The APIs that you want to detach from the API product.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'required' => true, 'example' => 'ba84c55eca46488598da17c0609f3ead', 'title' => ''], + 'StageName' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -21579,222 +17205,153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<SetApisAuthoritiesResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n</SetApisAuthoritiesResponse>","errorExample":""}]', - 'title' => 'SetApisAuthorities', - 'description' => '* This operation is intended for API providers and callers.'."\n" - .'* API providers can authorize all applications to call their APIs.'."\n" - .'* API callers can authorize their own applications to call the APIs that they have purchased.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetAppsAuthorities' => [ - 'summary' => 'Grants access permissions on a specified API to multiple applications.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DetachApiProduct', + 'summary' => 'Detaches APIs from an API product.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachApiProduct'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DetachApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB\\"\\n}","type":"json"}]', + ], + 'DetachGroupPlugin' => [ + 'summary' => 'Unbind group plugin', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94478', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '171235', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'API Gateway plugin ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a96926e82f994915a8da40a119374537 ', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', - ], + 'schema' => ['description' => 'API group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TEST', - ], - ], - [ - 'name' => 'AppIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of applications. Separate multiple application IDs with commas (,). A maximum of 100 applications IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789,3389798', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the authorization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Queries weather based on the region name'."\n", - ], - ], - [ - 'name' => 'AuthValidTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Fri,05Oct201816:00:00GMT', - ], + 'schema' => ['description' => 'Specify the environment of the API to operate on.'."\n" + ."\n" + .'- **RELEASE**: Production'."\n" + ."\n" + .'- **PRE**: Pre-release'."\n" + ."\n" + .'- **TEST**: Test', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '3707E6FA-749C-5352-B72A-ABE95D9DEA49', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<SetAppsAuthoritiesResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n</SetAppsAuthoritiesResponse>","errorExample":""}]', - 'title' => 'SetAppsAuthorities', - 'description' => '* This operation is intended for API providers and callers.'."\n" - .'* API providers can authorize all applications to call their APIs.'."\n" - .'* API callers can authorize their own applications to call the APIs that they have purchased.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveApisAuthorities' => [ - 'summary' => 'Revokes the access permissions on multiple APIs from a specified application.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Unbind the plugin from the group', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachGroupPlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Detaches a plugin from an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94461', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], + 'schema' => ['description' => 'The ID of the API Gateway plugin to detach.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the appplication. The ID is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789', - ], + 'schema' => ['description' => 'The ID of the group that contains the API.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '93b87279e54c4c0baeb7113cdf9c67f5', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The environment of the API.'."\n" + ."\n" + .'- **RELEASE**: Production'."\n" + ."\n" + .'- **PRE**: Staging'."\n" + ."\n" + .'- **TEST**: Test', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'ApiIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78', - ], - ], - [ - 'name' => 'Description', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the authorization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Queries weather based on the region name'."\n", - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '19a2846d8e8541c788c6be740035eb68', 'title' => ''], ], ], 'responses' => [ @@ -21802,94 +17359,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], + 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveApisAuthoritiesResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n</RemoveApisAuthoritiesResponse>","errorExample":""}]', - 'title' => 'RemoveApisAuthorities', - 'description' => '* This operation is intended for API providers and callers.'."\n" - .'* Before you revoke access permissions, check by whom the permissions were granted. API providers can only revoke permissions granted by a Provider, and API callers can only revoke permissions granted by a Consumer.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveAppsAuthorities' => [ - 'summary' => 'Revokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DetachPlugin', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachPlugin'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'This feature provides instance-level access control capabilities for dedicated API Gateway instances. Disables access control on an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94462', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', - ], - ], - [ - 'name' => 'ApiId', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API. This ID is generated by the system and globally unique.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', - ], + 'schema' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-grgqc0mnuhkqciwtam', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], ], [ - 'name' => 'AppIds', + 'name' => 'AddressIPVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of applications. Separate multiple application IDs with commas (,). A maximum of 100 applications IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789,3286798', - ], + 'schema' => ['description' => 'The IP version. Valid values: **ipv4** and **ipv6**.', 'type' => 'string', 'required' => false, 'example' => 'ipv4', 'title' => ''], ], ], 'responses' => [ @@ -21897,207 +17424,153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveAppsAuthoritiesResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n</RemoveAppsAuthoritiesResponse>","errorExample":""}]', - 'title' => 'RemoveAppsAuthorities', - 'description' => '* This operation is intended for API providers and callers.'."\n" - .'* Before you revoke access permissions, check by whom the permissions were granted. API providers can only revoke permissions granted by a Provider, and API callers can only revoke permissions granted by a Consumer.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResetAppSecret' => [ - 'summary' => 'Resets the key for an app.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DisableInstanceAccessControl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInstanceAccessControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [ + 'summary' => 'Disassociates an internal domain name resolution from a dedicated instance.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94472', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AppKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The key of the application that is used to make an API call.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '60030986', - ], - ], - [ - 'name' => 'NewAppKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new AppKey that you set must be globally unique.', - 'type' => 'string', - 'required' => false, - 'example' => 'testAppKey', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-ead4f4b0bac8', 'title' => ''], ], [ - 'name' => 'NewAppSecret', - 'in' => 'query', + 'name' => 'IntranetDomains', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The new key of the application. To improve compatibility, we recommend that you use other parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test***', + 'description' => 'The internal domain names included in the resolution.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The internal domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'api.demo.com', 'title' => ''], + 'required' => true, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetAppSecretResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ015</RequestId>\\r\\n</ResetAppSecretResponse>","errorExample":""}]', - 'title' => 'ResetAppSecret', - 'description' => '* This operation is intended for API callers.'."\n" - .'* A new secret is automatically generated after you have called this operation. This secret cannot be customized.'."\n" - .'* The results returned by this operation do not contain the application secret. You can obtain the secret by calling DescribeAppSecurity.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTagResources' => [ - 'summary' => 'Queries the visible resource tags.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', + 'title' => 'DissociateInstanceWithPrivateDNS', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateInstanceWithPrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:DissociateInstanceWithPrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DryRunSwagger' => [ + 'summary' => 'Checks the syntax before Swagger-compliant data is imported.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94429', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '94422', + 'abilityTreeNodes' => ['FEATUREapigateway9WMX21'], ], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Currently, tags are supported for API groups, plug-ins, and apps. Operations performed on APIs are based on the tags of API groups.'."\n" - ."\n" - .'* **apiGroup**'."\n" - .'* **plugin**'."\n" - .'* **app**'."\n" - .'* **api**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apiGroup', - ], + 'schema' => ['description' => 'Specifies whether to overwrite the existing API.'."\n" + ."\n" + .'APIs with the same HTTP request type and backend request path are considered the same.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'GlobalCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'The token used to start the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1d2db86sca4384811e0b5e8707e68181f', - ], + 'style' => 'json', + 'schema' => ['description' => 'The global condition.', 'type' => 'object', 'required' => false, 'docRequired' => true, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'DataFormat', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the resource.'."\n" - ."\n" - .'Valid values of N: `[1,50]`.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The ID of the resource.', - 'example' => '285bb759342649a1b70c2093a772e087', - ], - 'required' => false, - 'example' => '285bb759342649a1b70c2093a772e087', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The Swagger text format:'."\n" + ."\n" + .'- json'."\n" + ."\n" + .'- yaml', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yaml', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The Swagger text content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"A Swagger API definition in YAML"', 'title' => ''], + ], + [ + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n" - ."\n" - .'Valid values of N: `[1,20]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of the tag. If the parameter has a value, a value is also required for the tag key of the same N in the corresponding **tag.N.Key**. Otherwise, an error is reported.'."\n" - ."\n" - .'Valid values of N: `[1,20]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'product', - ], - ], - 'required' => false, - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", - ], - 'required' => false, - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd633cf5524f841b9950e245b191bdabf', 'title' => ''], ], ], 'responses' => [ @@ -22105,161 +17578,181 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that determines the start point of the next query.'."\n" - ."\n" - .'A NextToken value of -1 indicates that a next query does not exist.', - 'type' => 'string', - 'example' => '1d2db86sca4384811e0b5e8707e68181f', + 'GlobalCondition' => ['description' => 'The global condition.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], + 'Success' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiDryRunSwaggerSuccess' => [ + 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The request path configured when the API is created.', 'type' => 'string', 'example' => '/http/get/mapping', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when the API is created.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'ApiSwagger' => ['description' => 'The API definition that complies with the Swagger specification.', 'type' => 'string', 'example' => '"A Swagger API definition in YAML"', 'title' => ''], + 'ApiOperation' => ['description' => 'Specifies whether the operation is CREATE or MODIFY.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], + 'ApiUid' => ['description' => 'The UID of the successfully imported API.', 'type' => 'string', 'example' => '8e274ec61cf6468e83b68371956831cb', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + 'Failed' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportSwaggerFailed' => [ + 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The request path configured when the API is created.', 'type' => 'string', 'example' => '/http/get/mapping', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when the API is created.', 'type' => 'string', 'example' => 'post', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message returned when the API is created.', 'type' => 'string', 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'TagResources' => [ + 'ModelFailed' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'TagResource' => [ - 'description' => 'The resource list.'."\n", + 'ApiImportModelFailed' => [ + 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TagValue' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'zhangsan', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'apiGroup', - ], - 'ResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => '285bb759342649a1b70c2093a772e087', - ], - 'TagKey' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'owner', - ], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Not Found', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'Region', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '36d4bcfaec1946e1870d90b2d7519710', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ModelSuccess' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportModelSuccess' => [ + 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModelUid' => ['description' => 'The UID of the model.', 'type' => 'string', 'example' => 'ec1946e1870d90b2d7519', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'NewInstance', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'b2d552ed90ca435b86f7bf8d45414793', 'title' => ''], + 'ModelOperation' => ['description' => 'The model operation.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<ListTagResourcesResponse>\\r\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF5189484043</RequestId>\\r\\n <NextToken>1d2db86sca4384811e0b5e8707e68181f</NextToken>\\r\\n <TagResources>\\r\\n <TagResource>\\r\\n <ResourceId>285bb759342649a1b70c2093a772e087</ResourceId>\\r\\n <ResourceType>apiGroup</ResourceType>\\r\\n <TagKey>env</TagKey>\\r\\n <TagValue>product</TagValue>\\r\\n </TagResource>\\r\\n <TagResource>\\r\\n <ResourceId>285bb759342649a1b70c2093a772e087</ResourceId>\\r\\n <ResourceType>apiGroup</ResourceType>\\r\\n <TagKey>owner</TagKey>\\r\\n <TagValue>zhangsan</TagValue>\\r\\n </TagResource>\\r\\n </TagResources>\\r\\n</ListTagResourcesResponse>","errorExample":""}]', - 'title' => 'ListTagResources', - 'description' => '* The Tag.N.Key and Tag.N.Value parameters constitute a key-value pair.'."\n" - .'* ResourceId.N must meet all the key-value pairs that are entered. If you enter multiple key-value pairs, resources that contain the specified key-value pairs are returned.'."\n" - .'* This operation is used to query resource tags based on conditions. If no relationship matches the conditions, an empty list is returned.'."\n" - .'* You can query both user tags and visible system tags.'."\n" - .'* In addition to the required parameters, you can also specify ResourceId.N to query the visible resource tags of a specified resource in a region.'."\n" - .'* You can also specify Tag.N.Key to query the visible keys of a specified key in a region.'."\n" - .'* At least one of ResourceId.N, Tag.N.Key, and Tag.N.Value exists.'."\n" - .'* You can query tags of the same type or different types in a single operation.'."\n" - .'* You can query all your user types and visible system tags.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'TagResources' => [ - 'summary' => 'Adds user tags to resources.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DryRunSwagger', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DryRunSwagger'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'This feature provides instance-level access control capabilities for dedicated API Gateway instances. Specifies the access control policy of an instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94494', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource. Tags are bound to API groups, plug-ins, and applications. You can use tags to manage cloud resources by group. Valid values:'."\n" - ."\n" - .'* **apiGroup**'."\n" - .'* **plugin**'."\n" - .'* **app**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apiGroup', - ], + 'schema' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp11escro2et2tioscy52', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N.', - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The value of tag N.', - 'type' => 'string', - 'required' => true, - 'example' => '\' \'', - ], - ], - 'required' => false, - 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.'."\n", - ], - 'required' => true, - 'example' => '2021022811', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'AclType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the resource.', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The ID of the resource.', - 'example' => '285bb759342649a1b70c2093a772e087', - ], - 'required' => true, - 'example' => '285bb759342649a1b70c2093a772e087', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The ACL type. Valid values:'."\n" + ."\n" + .'- black: blacklist'."\n" + ."\n" + .'- white: whitelist', 'type' => 'string', 'required' => true, 'example' => 'black', 'title' => ''], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => ['description' => 'The IP version. Valid values: **ipv4** and **ipv6**.', 'type' => 'string', 'required' => false, 'example' => 'ipv4', 'title' => ''], ], ], 'responses' => [ @@ -22267,112 +17760,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\r\\n</TagResourcesResponse>","errorExample":""}]', - 'title' => 'TagResources', - 'description' => '* All tags (key-value pairs) are applied to all resources of a specified ResourceId, with each resource specified as ResourceId.N.'."\n" - .'* Tag.N is a resource tag consisting of a key-value pair: Tag.N.Key and Tag.N.Value.'."\n" - .'* If you call this operation to tag multiple resources simultaneously, either all or none of the resources will be tagged.'."\n" - .'* If you specify Tag.1.Value in addition to required parameters, you must also specify Tag.1.Key. Otherwise, an InvalidParameter.TagKey error is reported. A tag that has a value must have the corresponding key, but the key can be an empty string.'."\n" - .'* If a tag with the same key has been bound to a resource, the new tag will overwrite the existing one.'."\n", - ], - 'UntagResources' => [ - 'summary' => 'Removes tags from resources.', - 'methods' => [ - 'post', - 'get', + 'title' => 'EnableInstanceAccessControl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '7', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInstanceAccessControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Exports APIs based on OpenAPI Specification (OAS).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94496', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'DataFormat', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource. Tags are bound to API groups, plug-ins, and applications. You can use tags to manage cloud resources by group. Valid values:'."\n" - ."\n" - .'* **apiGroup**'."\n" - .'* **plugin**'."\n" - .'* **app**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apiGroup', - ], + 'schema' => ['description' => 'The exported format:'."\n" + ."\n" + .'- json'."\n" + ."\n" + .'- yaml', 'type' => 'string', 'required' => false, 'example' => 'yaml', 'title' => ''], ], [ - 'name' => 'All', + 'name' => 'ApiIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to delete all tags. This parameter is valid only when the **TagKey.N**parameter is not specified. Default value: false. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', + 'description' => 'The APIs that you want to export.', + 'type' => 'array', + 'items' => ['description' => 'The API ID.', 'type' => 'string', 'required' => false, 'example' => '8afff6c8c4c6447abb035812e4d66xxx', 'title' => ''], 'required' => false, - 'example' => 'true', + 'docRequired' => false, + 'maxItems' => 300, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResourceId', + 'name' => 'GroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The ID of the resource.'."\n" - ."\n" - .'Valid values of N: `1 to 50.`'."\n", - 'example' => '285bb759342649a1b70c2093a772e087', - ], - 'required' => true, - 'example' => '285bb759342649a1b70c2093a772e087', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => false, 'example' => '42925e7f5209438186d5560239af5xxx', 'title' => ''], ], [ - 'name' => 'TagKey', + 'name' => 'StageName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag keys of the resource.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The key of tag N.'."\n" - ."\n" - .'Valid values of N: `1 to 20.`'."\n", - 'example' => 'thirdparty', - ], - 'required' => false, - 'example' => 'env', - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The environment to which the API is published. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the pre-release environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => false, 'example' => 'RELEASE', 'title' => ''], + ], + [ + 'name' => 'OasVersion', + 'in' => 'query', + 'schema' => ['description' => 'The OAS version. Valid values:'."\n" + ."\n" + .'- **oas2**'."\n" + ."\n" + .'- **oas3**', 'type' => 'string', 'required' => false, 'example' => 'oas2', 'title' => ''], + ], + [ + 'name' => 'WithXExtensions', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to export API Gateway extensions at the same time.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of pages in which you want to export the APIs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -22380,128 +17870,188 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', - ], + 'Data' => ['description' => 'The Base64-encoded data of the exported Swagger file. You can obtain the file by using Base64 decoding.', 'type' => 'string', 'example' => 'UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\r\\n</UntagResourcesResponse>","errorExample":""}]', - 'title' => 'UntagResources', - 'description' => '* If you call this operation to untag multiple resources simultaneously, either all or none of the resources will be untagged.'."\n" - .'* If you specify resource IDs without specifying tag keys and set the All parameter to true, all tags bound to the specified resources will be deleted. If a resource does not have any tags, the request is not processed but a success is returned.'."\n" - .'* If you specify resource IDs without specifying tag keys and set the All parameter to false, the request is not processed but a success is returned.'."\n" - .'* When tag keys are specified, the All parameter is invalid.'."\n" - .'* When multiple resources and key-value pairs are specified, the specified tags bound to the resources are deleted.'."\n", - ], - 'DescribeSummaryData' => [ - 'summary' => 'Queries the number of API Gateway resources in a region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'title' => 'ExportOAS', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportOAS'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'UsageGroupNum' => [ - 'description' => 'The number of API groups.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsageInstanceNum' => [ - 'description' => 'The number of running dedicated instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UsageApiNum' => [ - 'description' => 'The number of APIs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ExpireInstanceNum' => [ - 'description' => 'The number of subscription dedicated instances that expire in 14 days or less.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:ExportOAS', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], - 'description' => '', ], ], ], - '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"}]', - 'title' => 'DescribeSummaryData', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx\\"\\n}","type":"json"}]', ], - 'DescribeRegions' => [ - 'summary' => 'Queries the Alibaba Cloud regions that are supported by API Gateway.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportOAS' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94396', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Language', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which you want to return the descriptions of the access control policies. Valid values:'."\n" - ."\n" - .'* zh-CN (default value): Chinese'."\n" - .'* en: English'."\n" - .'* ja: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', 'title' => ''], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The OAS-compliant text file or OSS object URL.', '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"', 'title' => ''], + ], + [ + 'name' => 'Overwrite', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to overwrite an existing API.'."\n" + ."\n" + .'If an existing API has the same HTTP request type and backend request path as the API to be imported, the existing API is overwritten.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'IgnoreWarning', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to ignore alerts.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SkipDryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to directly import the API without performing a precheck.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'OASVersion', + 'in' => 'query', + 'schema' => ['description' => 'The OAS version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'OAS2', 'title' => ''], + ], + [ + 'name' => 'BackendName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the backend service.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testBackendService', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The security authentication method of the API. Valid values:'."\n" + ."\n" + .'- **APP: Only authorized applications can call the API.**'."\n" + ."\n" + .'- **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**'."\n" + ."\n" + .' - All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'APP', 'title' => ''], + ], + [ + 'name' => 'RequestMode', + 'in' => 'query', + 'schema' => ['description' => 'The request mode. Valid values:'."\n" + ."\n" + .'- MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" + ."\n" + .'- PASSTHROUGH: Parameters are passed through.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PASSTHROUGH', 'title' => ''], ], ], 'responses' => [ @@ -22509,344 +18059,226 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', + 'OperationId' => ['description' => 'The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status of the API import task.', 'type' => 'string', 'example' => 'c16a1880f5164d779f6a54f64d997cd9', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E7FE7172-AA75-5880-B6F7-C00893E9BC06', 'title' => ''], + 'ErrorMessages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorMessage' => [ + 'description' => 'The error messages that appear due to the invalid data in the imported file.', + 'type' => 'array', + 'items' => ['description' => 'The error message that appears due to the invalid data in the imported file.', 'type' => 'string', 'example' => 'Invalid extensions:x-aliyun-apigateway-auth-type. Option value [ANONYMOUS, APP].', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Regions' => [ + 'WarningMessages' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Region' => [ - 'description' => 'The returned region information. It is an array that consists of Region data.'."\n", - 'example' => 'cn-huhehaote', + 'WarningMessage' => [ + 'description' => 'The warning messages that appear due to the invalid data in the imported file.', + 'type' => 'array', + 'items' => ['description' => 'The warning message that appears due to the invalid data in the imported file.', 'type' => 'string', 'example' => 'There is no valid api definition in your file.', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SuccessApis' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SuccessApi' => [ + 'description' => 'The information about the APIs that have passed the precheck.', 'type' => 'array', 'items' => [ + 'description' => 'The information about the API that has passed the precheck.', 'type' => 'object', 'properties' => [ - 'RegionEndpoint' => [ - 'description' => 'The endpoint of the service for the region.'."\n", - 'type' => 'string', - 'example' => 'apigateway.cn-shenzhen.aliyuncs.com', - ], - 'LocalName' => [ - 'description' => 'The name of the region.'."\n", - 'type' => 'string', - 'example' => 'China (Shenzhen)'."\n", - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], + 'Path' => ['description' => 'The request path configured when you created the API.', 'type' => 'string', 'example' => '/st1', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when you created the API.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the API.', 'type' => 'string', 'example' => '92af1abffc2443eaa2b815fdbd9c13f1', 'title' => ''], + 'ApiOperation' => ['description' => 'Indicates that the operation is CREATE or MODIFY.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - '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\\": \\"华南1(深圳)\\",\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\"code\\":500}"},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeRegions', - 'description' => 'This operation queries regions in which API Gateway is available.'."\n" - ."\n" - .'* This operation is intended for API providers and callers.'."\n", - ], - 'DescribeSystemParameters' => [ - 'summary' => 'Queries the common parameters supported by the system.', - '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' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0CCDF65E-6050-412D-AD68-FA3D9196836C', - ], - 'SystemParams' => [ + 'FailedApis' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'SystemParamItem' => [ - 'description' => 'The returned information about system parameters. It is an array that consists of SystemParam data.'."\n", + 'FailedApi' => [ + 'description' => 'The APIs that failed to pass the precheck.', 'type' => 'array', 'items' => [ + 'description' => 'The API that failed to be pass the precheck.', 'type' => 'object', 'properties' => [ - 'DemoValue' => [ - 'description' => 'Examples'."\n", - 'type' => 'string', - 'example' => '192.168.1.1', - ], - 'Description' => [ - 'description' => 'The description of a parameter.'."\n", - 'type' => 'string', - 'example' => 'Client IP Address'."\n", - ], - 'ParamName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'CaClientIp', - ], - 'ParamType' => [ - 'description' => 'The type of the parameter.'."\n", - 'type' => 'string', - 'example' => 'string', - ], + 'Path' => ['description' => 'The request path configured when you created the API.', 'type' => 'string', 'example' => '/st1', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when you created the API.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Invalid Api Definition.', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - '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\\": \\"客户端IP\\",\\n \\"ParamName\\": \\"CaClientIp\\",\\n \\"ParamType\\": \\"string\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemParametersResponse>\\r\\n <RequestId>0CCDF65E-6050-412D-AD68-FA3D9196836C</RequestId>\\r\\n <SystemParameters>\\r\\n <SystemParameter>\\r\\n <Description>客户端IP</Description>\\r\\n <DemoValue>192.168.1.1</DemoValue>\\r\\n <ParamName>CaClientIp</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>请求域名</Description>\\r\\n <DemoValue>api.aliyun.com</DemoValue>\\r\\n <ParamName>CaDomain</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>请求时间(格林威治时间)</Description>\\r\\n <DemoValue>2016-01-30T03:53:16Z</DemoValue>\\r\\n <ParamName>CaRequestHandleTime</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>ConsumerAppId</Description>\\r\\n <DemoValue>123456</DemoValue>\\r\\n <ParamName>CaAppId</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>RequestId</Description>\\r\\n <DemoValue>7157EBD9-4684-4827-B3B0-9B32D186819B</DemoValue>\\r\\n <ParamName>CaRequestId</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>Http Schema</Description>\\r\\n <DemoValue>https</DemoValue>\\r\\n <ParamName>CaHttpSchema</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n <SystemParameter>\\r\\n <Description>代理</Description>\\r\\n <DemoValue>AliCloudApiGateway</DemoValue>\\r\\n <ParamName>CaProxy</ParamName>\\r\\n <ParamType>string</ParamType>\\r\\n </SystemParameter>\\r\\n </SystemParameters>\\r\\n</DescribeSystemParametersResponse>","errorExample":""}]', - 'title' => 'DescribeSystemParameters', - 'description' => '* This API is intended for API callers.'."\n" - .'* The response of this API contains the system parameters that are optional in API definitions.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeZones' => [ - 'summary' => 'Queries zones in a region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94419', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayX0L6BS', - ], - ], - 'parameters' => [ - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language in which you want to use to return the description of the system policy. Valid values:'."\n" - ."\n" - .'* en: English'."\n" - .'* zh-CN: Chinese'."\n" - .'* ja: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9324B68F-9863-5722-A0FD-0798E2B02A0E', + 'FailedModels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FailedModel' => [ + 'description' => 'The information about the models that failed to pass the precheck.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the model that failed to pass the precheck.', + 'type' => 'object', + 'properties' => [ + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Invalid Model Definition.', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '2c1bc62e19614cc68c6b0b484bc9c5db', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Zones' => [ + 'SuccessModels' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'Zone' => [ - 'description' => 'The zones available in the current region.'."\n", - 'example' => '{\'Zone\': [{\'ZoneId\': \'cn-hangzhou-i\'}]}', + 'SuccessModel' => [ + 'description' => 'The information about the models that have passed the precheck.', 'type' => 'array', 'items' => [ + 'description' => 'The information about the model that has passed the precheck.', 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => 'The ID of the zone.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-MAZ2(j,g)', - ], - 'LocalName' => [ - 'description' => 'The name of the zone.'."\n", - 'type' => 'string', - 'example' => 'China (Hangzhou) Multi-zone 2(j,g)'."\n", - ], + 'ModelUid' => ['description' => 'The UID of the model.', 'type' => 'string', 'example' => '1r4efwee19614cc68c6b0b484bc9c5dbs', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'feaccf67040643bcbdedb253e59eb527', 'title' => ''], + 'ModelOperation' => ['description' => 'The operation of the model. Valid values: CREATE and MODIFY.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9324B68F-9863-5722-A0FD-0798E2B02A0E\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-MAZ2(j,g)\\",\\n \\"LocalName\\": \\"华东1(杭州)多可用区 2(j,g)\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'DescribeZones', - ], - 'OpenApiGatewayService' => [ - 'summary' => 'Activates the API Gateway service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '94453', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayAQG9N5', + 'title' => 'ImportOAS', + 'summary' => 'Imports OpenAPI Specification (OAS)-compliant data to create an API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportOAS'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '210981***530495', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', - ], + '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 \\"OrderId\\": \\"210981***530495\\",\\n \\"RequestId\\": \\"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989\\"\\n}","type":"json"}]', - 'title' => 'OpenApiGatewayService', + '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"}]', ], - 'CreateLogConfig' => [ - 'summary' => 'Creates a Simple Log Service configuration for an API.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportSwagger' => [ + 'summary' => 'Creates an API by importing Swagger-compliant data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94274', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayQEORTA', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'SlsProject', + 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Log Service project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rec-lq-sls', - ], + 'schema' => ['description' => 'Specifies whether to overwrite the existing API.'."\n" + ."\n" + .'APIs with the same HTTP request type and backend request path are considered the same.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SlsLogStore', + 'name' => 'GlobalCondition', 'in' => 'query', - 'schema' => [ - 'description' => 'slslogstore', - 'type' => 'string', - 'required' => true, - 'example' => 'api-gateway', - ], + 'style' => 'json', + 'schema' => ['description' => 'The global conditions.', 'type' => 'object', 'required' => false, 'docRequired' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'LogType', + 'name' => 'DataFormat', 'in' => 'query', - 'schema' => [ - 'description' => 'The log type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PROVIDER'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PROVIDER', - 'default' => 'PROVIDER', - 'enum' => [ - 'PROVIDER', - ], - ], + 'schema' => ['description' => 'The Swagger text format:'."\n" + ."\n" + .'- json'."\n" + ."\n" + .'- yaml', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yaml', 'title' => ''], ], [ - 'name' => 'CreateSlr', + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The Swagger text content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"A Swagger API definition in YAML"', 'title' => ''], + ], + [ + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies to create a service-linked role.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The ID of the API group to which the Swagger is imported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0009db9c828549768a200320714b****', 'title' => ''], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => ['description' => 'The pre-inspection.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -22854,493 +18286,369 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '647CEF05-404C-4125-B3D7-44792EB77392', 'title' => ''], + 'Success' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportSwaggerSuccess' => [ + 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The APIs that are created based on the Swagger-compliant data imported this time.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The request path configured when the API is created.', 'type' => 'string', 'example' => '/http/get/mapping', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when the API is created.', 'type' => 'string', 'example' => 'get', 'title' => ''], + 'ApiOperation' => ['description' => 'Specifies whether the operation is CREATE or MODIFY.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], + 'ApiUid' => ['description' => 'The UID of the successfully imported API.', 'type' => 'string', 'example' => '8e274ec61cf6468e83b683719568****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Failed' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportSwaggerFailed' => [ + 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The APIs that failed to be created based on the Swagger-compliant data imported this time.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The request path configured when the API is created.', 'type' => 'string', 'example' => '/http/get/mapping', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method configured when the API is created.', 'type' => 'string', 'example' => 'post', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message returned when the API is created.', 'type' => 'string', 'example' => 'api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ModelFailed' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportModelFailed' => [ + 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The models that failed to be imported through the Swagger-compliant data this time.', + 'type' => 'object', + 'properties' => [ + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'error msg', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'Region', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '36d4bcfaec1946e1870d90b2d751****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ModelSuccess' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiImportModelSuccess' => [ + 'description' => 'The models that were imported through the Swagger-compliant data this time.', + 'type' => 'array', + 'items' => [ + 'description' => 'The models that were imported through the Swagger-compliant data this time.', + 'type' => 'object', + 'properties' => [ + 'ModelUid' => ['description' => 'The UID of the model.', 'type' => 'string', 'example' => 'd4bcfaec1946e1870d', 'title' => ''], + 'ModelName' => ['description' => 'The name of the model.', 'type' => 'string', 'example' => 'NewInstance', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => 'b2d552ed90ca435b86f7bf8d4541****', 'title' => ''], + 'ModelOperation' => ['description' => 'The model operation', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', - 'title' => 'CreateLogConfig', - ], - 'DeleteLogConfig' => [ - 'summary' => 'Deletes a log configuration.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94293', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayQEORTA', + 'title' => 'ImportSwagger', + 'description' => '- Alibaba Cloud supports extensions based on Swagger 2.0.'."\n" + ."\n" + .'- Alibaba Cloud supports Swagger configuration files in JSON and YAML formats.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportSwagger'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'LogType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The log type. Valid values: **log** and **survey**.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'log', - 'default' => 'PROVIDER', - 'enum' => [ - 'PROVIDER', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:ImportSwagger', + '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-F876FF7BZ016\\"\\n}","type":"json"}]', - 'title' => 'DeleteLogConfig', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'ModifyLogConfig' => [ - 'summary' => '修改日志配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPrivateDNS' => [ + 'summary' => 'Queries the resolution settings for private domain names. You can filter the query by private domain name or resolution type.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94445', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayQEORTA', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215588', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ - 'name' => 'SlsProject', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Log Service project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ford-api-gateway-log', - ], - ], - [ - 'name' => 'SlsLogStore', + 'name' => 'IntranetDomain', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logs-gateway', - ], + 'schema' => ['description' => 'The private domain name.', 'type' => 'string', 'required' => false, 'example' => 'api.demo.com', 'title' => ''], ], [ - 'name' => 'LogType', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The log type. Valid values:'."\n" - ."\n" - .'* **log**: other logs'."\n" - .'* **survey**: inspection logs'."\n" + 'description' => 'The type of private domain name resolution.'."\n" ."\n" - .'Enumeration value:'."\n" + .'- VPC: Authorizes resolution for a VPC. Only dedicated instances of the classic type can be attached.'."\n" ."\n" - .'* PROVIDER'."\n", + .'- A: Creates an A record. Only dedicated instances of the VPC-integrated type can be attached.', + 'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'], 'type' => 'string', 'required' => false, - 'example' => 'PROVIDER', - 'default' => 'PROVIDER', - 'enum' => [ - 'PROVIDER', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '75A4ADCB-AA26-51FB-94D4-AB3240040974', - ], - ], + 'example' => 'A', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75A4ADCB-AA26-51FB-94D4-AB3240040974\\"\\n}","type":"json"}]', - 'title' => 'ModifyLogConfig', - ], - 'QueryRequestLogs' => [ - 'summary' => 'Queries the request logs of a user.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94456', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayQEORTA', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RequestLogId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request log.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '95657ED9-2F6F-426F-BD99-79C8********', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C81********', - ], - 'RequestLogs' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'RequestLog' => [ - 'description' => 'The request logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request log.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => '4b83229ebcab4ecd88956fb3********', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'ApiName', - ], - 'ConsumerAppKey' => [ - 'description' => 'The App Key that is used by the caller.'."\n", - 'type' => 'string', - 'example' => '20412****', - ], - 'TotalLatency' => [ - 'description' => 'The total time consumed by the request. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1345', - ], - 'HttpMethod' => [ - 'description' => 'The HTTP method that is used to send the request.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'Domain' => [ - 'description' => 'The requested domain name in the request.'."\n", - 'type' => 'string', - 'example' => '360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the call fails.'."\n", - 'type' => 'string', - 'example' => 'Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`', - ], - 'ConsumerAppId' => [ - 'description' => 'The application ID that is used by the caller.'."\n", - 'type' => 'string', - 'example' => '11096****', - ], - 'InstanceId' => [ - 'description' => 'The ID of the API Gateway instance to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'apigateway-bj-ab2b********', - ], - 'ClientNonce' => [ - 'description' => 'The X-Ca-Nonce header included in the request from the client.'."\n", - 'type' => 'string', - 'example' => 'd43df9db-3b05-4cd6-888a-1c0b********', - ], - 'RequestSize' => [ - 'description' => 'The size of the request. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '1923', - ], - 'StageId' => [ - 'description' => 'The ID of the API environment.'."\n", - 'type' => 'string', - 'example' => '8a305b7f10334052a52d9156********', - ], - 'StageName' => [ - 'description' => 'The name of the API environment.'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'HttpPath' => [ - 'description' => 'The path of the request.'."\n", - 'type' => 'string', - 'example' => '/testPath', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '95657ED9-2F6F-426F-BD99-79C8********', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'dc024277fe6c4cada79ba0bd6********', - ], - 'GroupName' => [ - 'description' => 'The name of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'GroupName', - ], - 'ErrorCode' => [ - 'description' => 'The error code that is returned.'."\n", - 'type' => 'string', - 'example' => 'X500ER', - ], - 'ResponseSize' => [ - 'description' => 'The size of returned data. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '23441', - ], - 'Region' => [ - 'description' => 'The region in which the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'StatusCode' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client that sends the request.'."\n", - 'type' => 'string', - 'example' => '21.237.XXX.XXX', - ], - 'ServiceLatency' => [ - 'description' => 'The total time consumed to access the backend resources. The total time includes the time consumed to request a connection to the resources, the time consumed to establish the connection, and the time consumed to call the backend service. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '324', - ], - 'RequestTime' => [ - 'description' => 'The request time, in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-10-29T03:59:59Z', - ], - 'Exception' => [ - 'description' => 'The specific error message returned by the backend service.'."\n", - 'type' => 'string', - 'example' => 'error msg', - ], - 'CustomTraceId' => [ - 'description' => 'The custom trace ID.'."\n", - 'type' => 'string', - 'example' => '95657ED9-2F6F-426F-BD99-79C8********', - ], - 'JwtClaims' => [ - 'description' => 'The JSON web token (JWT) claims. The claims can be configured at the group level.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'RequestProtocol' => [ - 'description' => 'The protocol used by the client to send the request. Valid values: HTTP, HTTPS, and WS.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'RequestHeaders' => [ - 'description' => 'The request headers.'."\n", - 'type' => 'string', - 'example' => 'content-type: application/x-www-form-urlencoded', - ], - 'RequestQueryString' => [ - 'description' => 'The query string for the request.'."\n", - 'type' => 'string', - 'example' => 'username=name', - ], - 'RequestBody' => [ - 'description' => 'The request body. A request body cannot exceed 1,024 bytes in size.'."\n", - 'type' => 'string', - 'example' => 'param=paramName', - ], - 'ResponseHeaders' => [ - 'description' => 'The headers in the API response.'."\n", - 'type' => 'string', - 'example' => 'content-type: application/x-www-form-urlencoded'."\n", - ], - 'ResponseBody' => [ - 'description' => 'The response body. A response body cannot exceed 1,024 bytes in size.'."\n", - 'type' => 'string', - 'example' => 'param=paramName'."\n", - ], - 'plugin' => [ - 'description' => 'The plug-in hit by the request and the relevant context.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'InitialRequestId' => [ - 'description' => 'The initial request ID when API Gateway calls an API. For example, if API-1 calls API-2, the initialRequestId parameter in the log of API-2 indicates the ID of the request from API-1.'."\n", - 'type' => 'string', - 'example' => '95657ED9-2F6F-426F-BD99-79C8********', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'VIPROOM_VIPROOM', - ], - 'FrontRequestStart' => [ - 'description' => 'The time when API Gateway started to receive the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224968', - ], - 'FrontRequestEnd' => [ - 'description' => 'The time when API Gateway finished receiving the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224968', - ], - 'BackendRequestStart' => [ - 'description' => 'The time when API Gateway started to forward the request to the backend service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224969', - ], - 'BackendRequestEnd' => [ - 'description' => 'The time when API Gateway finished forwarding the request to the backend service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224969', - ], - 'BackendResponseStart' => [ - 'description' => 'The time when API Gateway started to receive the response from the backend service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224989', - ], - 'BackendResponseEnd' => [ - 'description' => 'The time when API Gateway finished receiving the response from the backend service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224989', - ], - 'FrontResponseStart' => [ - 'description' => 'The time when API Gateway started to forward the response to the client.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224989', - ], - 'FrontResponseEnd' => [ - 'description' => 'The time when API Gateway finished forwarding the response to the client.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731487224989', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PrivateDNSList' => [ + 'description' => 'A list of private domain name resolution settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The private domain name resolution settings.', + 'type' => 'object', + 'properties' => [ + 'IntranetDomain' => ['description' => 'The private domain name.', 'type' => 'string', 'example' => 'api.demo.com', 'title' => ''], + 'Type' => [ + 'description' => 'The type of private domain name resolution.'."\n" + ."\n" + .'- VPC: Authorizes resolution for a VPC. Only dedicated instances of the classic type can be attached.'."\n" + ."\n" + .'- A: Creates an A record. Only dedicated instances of the VPC-integrated type can be attached.', + 'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'], + 'type' => 'string', + 'example' => 'A', + 'title' => '', + ], + 'CreatedTime' => ['description' => 'The time when the settings were created. The time is in UTC.', 'type' => 'string', 'example' => '2023-05-10T08:17:00Z', 'title' => ''], + 'Records' => [ + 'description' => 'A list of DNS records.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of DNS records.', + 'type' => 'object', + 'properties' => [ + 'Record' => ['description' => 'The value of the DNS record.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'Weight' => ['description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'BindInstances' => [ + 'description' => 'A list of dedicated instances that are associated with the private domain name resolution.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the dedicated instance.', 'type' => 'string', 'example' => 'apigateway-hz-ead4f4b0bac8', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - 'title' => 'QueryRequestLogs', - ], - 'DescribeLogConfig' => [ - 'summary' => '查询日志配置', - 'methods' => [ - 'post', - 'get', + 'title' => 'ListPrivateDNS', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'apigateway:ListPrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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', - 'abilityTreeCode' => '94375', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayQEORTA', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94429', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'LogType', + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- **apiGroup**'."\n" + ."\n" + .'- **plugin**'."\n" + ."\n" + .'- **app**'."\n" + ."\n" + .'- **api**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1d2db86sca4384811e0b5e8707e68181f', 'title' => ''], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The log type.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The IDs of the resources.'."\n" ."\n" - .'* PROVIDER'."\n", - 'type' => 'string', + .'You can specify up to 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'PROVIDER', - 'default' => 'PROVIDER', - 'enum' => [ - 'PROVIDER', + 'example' => '285bb759342649a1b70c2093a772e087', + 'maxItems' => 10000, + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Specify the object tags to which the rule applies. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'The value of N ranges from 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag. If you specify this parameter, you must also specify the corresponding **Tag.N.Key** parameter.'."\n" + ."\n" + .'You can specify up to 20 tag values.', 'type' => 'string', 'required' => false, 'example' => 'product', 'title' => ''], + ], + 'required' => false, + 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], ], @@ -23349,63 +18657,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E3BC2706-ABDB-5B64-A12F-08DFD9E3F339', - ], - 'LogInfos' => [ + 'NextToken' => ['description' => 'The token to retrieve the next page of results.'."\n" + ."\n" + .'A value of -1 indicates that no more results are available.', 'type' => 'string', 'example' => '1d2db86sca4384811e0b5e8707e68181f', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', 'title' => ''], + 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'LogInfo' => [ - 'description' => 'Info of the log config.', + 'TagResource' => [ + 'description' => 'The list of resources.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SlsLogStore' => [ - 'description' => 'The name of the Logstore in Log Service.'."\n", - 'type' => 'string', - 'example' => 'slsstore', - ], - 'LogType' => [ - 'description' => 'The log type.'."\n", - 'type' => 'string', - 'example' => 'PROVIDER', - ], - 'SlsProject' => [ - 'description' => 'The name of the Log Service project.'."\n", - 'type' => 'string', - 'example' => 'slsproject', - ], - 'RegionId' => [ - 'description' => 'The region ID of the Logstore.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'ResourceType' => ['description' => 'The type of the resource.', 'type' => 'string', 'example' => 'apiGroup', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => '285bb759342649a1b70c2093a772e087', 'title' => ''], + 'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'owner', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeLogConfig', - ], - 'SdkGenerateByAppForRegion' => [ - 'summary' => '生成与App关联的API的SDK', - 'methods' => [ - 'post', - 'get', + 'title' => 'ListTagResources', + 'summary' => 'Query visible resource-tag relationships.', + 'description' => '- In Tag.N.Key and Tag.N.Value, the same value for N represents a single key-value pair.'."\n" + ."\n" + .'- The query returns only resources that match all specified tags. If you specify resource IDs, the query searches only within those resources.'."\n" + ."\n" + .'- The query returns resource-tag relationships that meet the specified conditions. If no matching relationships are found, an empty list is returned.'."\n" + ."\n" + .'- The query includes both user tags and visible system tags.'."\n" + ."\n" + .'- In addition to the required parameters, specify ResourceId.N to query visible resource-tag relationships for specific resources in a region.'."\n" + ."\n" + .'- In addition to the required parameters, specify Tag.N.Key to query visible resource-tag relationships for a specific tag key in a region.'."\n" + ."\n" + .'- Specify at least one resource ID (ResourceId.N) or one tag (Tag.N.Key and Tag.N.Value).'."\n" + ."\n" + .'- In a single operation, the tags can be of the same or different types.'."\n" + ."\n" + .'- You have full permissions to query user tags and can query visible system tags.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'ModifyApi' => [ + 'summary' => 'Modifies the definition of an API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23413,32 +18750,291 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app. This ID is generated by the system and globally unique.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110906109', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The programming language in which the SDK is generated.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'java', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8afff6c8c4c6447abb035812e4d66b65', 'title' => ''], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the API. The name must be unique within the API group. The name must be 4 to 50 characters in length. It must start with a letter and can contain letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ApiName', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the API. The description can be up to 180 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'Api description', 'title' => ''], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the API is public. Valid values:'."\n" + ."\n" + .'- **PUBLIC**: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" + ."\n" + .'- **PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PUBLIC', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The configuration items of API requests sent by the consumer to API Gateway.', 'type' => 'string', 'required' => false, 'example' => 'APP', 'title' => ''], + ], + [ + 'name' => 'RequestConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configuration items of API requests sent by API Gateway to the backend service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"RequestProtocol":"HTTP","RequestHttpMethod":"GET","RequestPath":"/v3/getUserTest/[userId]","BodyFormat":"FORM","PostBodyDescription":""}', 'title' => ''], + ], + [ + 'name' => 'ServiceConfig', + 'in' => 'query', + 'schema' => ['description' => 'The parameters of API requests sent by the consumer to API Gateway.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"ServiceProtocol":"HTTP","ServiceHttpMethod":"GET","ServiceAddress":"http://www.customerdomain.com","ServiceTimeout":"1000","ServicePath":"/v3/getUserTest/[userId]"}', 'title' => ''], + ], + [ + 'name' => 'RequestParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [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" + .']', 'title' => ''], + ], + [ + 'name' => 'SystemParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The system parameters sent by API Gateway to the backend service.', 'type' => 'string', 'required' => false, 'example' => '[{\\"location\\":\\"HEAD\\",\\"parameterName\\":\\"CaDomain\\",\\"serviceParameterName\\":\\"host\\"}]', 'title' => ''], + ], + [ + 'name' => 'ConstantParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The constant parameters sent by API Gateway to the backend service.', 'type' => 'string', 'example' => '[{\\"ConstantValue\\":\\"123\\",\\"Description\\":\\"Constant parameter\\",\\"Location\\":\\"HEAD\\",\\"ServiceParameterName\\":\\"test\\"}]', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ServiceParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters of API requests sent by API Gateway to the back-end service.'."\n" + ."\n" + .'For more information, see [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" + .']', 'title' => ''], + ], + [ + 'name' => 'ServiceParametersMap', + 'in' => 'formData', + 'schema' => ['description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the back-end service.'."\n" + ."\n" + .'For more information, see [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" + .']', 'title' => ''], + ], + [ + 'name' => 'ResultType', + 'in' => 'query', + 'schema' => ['description' => 'The sample response from the backend service.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'HTML', 'title' => ''], + ], + [ + 'name' => 'ResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'The sample response that is returned from the backend service. This value is used only to generate documents. It does not affect the actually returned result.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'FailResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.', 'type' => 'string', 'required' => false, 'example' => '{\\"requestId\\":\\"3b9b8b31-93c3-489e-8ebb-cab35a1aee51\\",\\"errCode\\":500,\\"errMsg\\":\\"connection refused\\"}', 'title' => ''], + ], + [ + 'name' => 'ErrorCodeSamples', + 'in' => 'formData', + 'schema' => ['description' => 'The sample error codes returned by the backend service.'."\n" + ."\n" + .'For more information, see [ErrorCodeSample](~~44392~~).', 'type' => 'string', 'required' => false, 'example' => '[{\\"Code\\":\\"400\\",\\"Message\\":\\"Login failed\\",\\"Description\\":\\"Invalid user name or password\\"}]', 'title' => ''], + ], + [ + 'name' => 'ResultDescriptions', + 'in' => 'formData', + 'schema' => ['description' => 'The descriptions of API responses.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'OpenIdConnectConfig', + 'in' => 'query', + 'schema' => ['description' => 'The client-side request signature method of the API. Valid values:'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => '{\\"OpenIdApiType\\":\\"IDTOKEN\\",\\"PublicKey\\":\\"lzlj1573\\",\\"IdTokenParamName\\":\\"\\",\\"PublicKeyId\\":\\"lzljorders\\"}', 'title' => ''], + ], + [ + 'name' => 'AllowSignatureMethod', + 'in' => 'query', + 'schema' => ['description' => 'The type of the two-way communication API. Valid values:'."\n" + ."\n" + .'- **COMMON**: general APIs'."\n" + ."\n" + .'- **REGISTER**: registered APIs'."\n" + ."\n" + .'- **UNREGISTER**: unregistered APIs'."\n" + ."\n" + .'- **NOTIFY**: downstream notification', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256', 'title' => ''], + ], + [ + 'name' => 'WebSocketApiType', + 'in' => 'query', + 'schema' => ['description' => 'The returned description of the API.', 'type' => 'string', 'required' => false, 'example' => 'COMMON', 'title' => ''], + ], + [ + 'name' => 'ResultBodyModel', + 'in' => 'query', + 'schema' => ['description' => '- Specifies whether to set **ForceNonceCheck** to **true** to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If you set **ForceNonceCheck** to **false**, the check is not performed. If you do not set this parameter, the original value is used.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'ForceNonceCheck', + 'in' => 'query', + 'schema' => ['description' => '- Specifies whether to set DisableInternet to **true** to limit API calls to within the VPC.'."\n" + ."\n" + .'- If you set DisableInternet to **false**, the limit if lifted.'."\n" + ."\n" + .'> If you do not set this parameter, the original value is used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DisableInternet', + 'in' => 'query', + 'schema' => ['description' => 'The AppCode authentication type supported. Valid values:'."\n" + ."\n" + .'- DEFAULT: supported after being made available in Alibaba Cloud Marketplace'."\n" + ."\n" + .'- DISABLE: not supported'."\n" + ."\n" + .'- HEADER : supported only in the Header parameter'."\n" + ."\n" + .'- HEADER\\_QUERY: supported in the Header or Query parameter', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AppCodeAuthType', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'title' => ''], + ], + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable backend services.', 'type' => 'string', 'required' => false, 'example' => '0d105f80a8f340408bd34954d4e4ff22', 'title' => ''], + ], + [ + 'name' => 'BackendEnable', + 'in' => 'query', + 'schema' => ['description' => 'Configuration Mode', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -23446,323 +19042,458 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DownloadLink' => [ - 'description' => 'The code of the SDK by using the Base64 scheme. You can obtain the file by using the Base64 decoding scheme.'."\n", - 'type' => 'string', - 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......\\",\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]', - 'title' => 'SdkGenerateByAppForRegion', - ], - 'SdkGenerateByApp' => [ - 'summary' => 'Generates an SDK by application.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', + 'title' => 'ModifyApi', + 'description' => '**This operation is intended for API providers.**'."\n" + ."\n" + .'- This API operation requires a full update. Updates of partial parameters are not supported.'."\n" + ."\n" + .'- When you modify an API name, make sure that the name of each API within the same group is unique.'."\n" + ."\n" + .'- When you modify the request path, make sure that each request path within the same group is unique.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyApiConfiguration' => [ + 'summary' => 'This API operation is used to modify the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you need to only specify the value of AuthType, which is APP.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94474', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayY6W7D1', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110797019', - ], + 'schema' => ['description' => 'The ID of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'java', - ], + 'schema' => ['description' => 'The name of the API.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testModifyApiName', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'DownloadLink' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', - ], - ], - ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the API.', 'type' => 'string', 'example' => 'Test modify description', 'required' => false, 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......\\",\\n \\"RequestId\\": \\"61A16D46-EC04-5288-8A18-811B0F536CC2\\"\\n}","type":"json"}]', - 'title' => 'SdkGenerateByApp', - ], - 'SdkGenerateByGroup' => [ - 'summary' => 'Generates an SDK by API group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to make the API public. Valid values:'."\n" + ."\n" + .'- **PUBLIC:** The API is public. If this parameter is set to PUBLIC, the API is displayed on the APIs page for all users after the API is published to the production environment.'."\n" + ."\n" + .'- **PRIVATE:** The API is private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PUBLIC', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94475', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayY6W7D1', + [ + 'name' => 'ForceNonceCheck', + 'in' => 'query', + 'schema' => ['description' => '- Specifies whether to forcibly check X-Ca-Nonce. If the **ForceNonceCheck** parameter is set to **true**, X-Ca-Nonce is forcibly checked. X-Ca-Nonce is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks.'."\n" + ."\n" + .'- If the **ForceNonceCheck** parameter is set to **false**, X-Ca-Nonce is not checked. If you do not modify this parameter when you modify an API, the original value is used.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'DisableInternet', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1a991a450b9548a1a3df38fd3af117c2', - ], + 'schema' => ['description' => '- Specifies whether to call the API only in an internal network. If the **DisableInternet** parameter is set to **true**, the API can be called only in an internal network.'."\n" + ."\n" + .'- If the **DisableInternet** parameter is set to **false**, the API can be called over the Internet and in an internal network.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'AppCodeAuthType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'java', - ], + 'schema' => ['description' => 'If the **AuthType** parameter is set to **APP**, the valid values are:'."\n" + ."\n" + .'- **DEFAULT**: The default value that is used if no other values are passed. This value indicates that the settings of the group are used.'."\n" + ."\n" + .'- **DISABLE**: The authentication is disabled.'."\n" + ."\n" + .'- **HEADER**: AppCode can be placed in the Header parameter for authentication.'."\n" + ."\n" + .'- **HEADER\\_QUERY**: AppCode can be placed in the Header or Query parameter for authentication.', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'title' => ''], + ], + [ + 'name' => 'AllowSignatureMethod', + 'in' => 'query', + 'schema' => ['description' => 'If the **AuthType** parameter is set to **APP**, you must include this parameter to specify the signature algorithm. If you do not specify a value, HmacSHA256 is used by default. Valid values:'."\n" + ."\n" + .'- HmacSHA256'."\n" + ."\n" + .'- HmacSHA1,HmacSHA256', 'type' => 'string', 'required' => false, 'example' => 'HmacSHA256', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'API Security authentication type,Valid values::'."\n" + ."\n" + .'- **APP**:Only authorized APP Call'."\n" + ."\n" + .'- **ANONYMOUS**:Allow anonymous calls,Exercise caution when you allow anonymous calls.:'."\n" + ."\n" + .' - Anyone who can obtain this API person who can access service information,can call this API.The gateway does not authenticate callers.,You cannot configure user-level throttling either.,If you expose this API Configure API traffic throttling;'."\n" + ."\n" + .' - AppCodeAuthType does not take effect.', 'type' => 'string', 'required' => false, 'example' => 'APP', 'title' => ''], + ], + [ + 'name' => 'RequestProtocol', + 'in' => 'query', + 'schema' => ['description' => 'The protocol type supported by the API. Valid values: HTTP and HTTPS. Separate multiple values with commas (,), such as "HTTP,HTTPS".', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'RequestHttpMethod', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + ], + [ + 'name' => 'RequestPath', + 'in' => 'query', + 'schema' => ['description' => 'The path of the API request. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the path of the API request is `/object/add`.', 'type' => 'string', 'required' => false, 'example' => '/test/api', 'title' => ''], + ], + [ + 'name' => 'RequestMode', + 'in' => 'query', + 'schema' => ['description' => 'The request mode. Valid values:'."\n" + ."\n" + .'- MAPPING: Parameters are mapped. Unknown parameters are filtered out.'."\n" + ."\n" + .'- PASSTHROUGH: Parameters are passed through.'."\n" + ."\n" + .'- MAPPING\\_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.', 'type' => 'string', 'required' => false, 'example' => 'MAPPING', 'title' => ''], + ], + [ + 'name' => 'BodyFormat', + 'in' => 'query', + 'schema' => ['description' => 'This parameter takes effect only when the **RequestMode** parameter is set to **MAPPING**.'."\n" + ."\n" + .'The format in which data is transmitted to the server for POST and PUT requests. Valid values: **FORM** and **STREAM**. FORM indicates that data is transmitted in the key-value pair format. STREAM indicates that data is transmitted as byte streams.', 'type' => 'string', 'required' => false, 'example' => 'STREAM', 'title' => ''], + ], + [ + 'name' => 'PostBodyDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the request body.', 'type' => 'string', 'example' => 'Body description', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'BodyModel', + 'in' => 'query', + 'schema' => ['description' => 'The body model.', 'type' => 'string', 'required' => false, 'example' => 'https://apigateway.aliyun.com/models/f4e7333c****40dcbaf7c9da553ccd8d/3ab61f775b****d4bc35e993****87aa8', 'title' => ''], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the model.', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], + ], + [ + 'name' => 'BackendName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the backend service. This parameter takes effect only when the UseBackendService parameter is set to TRUE.', 'type' => 'string', 'required' => false, 'example' => 'testBackendService', 'title' => ''], + ], + [ + 'name' => 'ServiceProtocol', + 'in' => 'query', + 'schema' => ['description' => 'The protocol that is used to access backend services. Valid values:'."\n" + ."\n" + .'- Http: for backend services that use HTTP or HTTPS'."\n" + ."\n" + .'- Vpc: for backend services that use VPC'."\n" + ."\n" + .'- FC: for Function Compute'."\n" + ."\n" + .'- OSS: for Object Storage Service'."\n" + ."\n" + .'- Mock: for backend services that use the Mock mode'."\n" + ."\n" + .'- EventBridge: for EventBridge'."\n" + ."\n" + .'You must specify the config value for the corresponding backend service.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'HttpConfig', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP configuration.', 'type' => 'string', 'required' => false, 'example' => '{"serviceAddress":"http://test.api.com","servicePath":"/test/api","serviceHttpMethod":"GET"}', 'title' => ''], + ], + [ + 'name' => 'VpcConfig', + 'in' => 'query', + 'schema' => ['description' => 'The VPC configuration.', 'type' => 'string', 'required' => false, 'example' => '{"VpcId":"vpc-xxxxxxx","Name":"testVpc","InstanceId":"i-p0ssssss","Port":80,"servicePath":"/test/vpc","serviceHttpMethod":"HEAD"}', 'title' => ''], + ], + [ + 'name' => 'FunctionComputeConfig', + 'in' => 'query', + 'schema' => ['description' => 'The Function Compute configuration.', '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"}', 'title' => ''], + ], + [ + 'name' => 'OssConfig', + 'in' => 'query', + 'schema' => ['description' => 'The OSS configuration.', 'type' => 'string', 'required' => false, 'example' => '{"OssRegionId":"cn-hangzhou","Key":"/test.html","BucketName":"test-api-oss","Action":"GetObject"}', 'title' => ''], + ], + [ + 'name' => 'MockConfig', + 'in' => 'query', + 'schema' => ['description' => 'The Mock configuration.', 'type' => 'string', 'required' => false, 'example' => '{"MockResult":"test","MockHeaders":[{"HeaderName":"testHeader","HeaderValue":"testHeader"}],"MockStatusCode":"400"}', 'title' => ''], + ], + [ + 'name' => 'ServiceTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period of the backend service. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ContentTypeCategory', + 'in' => 'query', + 'schema' => ['description' => 'The ContentType configuration of the backend request.'."\n" + ."\n" + .'- DEFAULT: the default configuration in API Gateway'."\n" + ."\n" + .'- CUSTOM: a custom configuration', 'type' => 'string', 'required' => false, 'example' => 'DEFAULT', 'title' => ''], + ], + [ + 'name' => 'ContentTypeValue', + 'in' => 'query', + 'schema' => ['description' => 'The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.', 'type' => 'string', 'required' => false, 'example' => 'application/x-www-form-urlencoded; charset=UTF-8', 'title' => ''], + ], + [ + 'name' => 'RequestParameters', + 'in' => 'query', + 'schema' => ['description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n" + ."\n" + .'For more information, see [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"}]', 'title' => ''], + ], + [ + 'name' => 'ServiceParameters', + 'in' => 'query', + 'schema' => ['description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [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"}]', 'title' => ''], + ], + [ + 'name' => 'ServiceParametersMap', + 'in' => 'query', + 'schema' => ['description' => 'The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.'."\n" + ."\n" + .'For more information, see [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"}]', 'title' => ''], + ], + [ + 'name' => 'ResultType', + 'in' => 'query', + 'schema' => ['description' => 'The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. This value is used only to generate documents. It does not affect the returned result.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'JSON', 'title' => ''], + ], + [ + 'name' => 'ResultSample', + 'in' => 'query', + 'schema' => ['description' => 'The sample response from the backend service. This value is used only to generate documents. It does not affect the returned result.', '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}', 'title' => ''], + ], + [ + 'name' => 'FailResultSample', + 'in' => 'query', + 'schema' => ['description' => 'The sample error response from the backend service. This value is used only to generate documents. It does not affect the returned result.', 'type' => 'string', 'required' => false, 'example' => '{"errorCode":"fail","errorMessage":"param invalid"}', 'title' => ''], + ], + [ + 'name' => 'ErrorCodeSamples', + 'in' => 'query', + 'schema' => ['description' => 'The sample error codes returned by the backend service.'."\n" + ."\n" + .'For more information, see [ErrorCodeSample](~~44392~~).', 'type' => 'string', 'required' => false, 'example' => '[{"Code":"400","Message":"Missing the userId","Description":"param invalid"}]', 'title' => ''], + ], + [ + 'name' => 'UseBackendService', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use the information about the created backend service. Valid values:'."\n" + ."\n" + .'- TRUE: uses the information about the created backend service.'."\n" + ."\n" + .'- FALSE: uses the information about the custom backend service.', 'type' => 'boolean', 'required' => false, 'example' => 'TRUE', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'DownloadLink' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://oss-bucket/object', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DownloadLink\\": \\"http://oss-bucket/object\\",\\n \\"RequestId\\": \\"D0075BDA-8AED-5073-A70A-FE44E86AB20F\\"\\n}","type":"json"}]', - 'title' => 'SdkGenerateByGroup', - ], - 'CreateBackend' => [ - 'summary' => 'Creates a backend service in API Gateway.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","type":"json"}]', + 'title' => 'ModifyApiConfiguration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiConfiguration'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyApiConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyApiGroup' => [ + 'summary' => 'Modifies the name, description, or base path of an existing API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '94431', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'BackendName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testBackendService', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and is globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'BackendType', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The name of the API group. The name must be unique and 4 to 50 characters in length. It must start with a letter or a Chinese character and can contain letters, digits, underscores (\\_), and Chinese characters. If you do not specify this parameter, the name is not modified.', 'type' => 'string', 'required' => false, 'example' => 'NewWeather', 'title' => ''], + ], + [ + 'name' => 'BasePath', + 'in' => 'query', + 'schema' => ['description' => 'The root path of the API.', 'type' => 'string', 'required' => false, 'example' => '/eeee', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'release data api 411055691504981', - ], + 'schema' => ['description' => 'The description of the API group. The description can be up to 180 characters in length. If you do not specify this parameter, the description is not modified.', 'type' => 'string', 'required' => false, 'example' => 'New weather informations.', 'title' => ''], ], [ - 'name' => 'CreateEventBridgeServiceLinkedRole', + 'name' => 'UserLogConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies to create a EventBridge service-linked role.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The user log configuration.', 'type' => 'string', 'required' => false, 'example' => '{\\"requestBody\\":false,\\"responseBody\\":false,\\"queryString\\":\\"\\",\\"requestHeaders\\":\\"\\",\\"responseHeaders\\":\\"\\",\\"jwtClaims\\":\\"\\"}', 'title' => ''], ], [ - 'name' => 'CreateSlr', + 'name' => 'CustomTraceConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies to create a service-linked role.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The custom trace configuration.', 'type' => 'string', 'required' => false, 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}', 'title' => ''], + ], + [ + 'name' => 'CompatibleFlags', + 'in' => 'query', + 'schema' => ['description' => 'A list of associated tags. Separate multiple tags with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'depart:dep1', 'title' => ''], + ], + [ + 'name' => 'CustomerConfigs', + 'in' => 'query', + 'schema' => ['description' => 'The custom configuration item data.', 'type' => 'string', 'required' => false, 'example' => 'removeResponseServerHeader', 'title' => ''], + ], + [ + 'name' => 'PassthroughHeaders', + 'in' => 'query', + 'schema' => ['description' => 'The headers to pass through.', 'type' => 'string', 'required' => false, 'example' => 'eagleeye-rpcid,x-b3-traceid,host', 'title' => ''], + ], + [ + 'name' => 'DefaultDomain', + 'in' => 'query', + 'schema' => ['description' => 'The default domain name.', 'type' => 'string', 'required' => false, 'example' => 'mkt.api.gaore.com', 'title' => ''], + ], + [ + 'name' => 'RpcPattern', + 'in' => 'query', + 'schema' => ['description' => 'The RPC pattern.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", + 'description' => 'The object tags to which the rule applies. You can specify multiple tags.', 'type' => 'array', 'items' => [ + 'description' => 'A list of tags.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => true, 'example' => 'uat', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, + 'maxItems' => 500, + 'example' => 'Key, Value', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'BackendId' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'example' => '0d105f80a8f340408bd34954d4e4ff22', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '66D84355-164D-53ED-81FF-03DCF181DE24', - ], - ], - ], + [ + 'name' => 'SupportSSE', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether the gateway sends event streams to clients to enable real-time data push.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackendId\\": \\"0d105f80a8f340408bd34954d4e4ff22\\",\\n \\"RequestId\\": \\"66D84355-164D-53ED-81FF-03DCF181DE24\\"\\n}","type":"json"}]', - 'title' => 'CreateBackend', - ], - 'DeleteBackend' => [ - 'summary' => 'Deletes a backend service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'FilterAppCodeForBackend', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to filter the app code from backend requests.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'BackendId', + 'name' => 'CustomAppCodeConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '27be0dd9ebbc467b9e86c0d250d0b92e', - ], + 'schema' => ['description' => 'The custom app code configuration.', 'type' => 'string', 'required' => false, 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}', 'title' => ''], + ], + [ + 'name' => 'RpsLimitForServerless', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -23770,79 +19501,99 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', - ], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '4CF287C6-CE5B-477B-BE27-C48F99EADBC8', 'title' => ''], + 'BasePath' => ['description' => 'The root path of the API.', 'type' => 'string', 'example' => '/test', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and is globally unique.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group.', 'type' => 'string', 'example' => 'NewWeather', 'title' => ''], + 'Description' => ['description' => 'The description of the API group.', 'type' => 'string', 'example' => 'New weather informations.', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain name that the system assigns to the API group.', 'type' => 'string', 'example' => '523e8dc7bbe04613b5b1d726c2a7889d-cn-hangzhou.alicloudapi.com', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\"\\n}","type":"json"}]', - 'title' => 'DeleteBackend', - ], - 'ModifyBackend' => [ - 'summary' => 'Modifies the basic information of a backend service, such as name and description. The backend service type cannot be modified once the backend service is created.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyApiGroup', + 'description' => '- This feature is intended for API providers.'."\n" + ."\n" + .'- The queries per second (QPS) limit for this operation is 50 per user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'ModifyApiGroupInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'abilityTreeCode' => '94432', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'BackendName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testHttpModify', - ], + 'schema' => ['description' => 'The API group to migrate.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01c97ed08a614118849b00079753d1e2', 'title' => ''], ], [ - 'name' => 'BackendId', + 'name' => 'TargetInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20bcdc9453524b78a8beb1f6de21edb7', - ], + 'schema' => ['description' => 'The ID of the target instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-bj-c325375b1ebe', 'title' => ''], ], [ - 'name' => 'BackendType', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'migrate', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The object tags to which the rule applies. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'test', + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], ], @@ -23851,116 +19602,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DACA61-9359-5EC6-AEDA-C73E620E49A9', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06DACA61-9359-5EC6-AEDA-C73E620E49A9\\"\\n}","type":"json"}]', - 'title' => 'ModifyBackend', - ], - 'DescribeBackendList' => [ - 'summary' => 'Queries backend services. You can filter backend services by backend service name and backend service type.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyApiGroupInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupInstance'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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"}]', + 'summary' => 'Modifies a group instance.', + ], + 'ModifyApiGroupNetworkPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '114857', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94433', + 'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'], ], 'parameters' => [ [ - 'name' => 'BackendName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the backend service. You can use \\* to perform fuzzy queries.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0162c75d7d34ff48506f1aff878b05e', 'title' => ''], ], [ - 'name' => 'BackendType', + 'name' => 'HttpsPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'HTTP', - ], + 'schema' => ['description' => 'The HTTPS security policy.', 'type' => 'string', 'required' => false, 'example' => 'HTTPS1_1_TLS1_0', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'InternetEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to enable the virtual private cloud (VPC) second-level domain name.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InternetIPV6Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to enable IPv6. Valid values: **true** and **false**.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'VpcIntranetEnable', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of the tag.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'schema' => ['description' => 'Specifies whether to enable the VPC domain name. Valid values:'."\n" + ."\n" + .'- TRUE'."\n" + ."\n" + .'- FALSE', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'VpcSlbIntranetEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the self-calling domain name.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'InnerDomainEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to disable the public second-level domain name.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -23968,589 +19694,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The number of the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '090A0DF9-9144-5236-8CBA-E18DE317722D', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BackendInfoList' => [ - 'description' => 'The backend services.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BackendName' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'BackendType' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the backend service was modified.'."\n", - 'type' => 'string', - 'example' => '2022-01-25T11:22:29Z', - ], - 'Description' => [ - 'description' => 'The description of the backend service.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreatedTime' => [ - 'description' => 'The time when the backend service was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-25T11:22:29Z', - ], - 'BackendId' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'example' => '35bd31d32c9c425ebbe9330db9f8c375', - ], - 'Tags' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The name of the tag.', - 'type' => 'string', - 'example' => 'groupName', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'example' => 'e3b881d0-e2d0-4dfb-b1fb-a2a3d1e534b7', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeBackendList', - ], - 'DescribeBackendInfo' => [ - 'summary' => 'Queries the information about a backend service and its URL configured for each environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '115431', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', + 'title' => 'ModifyApiGroupNetworkPolicy', + 'summary' => 'Modifies the network policy of an API group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupNetworkPolicy'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'BackendId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '739b68751c0b4e899e04d0c92b6d0be7', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231', - ], - 'BackendInfo' => [ - 'description' => 'The information about the backend service.'."\n", - 'type' => 'object', - 'properties' => [ - 'BackendName' => [ - 'description' => 'The name of the backend service.'."\n", - 'type' => 'string', - 'example' => 'testoss2', - ], - 'BackendType' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the backend service was modified.'."\n", - 'type' => 'string', - 'example' => '2017-12-11T15:18:09+08:00', - ], - 'Description' => [ - 'description' => 'The description of the backend service.'."\n", - 'type' => 'string', - 'example' => 'add', - ], - 'CreatedTime' => [ - 'description' => 'The time when the backend service was created.'."\n", - 'type' => 'string', - 'example' => '2021-11-22T11:10:46+08:00', - ], - 'BackendId' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'example' => '6fc978bb63574146b766863dd7bdf661', - ], - 'BackendModels' => [ - 'description' => 'The configurations of the backend service in the environment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configurations of the backend service in the environment.'."\n", - 'type' => 'object', - 'properties' => [ - 'BackendModelId' => [ - 'description' => 'The ID of the backend service in the environment.'."\n", - 'type' => 'string', - 'example' => '5c4995d08e8b4954b0f326e8e4f2b97d', - ], - 'StageModeId' => [ - 'description' => 'The ID of the environment.'."\n", - 'type' => 'string', - 'example' => '6fc978bb63574146b766863dd7bdf661', - ], - 'Description' => [ - 'description' => 'The description of the backend service.'."\n", - 'type' => 'string', - 'example' => 'testDvs 1', - ], - 'GmtCreate' => [ - 'description' => 'The time when the backend service was created.'."\n", - 'type' => 'string', - 'example' => '2021-12-20T03:22:03.000+0000', - ], - 'GmtModified' => [ - 'description' => 'The time when the backend service was modified.'."\n", - 'type' => 'string', - 'example' => '2021-12-20T03:22:03.000+0000', - ], - 'StageName' => [ - 'description' => 'The environment name.'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'BackendConfig' => [ - 'description' => 'The backend service configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceAddress' => [ - 'description' => 'The URL of the backend service.'."\n", - 'type' => 'string', - 'example' => '10.0.0.1', - ], - 'HttpTargetHostName' => [ - 'description' => 'The host of the HTTP backend service.'."\n", - 'type' => 'string', - 'example' => 'www.host.com', - ], - 'Type' => [ - 'description' => 'The type of the backend service.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - 'VpcConfig' => [ - 'description' => 'The information about the backend service when the backend service is of the VPC type.'."\n", - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-wz9v96hqi6d14744sxqmx', - ], - 'InstanceId' => [ - 'description' => 'The ID of the Elastic Compute Service (ECS) or Server Load Balancer (SLB) instance in the VPC.'."\n", - 'type' => 'string', - 'example' => 'i-uf6iaale3gfef9t9cb41', - ], - 'Port' => [ - 'description' => 'The port number that corresponds to the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8080', - ], - 'VpcAccessId' => [ - 'description' => 'The ID of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => '2zej3ehuzg9m77kvwnfpn', - ], - 'Name' => [ - 'description' => 'The name of the VPC configuration.'."\n", - 'type' => 'string', - 'example' => 'dypls-cn-beijing-slb-pre', - ], - 'VpcScheme' => [ - 'description' => 'Indicates whether HTTP or HTTPS is used.'."\n", - 'type' => 'string', - 'example' => 'http', - ], - 'VpcTargetHostName' => [ - 'description' => 'The host of the VPC backend service.'."\n", - 'type' => 'string', - 'example' => 'openapi.alipan.com', - ], - ], - ], - 'FunctionComputeConfig' => [ - 'description' => 'The information about the backend service whose type is Function Compute.'."\n", - 'type' => 'object', - 'properties' => [ - 'FcType' => [ - 'description' => 'The type of the service in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'HttpTrigger', - ], - 'FcRegionId' => [ - 'description' => 'The region ID of the Function Compute service.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ServiceName' => [ - 'description' => 'The service name that is defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'myservice', - ], - 'FunctionName' => [ - 'description' => 'The function name that is defined in Function Compute.'."\n", - 'type' => 'string', - 'example' => 'edge_function', - ], - 'RoleArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is assumed by API Gateway to access Function Compute.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::31985*:role/aliyunserviceroleforbastionhostpam', - ], - 'Qualifier' => [ - 'description' => 'The alias of the function.'."\n", - 'type' => 'string', - 'example' => 'testQualifier', - ], - 'FcBaseUrl' => [ - 'description' => 'The root path of the Function Compute service.'."\n", - 'type' => 'string', - 'example' => 'https://t*******.ap-*****.fcapp.run/', - ], - 'OnlyBusinessPath' => [ - 'description' => 'Indicates whether the backend service receives only the service path.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TriggerName' => [ - 'type' => 'string', - 'description' => 'The name of the trigger.'."\n" - ."\n" - .'You can specify the TriggerName or TriggerUrl parameter. The TriggerName parameter is optional.'."\n", - 'example' => 'test1', - ], - ], - ], - 'OssConfig' => [ - 'description' => 'The information about the backend service whose type is Object Storage Service (OSS).'."\n", - 'type' => 'object', - 'properties' => [ - 'OssRegionId' => [ - 'description' => 'The region ID of the OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'BucketName' => [ - 'description' => 'The name of the OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'my_bucket', - ], - ], - ], - 'EventBridgeConfig' => [ - 'description' => 'The information about the backend service whose type is EventBridge.'."\n", - 'type' => 'object', - 'properties' => [ - 'EventBridgeRegionId' => [ - 'description' => 'The region ID of the event bus in EventBridge.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'EventSource' => [ - 'description' => 'The event source.'."\n", - 'type' => 'string', - 'example' => 'dds_driver', - ], - 'EventBus' => [ - 'description' => 'The event bus.'."\n", - 'type' => 'string', - 'example' => 'testBus', - ], - 'RoleArn' => [ - 'description' => 'The ARN of the RAM role to be assumed by API Gateway to access EventBridge.'."\n", - 'type' => 'string', - 'example' => 'acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport', - ], - ], - ], - 'MockConfig' => [ - 'description' => 'The information about the backend service when the backend service is of the Mock type.'."\n", - 'type' => 'object', - 'properties' => [ - 'MockResult' => [ - 'description' => 'The mocked response.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'MockStatusCode' => [ - 'description' => 'The status code in the mocked response.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'MockHeaders' => [ - 'description' => 'The header in the mocked response.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about service mocking.'."\n", - 'type' => 'object', - 'properties' => [ - 'HeaderName' => [ - 'description' => 'The header name.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'HeaderValue' => [ - 'description' => 'The header value.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - ], - ], - 'DiscoveryConfig' => [ - 'description' => 'The information about the backend service when the backend service is of the Service Discovery type.'."\n", - 'type' => 'object', - 'properties' => [ - 'RcType' => [ - 'description' => 'The registry type.'."\n", - 'type' => 'string', - 'example' => 'NACOS', - ], - 'NacosConfig' => [ - 'description' => 'The Nacos configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServerAddress' => [ - 'description' => 'The Nacos service address.'."\n", - 'type' => 'string', - 'example' => 'http://1xx.2xx.3xx.4xx:8848', - ], - 'Namespace' => [ - 'description' => 'The ID of the namespace where the microservice that is registered with Nacos resides.'."\n", - 'type' => 'string', - 'example' => 'public', - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the microservice that is registered with Nacos belongs.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT_GROUP', - ], - 'ServiceName' => [ - 'description' => 'The microservice name.'."\n", - 'type' => 'string', - 'example' => 'service-provider', - ], - 'Clusters' => [ - 'description' => 'The name of the cluster to which the microservice belongs.'."\n", - 'type' => 'string', - 'example' => 'cluster1', - ], - 'AuthType' => [ - 'description' => 'The authentication method.'."\n", - 'type' => 'string', - 'example' => 'PASSWORD', - ], - 'UserName' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'username', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'example' => 'password', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey of the RAM user that has the resource management permissions on Microservices Engine (MSE).'."\n", - 'type' => 'string', - 'example' => 'A5FIDxxxxxx', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey of the RAM user that has the resource management permissions on MSE.'."\n", - 'type' => 'string', - 'example' => 'dl5loxxxxxx', - ], - ], - ], - 'ZookeeperConfig' => [ - 'description' => 'The ZooKeeper configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConnectString' => [ - 'description' => 'The connection URL of the ZooKeeper server.'."\n", - 'type' => 'string', - 'example' => 'http://192.168.1.xxx:2181', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'provider', - ], - 'ServiceName' => [ - 'description' => 'Service name'."\n", - 'type' => 'string', - 'example' => 'service', - ], - ], - ], - ], - ], - 'ServiceTimeout' => [ - 'description' => 'The timeout period of the backend service, in millisecond.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'EdasConfig' => [ - 'description' => 'The EDAS configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'MicroserviceNamespaceName' => [ - 'description' => 'The name of the microservices namespace in EDAS.'."\n", - 'type' => 'string', - 'example' => 'Edas-Nacos', - ], - 'MicroserviceNamespaceId' => [ - 'description' => 'The ID of the microservices namespace in EDAS.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou:edasNacos', - ], - 'MicroserviceNamespace' => [ - 'description' => 'The ID of the microservices namespace in EDAS.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou:edasNacos'."\n", - ], - 'ServiceName' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'service', - ], - 'EdasAppId' => [ - 'description' => 'The EDAS application ID.'."\n", - 'type' => 'string', - 'example' => '6cd0c599-dxxx-496d-b3d5-6a71c657xxxxx', - ], - 'RegistryType' => [ - 'description' => 'The registration type.'."\n", - 'type' => 'string', - 'example' => 'EDAS', - ], - 'MseInstanceId' => [ - 'description' => 'The MSE instance ID.'."\n", - 'type' => 'string', - 'example' => 'mse-cn-jia3n1rxxxx', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + '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\\": \\"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"}]', - 'title' => 'DescribeBackendInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E707B25-5119-5ACF-9D26-7D2A2762F05C\\"\\n}","type":"json"}]', ], - 'DescribeUpdateBackendTask' => [ - 'summary' => 'Queries the update results of associated published APIs after the definition of a backend service is modified in an environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyApiGroupVpcWhitelist' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '119939', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94434', + 'abilityTreeNodes' => ['FEATUREapigatewaySKO2I5'], ], 'parameters' => [ [ - 'name' => 'OperationUid', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4e13c3e0c44c4a4ebb5231264eeb9bc1', - ], + 'schema' => ['description' => 'The ID of the API group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9b80408147724ddab4c4e2703c6ca019', 'title' => ''], + ], + [ + 'name' => 'VpcIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the VPC instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp11w979o2s9rcr962w25', 'title' => ''], ], ], 'responses' => [ @@ -24558,153 +19756,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', - ], - 'ApiUpdateBackendResults' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiUpdateBackendResult' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd8f2f54f3309458b8aaceb36c01c2dd9', - ], - 'UpdateStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OVER', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'imotob1', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3013a55c0c44483f984d26df27120513', - ], - 'ApiUid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '14faa7ba0572445685866ddb6a6f19da', - ], - 'ErrorMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Failed', - ], - 'StageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'checkin_linechart_today', - ], - 'BackendId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c09b078bcb8f4ade9677bd8b18cdf43f', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F8B9DC8C-D6E2-5065-BD1F-0401866E7F10', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - '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"}]', - 'title' => 'DescribeUpdateBackendTask', - ], - 'CreateBackendModel' => [ - 'summary' => 'Creates a backend service configuration in an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B9DC8C-D6E2-5065-BD1F-0401866E7F10\\"\\n}","type":"json"}]', + 'title' => 'ModifyApiGroupVpcWhitelist', + 'summary' => 'Modifies the VPC whitelist of an API group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApiGroupVpcWhitelist'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies a specified application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94436', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'BackendId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '34e94fcd3e2e47a49824a89b8f92cb5e', - ], + 'schema' => ['description' => 'The unique ID of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20112314518278', 'title' => ''], ], [ - 'name' => 'BackendType', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - 'docRequired' => true, - ], + 'schema' => ['description' => 'The application name. The name can contain Chinese characters, letters, digits, and underscores (\\_). It must start with a letter or a Chinese character. The name must be 4 to 26 characters in length. Each Chinese character is counted as two characters.'."\n" + ."\n" + .'Omit this parameter if you do not want to modify the application name.', 'type' => 'string', 'required' => false, 'example' => 'jiedian_pord', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The description of the application. The description can be up to 180 characters in length.'."\n" + ."\n" + .'Omit this parameter if you do not want to modify the description.', 'type' => 'string', 'required' => false, 'example' => 'modidyTest', 'title' => ''], ], [ - 'name' => 'BackendModelData', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The object tags to which the rule applies.', + 'type' => 'array', + 'items' => [ + 'description' => 'Specifies one or more object tags to which the rule applies.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n" + ."\n" + .'The range for n is `[1, 20]`.', 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n" + ."\n" + .'The valid range for n is `[1, 20]`.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => '{\\"ServiceAddress\\":\\"http://apigateway-echo-redux.alicloudapi.com:8080\\"}', + 'example' => 'Key, Value', + 'maxItems' => 20, + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'Extend', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'model description', - ], + 'schema' => ['description' => 'Extended information.', 'type' => 'string', 'required' => false, 'example' => '110461946884', 'title' => ''], + ], + [ + 'name' => 'Disabled', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -24712,77 +19868,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'BackendModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackendModelId\\": \\"4be6b110b7aa40b0bf0c83cc00b3bd86\\",\\n \\"RequestId\\": \\"64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA\\"\\n}","type":"json"}]', - 'title' => 'CreateBackendModel', - ], - 'DeleteBackendModel' => [ - 'summary' => 'Deletes the definition of a backend service in an environment. After the definition is deleted, the API that uses the backend service and is published to this environment will be unpublished.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]', + 'title' => 'ModifyApp', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- You can modify the **AppName** or **Description** parameter. If you do not specify these parameters, the application is not modified, but a success message is returned.'."\n" + ."\n" + .'- The queries per second (QPS) limit for this operation is 50 for each user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'BackendModelId', + 'name' => 'BackendName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend model.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', - ], + 'schema' => ['description' => 'The name of the backend service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testHttpModify', 'title' => ''], ], [ 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the backend service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20bcdc9453524b78a8beb1f6de21edb7', - ], + 'schema' => ['description' => 'The ID of the backend service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20bcdc9453524b78a8beb1f6de21edb7', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'BackendType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The type of the backend service.', 'type' => 'string', 'required' => true, 'example' => 'HTTP', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -24790,34 +19944,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', - ], - 'OperationId' => [ - 'description' => 'The ID of the operation.'."\n", - 'type' => 'string', - 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '06DACA61-9359-5EC6-AEDA-C73E620E49A9', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\",\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\"\\n}","type":"json"}]', - 'title' => 'DeleteBackendModel', - ], - 'ModifyBackendModel' => [ - 'summary' => 'Modifies the definition of a backend service in the environment. After the modification, the backend paths of the APIs that use the backend service in the same environment will be updated at the same time automatically. You do not need to manually publish the APIs again.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyBackend', + 'summary' => 'You cannot modify the basic information of a backend service—such as its name, description, or backend service type—after the backend service is created.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackend'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'This operation modifies the definition of a backend service in an environment. After the modification, the backend addresses of APIs that use this backend service and are published in this environment are batch updated automatically, without requiring manual publishing.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24827,71 +19989,46 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ 'name' => 'BackendId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '20bcdc9453524b78a8beb1f6de21edb7', - ], + 'schema' => ['description' => 'Backend ID', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '20bcdc9453524b78a8beb1f6de21edb7', 'title' => ''], ], [ 'name' => 'BackendType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - ], + 'schema' => ['description' => 'Backend type', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'Specify the environment for the API operation.'."\n" + ."\n" + .'- **RELEASE**: Online'."\n" + ."\n" + .'- **PRE**: Pre-release'."\n" + ."\n" + .'- **TEST**: Test', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TEST', 'title' => ''], ], [ 'name' => 'BackendModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3bb6375bc71c4e4c95ce05b4e7a55a9d', - ], + 'schema' => ['description' => 'Backend Model ID', 'type' => 'string', 'required' => false, 'example' => '3bb6375bc71c4e4c95ce05b4e7a55a9d', 'title' => ''], ], [ 'name' => 'BackendModelData', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{\\"ServiceAddress\\":\\"http://121.40.XX.XX\\"}', - ], + 'schema' => ['description' => 'Backend Model Data.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"ServiceAddress\\":\\"http://121.40.XX.XX\\"}', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'modify plugin first', - ], + 'schema' => ['description' => 'Description of the backend model definition', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'modify plugin first', 'title' => ''], ], ], 'responses' => [ @@ -24899,84 +20036,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '19B89B04-418B-55EE-94A8-6B42CA06002A', - ], - 'OperationId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c16a1880f5164d779f6a54f64d997cd9', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '19B89B04-418B-55EE-94A8-6B42CA06002A', 'title' => ''], + 'OperationId' => ['description' => 'Operation ID.', 'type' => 'string', 'example' => 'c16a1880f5164d779f6a54f64d997cd9', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['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' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19B89B04-418B-55EE-94A8-6B42CA06002A\\",\\n \\"OperationId\\": \\"c16a1880f5164d779f6a54f64d997cd9\\"\\n}","type":"json"}]', 'title' => 'ModifyBackendModel', - ], - 'CreateSignature' => [ - 'summary' => 'Creates a backend signature key.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackendModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies the name of a custom dataset.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94280', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREapigatewayE6KZ22'], ], 'parameters' => [ [ - 'name' => 'SignatureName', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The displayed name of the key. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'backendsignature', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********'."\n", 'title' => ''], ], [ - 'name' => 'SignatureKey', + 'name' => 'DatasetName', 'in' => 'query', - 'schema' => [ - 'description' => 'The Key value of the key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'qwertyuiop', - ], + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'NewDatasetName', 'title' => ''], ], [ - 'name' => 'SignatureSecret', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The Secret value of the key. The value must be 6 to 30 characters in length and can contain letters, digits, and special characters. Special characters include underscores (\\_), at signs (@), number signs (#), exclamation points (!), and asterisks (\\*). The value must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'asdfghjkl', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -24984,64 +20112,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'SignatureId' => [ - 'description' => 'The ID of the back-end signature key.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'SignatureName' => [ - 'description' => 'The name of the back-end signature key.'."\n", - 'type' => 'string', - 'example' => 'backendsignature', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSignatureResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>\\r\\n <SignatureName>backendsignature</SignatureName>\\r\\n</CreateSignatureResponse>","errorExample":""}]', - 'title' => 'CreateSignature', - 'description' => '* This API is intended for API providers.'."\n" - .'* The API operation only creates a key policy. You must call the binding operation to bind the key to an API.'."\n" - .'* After the key is bound to the API, requests sent from API Gateway to the backend service contain signature strings. You can specify whether your backend service verifies these signature strings.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'DeleteSignature' => [ - 'summary' => 'Deletes a backend signature key.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDataset'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94298', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SignatureId', + 'name' => 'DatasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the key to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25a6589b2584ff490e891cc********', 'title' => ''], + ], + [ + 'name' => 'DatasetItemId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data entry.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5045****'."\n", 'title' => ''], + ], + [ + 'name' => 'ExpiredTime', + 'in' => 'query', + 'schema' => ['description' => 'The time in UTC when the data entry expires. The time is in the **yyyy-MM-ddTHH:mm:ssZ** format.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2022-09-22T12:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the data entry. The description cannot exceed 180 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], ], 'responses' => [ @@ -25049,184 +20181,219 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F7DE77BC-0F7D-5A18-B494-BD2C********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', - 'title' => 'DeleteSignature', - 'description' => '* This API is intended for API providers.'."\n" - .'* This API operation deletes an existing backend signature key.'."\n" - .'* You cannot delete a key that is bound to an API. To delete the key, you must unbind it first.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'ModifySignature' => [ - 'summary' => 'Modifies a backend signature key.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyDatasetItem', + 'summary' => 'Modifies the timeout period and description of a data entry in a custom dataset.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDatasetItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies the properties of an API Gateway instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '94448', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'abilityTreeCode' => '94438', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'SignatureId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the signature key that you want to manage.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-ht-8xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'SignatureName', + 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The new name of the key. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'backendsignature', - ], + 'schema' => ['description' => 'Instance Name', 'type' => 'string', 'required' => false, 'example' => 'apigatewayInstance', 'title' => ''], ], [ - 'name' => 'SignatureKey', + 'name' => 'HttpsPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'The new Key value of the key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'qwertyuiop', - ], + 'schema' => ['description' => 'The HTTPS policy.', 'type' => 'string', 'required' => false, 'example' => 'HTTPS2_TLS1_0', 'title' => ''], ], [ - 'name' => 'SignatureSecret', + 'name' => 'IPV6Enabled', + 'in' => 'query', + 'schema' => ['description' => 'If enable inbound IPv6 Traffic.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EgressIpv6Enable', + 'in' => 'query', + 'schema' => ['description' => 'If enable outbound IPv6 Traffic.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'VpcSlbIntranetEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the self-calling domain name.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => ['description' => 'The token of the request.', 'type' => 'string', 'required' => false, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', 'title' => ''], + ], + [ + 'name' => 'IntranetSegments', + 'in' => 'query', + 'schema' => ['description' => 'Custom private CIDR block.', 'type' => 'string', 'required' => false, 'example' => '172.0.0.1/24', 'title' => ''], + ], + [ + 'name' => 'MaintainStartTime', 'in' => 'query', + 'schema' => ['description' => 'Maintainable start time.', 'type' => 'string', 'required' => false, 'example' => '18:00Z', 'title' => ''], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => ['description' => 'Maintainable end time.', 'type' => 'string', 'required' => false, 'example' => '23:00Z', 'title' => ''], + ], + [ + 'name' => 'ToConnectVpcIpBlock', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The new Secret value of the key. The value must be 6 to 30 characters in length and can contain letters, digits, and special characters. Special characters include underscores (\\_), at signs (@), number signs (#), exclamation points (!), and asterisks (\\*). The value must start with a letter.'."\n", - 'type' => 'string', + 'description' => 'The information about the CIDR block that API Gateway can use to access the virtual private cloud (VPC) of the backend service.', + 'type' => 'object', + 'properties' => [ + 'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz94cqvaoe1ipxxxxxx', 'title' => ''], + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a', 'title' => ''], + 'CidrBlock' => ['description' => 'The CIDR block of the VSwitch.', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/16', 'title' => ''], + 'Customized' => ['description' => 'Specifies whether the CIDR block is a custom CIDR block.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], 'required' => false, - 'example' => 'asdfghjkl', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'DeleteVpcIpBlock', + 'in' => 'query', + 'schema' => ['description' => 'If delete VPC Ip block.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'SignatureId' => [ - 'description' => 'The ID of the key.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'SignatureName' => [ - 'description' => 'The name of the key.'."\n", - 'type' => 'string', - 'example' => 'backendsignature', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifySignatureResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>\\r\\n <SignatureName>backendsignature</SignatureName>\\r\\n</ModifySignatureResponse>","errorExample":""}]', - 'title' => 'ModifySignature', - 'description' => '* This API is intended for API providers.'."\n" - .'* This API operation modifies the name, Key value, and Secret value of an existing signature key.'."\n" - .'* Note that the modification takes effect immediately. If the key has been bound to an API, you must adjust the backend signature verification based on the new key accordingly.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'SetSignatureApis' => [ - 'summary' => 'Binds a signature key to APIs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyInstanceAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAttribute'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '94485', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'abilityTreeCode' => '94441', + 'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'], ], 'parameters' => [ [ - 'name' => 'SignatureId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The signature ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'apigateway-cn-v6419k43xxxxx', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceSpec', 'in' => 'query', - 'schema' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The specifications of the instance.', 'type' => 'string', 'required' => true, 'example' => 'api.s1.small', 'title' => ''], ], [ - 'name' => 'ApiIds', + 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'description' => 'The API IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', - ], + 'schema' => ['description' => 'Specifies whether payment is automatically made during renewal. Valid values:'."\n" + ."\n" + .'- **True**: Automatic payment is enabled. Make sure that your Alibaba Cloud account has adequate balance.'."\n" + ."\n" + .'- **False**: Automatic payment is disabled. You have to manually pay in the console. Log on to the console. In the upper-right corner, choose **Expenses > User Center**. In the left-side navigation pane, click **Orders**. On the page that appears, find your order and complete the payment.'."\n" + ."\n" + .'Default value: **False**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the testing environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The password.', 'type' => 'string', 'required' => true, 'example' => 'b5845042-2f2f-4e96-bd5c-36c6e5c2a68c', 'title' => ''], + ], + [ + 'name' => 'ModifyAction', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to upgrade or downgrade the instance. Valid values:'."\n" + ."\n" + .'- **UPGRADE**'."\n" + ."\n" + .'- **DOWNGRADE**'."\n" + ."\n" + .'Default value: **UPGRADE**.', 'type' => 'string', 'required' => false, 'example' => 'UPGRADE', 'title' => ''], + ], + [ + 'name' => 'SkipWaitSwitch', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to skip the Waiting for Traffic Switchover state. During the upgrade or downgrade, a new outbound IP address may be added to the API Gateway instance. The Waiting for Traffic Switchover state is used to remind users of adding the new outbound IP address to the whitelist. If you set the SkipWaitSwitch parameter to true, the instance does not enter the Waiting for Traffic Switchover state when a new outbound IP address is available. Instead, the system sends internal messages to the user.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -25234,84 +20401,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27F9C50D-7EB4-5623-8472-45B3C7602C91\\"\\n}","type":"json"}]', - 'title' => 'SetSignatureApis', - ], - 'DescribeSignatures' => [ - 'summary' => 'Queries backend signature keys.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyInstanceSpec', + 'summary' => 'Upgrades or downgrades the configurations of an API Gateway instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceSpec'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyInstanceSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36BBBAD4-1CFB-489F-841A-8CA52EEA787E\\"\\n}","type":"json"}]', + ], + 'ModifyInstanceVpcAttributeForConsole' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94399', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94442', + 'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'], ], 'parameters' => [ [ - 'name' => 'SignatureId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the keys to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apigateway-bj-f28baxxxxb51', 'title' => ''], ], [ - 'name' => 'SignatureName', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The names of the keys to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'backendsignature', - ], + 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-8vbnnd66xxxx2xb5oig4f', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Token', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The token of the request.', 'type' => 'string', 'required' => false, 'example' => '505959c38776d9324945dbff709582', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'VpcOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1121011712128923', 'title' => ''], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bj9e2i8w3wz7shkvnuj9a', 'title' => ''], + ], + [ + 'name' => 'DeleteVpcAccess', + 'in' => 'query', + 'schema' => ['description' => 'Whether delete instance client VPC.'."\n" + ."\n" + .'- FALSE: set or modify instance client VPC'."\n" + ."\n" + .'- TRUE: delete instance client VPC', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -25319,148 +20487,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'SignatureInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SignatureInfo' => [ - 'description' => 'The returned signature information. It is an array consisting of SignatureInfo data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The last modification time of the key.'."\n", - 'type' => 'string', - 'example' => '2016-07-24T08:28:48Z', - ], - 'SignatureId' => [ - 'description' => 'The ID of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'SignatureSecret' => [ - 'description' => 'The Secret value of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'asdfghjkl', - ], - 'SignatureName' => [ - 'description' => 'The name of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'backendsignature', - ], - 'SignatureKey' => [ - 'description' => 'The Key value of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'qwertyuiop', - ], - 'CreatedTime' => [ - 'description' => 'The creation time of the key.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'RegionId' => [ - 'description' => 'The region where the key is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D08741CF-BE59-5DA6-B06F-BB65173110C0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeSignaturesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <SignatureInfos>\\r\\n <SignatureInfo>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId> \\r\\n <SignatureName>backendsignature</SignatureName>\\r\\n <SignatureKey>qwertyuiop</SignatureKey>\\r\\n <SignatureSecret>asdfghjkl</SignatureSecret>\\r\\n <CreatedTime>2016-07-23T08:28:48Z</CreatedTime>\\r\\n <ModifiedTime>2016-07-24T08:28:48Z</ModifiedTime>\\r\\n </SignatureInfo>\\r\\n </SignatureInfos>\\r\\n</DescribeSignaturesResponse>","errorExample":""}]', - 'title' => 'DescribeSignatures', - 'description' => '* This API is intended for API providers.'."\n" - .'* This operation is used to query the backend signature keys in a Region. Region is a system parameter.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApisBySignature' => [ - 'summary' => 'Queries the APIs to which a specified backend signature key is bound.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Modify instance client VPC config', + 'summary' => 'Modify instance client VPC config.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceVpcAttributeForConsole'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyInstanceVpcAttributeForConsole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D08741CF-BE59-5DA6-B06F-BB65173110C0\\"\\n}","type":"json"}]', + ], + 'ModifyIntranetDomainPolicy' => [ + 'summary' => 'Modifies the VPC domain name policy of an API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '192821', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'SignatureId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the signature key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'VpcIntranetEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Specifies whether to enable the VPC domain name. Valid values:'."\n" + ."\n" + .'- TRUE'."\n" + ."\n" + .'- FALSE', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -25468,188 +20555,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ApiInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiInfo' => [ - 'description' => 'The returned API information. It is an array consisting of ApiInfo data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The binding time of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**'."\n" - .'* **PRIVATE**'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'mygroup', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '0009db9c828549768a200320714b8930', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], - 'RegionId' => [ - 'description' => 'The region where the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"描述\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeApisBySignatureResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiInfos>\\r\\n <ApiInfo>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>0009db9c828549768a200320714b8930</GroupId> \\r\\n <GroupName>mygroup</GroupName>\\r\\n <StageName>test</StageName>\\r\\n <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>\\r\\n <ApiName>testapi</ApiName>\\r\\n <Description>描述</Description>\\r\\n <Visibility>public</Visibility>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiInfo>\\r\\n </ApiInfos>\\r\\n</DescribeApisBySignatureResponse>","errorExample":""}]', - 'title' => 'DescribeApisBySignature', - 'description' => '* This API is intended for API providers.'."\n" - .'* The results are returned on separate pages. You can specify PageNumber to obtain the result on the specified page.'."\n", - ], - 'DescribeApiSignatures' => [ - 'summary' => 'Queries the backend signature keys that are bound to the APIs of a specified API group in a specified environment.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyIntranetDomainPolicy', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIntranetDomainPolicy'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies an access control list (ACL).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94330', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94443', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'ApiIds', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'IpControlName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The name of the ACL. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (\\_). The name cannot start with an underscore (\\_).', 'type' => 'string', 'required' => false, 'example' => 'testControl11', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The description. The description can be up to 200 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], ], ], 'responses' => [ @@ -25657,135 +20622,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ApiSignatures' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiSignatureItem' => [ - 'description' => 'The returned signature key information. It is an array consisting of ApiSignatureItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The time when the backend signature key was bound.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '46fbb52840d146f186e38e8e70fc8c90', - ], - 'SignatureId' => [ - 'description' => 'The ID of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'SignatureName' => [ - 'description' => 'The name of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'backendsignature', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiSignaturesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiSignatures>\\r\\n <ApiSignatureItem>\\r\\n <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>\\r\\n <ApiName>testapi</ApiName> \\r\\n <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId>\\r\\n <SignatureName>backendsignature</SignatureName>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiSignatureItem>\\r\\n </ApiSignatures>\\r\\n</DescribeApiSignaturesResponse>","errorExample":""}]', - 'title' => 'DescribeApiSignatures', - 'description' => '* This API is intended for API providers.'."\n" - .'* The ApiIds parameter is optional. If this parameter is not specified, all results in the specified environment of an API group are returned.'."\n", - ], - 'DescribeSignaturesByApi' => [ - 'summary' => 'Queries the backend signature keys that are bound to a specified API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyIpControl', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- This operation allows you to modify only the name and description of an ACL. You cannot modify the type of the ACL.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyIpControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'ModifyIpControlPolicyItem' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94400', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94444', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the group to which the API belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'PolicyItemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], + 'schema' => ['description' => 'The ID of the policy.', 'type' => 'string', 'required' => true, 'example' => 'P151617000829241', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The ID of the application that is restricted by the policy. You can configure the AppId parameter only when the value of the IpControlType parameter is ALLOW.'."\n" + ."\n" + .'- You can add only one application ID at a time.'."\n" + ."\n" + .'- If this parameter is empty, no applications are restricted.'."\n" + ."\n" + .'- If this parameter is not empty, not only IP addresses but also applications are restricted.'."\n" + ."\n" + .'- If this parameter is not empty and no security authentication method is specified for the API, all API calls are restricted.'."\n" + ."\n" + .'- If the value of the IpControlType parameter is REFUSE and the AppId parameter is not empty, API Gateway automatically ignores the AppId parameter and restricts only the IP addresses.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => ['description' => 'The IP address or CIDR block that is defined in a policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks.', 'type' => 'string', 'required' => true, 'example' => '113.125.1.101;101.11.1.1', 'title' => ''], ], ], 'responses' => [ @@ -25793,118 +20709,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'Signatures' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SignatureItem' => [ - 'description' => 'The returned signature key information. It is an array consisting of SignatureItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The time when the key was bound.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'SignatureId' => [ - 'description' => 'The ID of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'SignatureName' => [ - 'description' => 'The name of the backend signature key.'."\n", - 'type' => 'string', - 'example' => 'mysecret', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeSignaturesByApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <Signatures>\\r\\n <SignatureItem>\\r\\n <SignatureId>dd05f1c54d6749eda95f9fa6d491449a</SignatureId> \\r\\n <SignatureName>mysecret</SignatureName>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </SignatureItem>\\r\\n </Signatures>\\r\\n</DescribeSignaturesByApiResponse>","errorExample":""}]', - 'title' => 'DescribeSignaturesByApi', - 'description' => '* This API is intended for API providers.'."\n", - ], - 'RemoveSignatureApis' => [ - 'summary' => 'Unbinds a backend signature key from APIs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyIpControlPolicyItem', + 'summary' => 'Modifies a policy in an access control list (ACL).', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- The modification immediately takes effect on all the APIs that are bound to the policy.'."\n" + ."\n" + .'- This operation causes a full modification of the content of a policy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIpControlPolicyItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'ModifyLogConfig' => [ + 'summary' => 'Modifies the log configuration.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94467', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayXW2LMR', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94445', + 'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'], ], 'parameters' => [ [ - 'name' => 'SignatureId', + 'name' => 'SlsProject', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the signature key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The name of the Simple Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'ford-api-gateway-log', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'SlsLogStore', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group to which the API that you want to manage belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The name of the Logstore in Simple Log Service.', 'type' => 'string', 'required' => true, 'example' => 'logs-gateway', 'title' => ''], ], [ - 'name' => 'ApiIds', + 'name' => 'LogType', 'in' => 'query', 'schema' => [ - 'description' => 'The IDs of the APIs from which you want to unbind the signature key.'."\n" + 'description' => 'The log type. Valid values:'."\n" ."\n" - .'* If this parameter is not specified, the signature key is unbound from all the APIs in the specified environment of the API group.'."\n" - .'* The IDs of the APIs that you want to manage. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" + .'- **log**: logs'."\n" ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", + .'- **survey**: survey logs', 'type' => 'string', - 'required' => true, - 'example' => 'TEST', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => ['PROVIDER'], + 'example' => 'PROVIDER', + 'title' => '', ], ], ], @@ -25913,87 +20797,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '75A4ADCB-AA26-51FB-94D4-AB3240040974', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveSignatureApisResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</RemoveSignatureApisResponse>","errorExample":""}]', - 'title' => 'RemoveSignatureApis', - 'description' => '* This API is intended for API providers.'."\n" - .'* The operation takes effect immediately. The request sent from API Gateway to the backend service does not contain the signature string. The corresponding verification step can be removed from the backend.'."\n", - ], - 'AddTrafficSpecialControl' => [ - 'summary' => 'Adds a custom special policy to a specified throttling policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyLogConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyLogConfig'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75A4ADCB-AA26-51FB-94D4-AB3240040974\\"\\n}","type":"json"}]', + ], + 'ModifyModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94247', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94446', + 'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'], ], 'parameters' => [ [ - 'name' => 'TrafficControlId', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the specified throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf123456', - ], + 'schema' => ['description' => 'The name of the model.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test', 'title' => ''], ], [ - 'name' => 'SpecialType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the special throttling policy. Valid values:'."\n" - ."\n" - .'* **APP**'."\n" - .'* **USER**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'APP', - ], + 'schema' => ['description' => 'The description of the new model definition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Model Description', 'title' => ''], ], [ - 'name' => 'SpecialKey', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app or Alibaba Cloud account. Specify this parameter based on the value of the **SpecialType** parameter. You can view your account ID on the [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.3f053654YpMPwo#/secure) page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3382463', - ], + 'schema' => ['description' => 'The new definition of the model.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"type\\":\\"object\\",\\"properties\\":{\\"id\\":{\\"format\\":\\"int64\\",\\"maximum\\":100,\\"exclusiveMaximum\\":true,\\"type\\":\\"integer\\"},\\"name\\":{\\"maxLength\\":10,\\"type\\":\\"string\\"}}}', 'title' => ''], ], [ - 'name' => 'TrafficValue', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The special throttling value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the API group to which the model belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30e792398d6c4569b04c0e53a3494381', 'title' => ''], + ], + [ + 'name' => 'NewModelName', + 'in' => 'query', + 'schema' => ['description' => 'The new name of the model.'."\n", 'type' => 'string', 'required' => false, 'example' => 'NewTest', 'title' => ''], ], ], 'responses' => [ @@ -26001,34 +20874,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', 'title' => ''], ], + 'description' => '', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<AddTrafficSpecialControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</AddTrafficSpecialControlResponse>","errorExample":""}]', - 'title' => 'AddTrafficSpecialControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* If the input SpecialKey already exists, the previous configuration is overwritten. Use caution when calling this operation.'."\n" - .'* Special throttling policies must be added to an existing throttling policy, and can take effect on all the APIs to which the throttling policy is bound.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4173F95B-360C-460C-9F6C-4A960B904411\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyModelResponse>\\r\\n <RequestId>4173F95B-360C-460C-9F6C-4A960B904411</RequestId>\\r\\n</ModifyModelResponse>","errorExample":""}]', + 'title' => 'ModifyModel', + 'summary' => 'Updates the model of an API group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTrafficControl' => [ - 'summary' => 'Creates a custom throttling policy.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyModel'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies the information of a plug-in.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26036,79 +20919,57 @@ ], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94281', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94447', + 'abilityTreeNodes' => ['FEATUREapigateway910B7T'], ], 'parameters' => [ [ - 'name' => 'TrafficControlName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the throttling policy. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It cannot start with an underscore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ThrottlingTest'."\n", - ], - ], - [ - 'name' => 'TrafficControlUnit', + 'name' => 'PluginId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit to be used in the throttling policy. Valid values:'."\n" - ."\n" - .'* **SECOND**'."\n" - .'* **MINUTE**'."\n" - .'* **HOUR**'."\n" - .'* **DAY**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MINUTE', - ], + 'schema' => ['description' => 'The ID of the plug-in whose information you want to modify.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a96926e82f994915a8da40a119374537 ', 'title' => ''], ], [ - 'name' => 'ApiDefault', + 'name' => 'PluginName', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each API.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The name of the plug-in. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). However, it cannot start with an underscore.', 'type' => 'string', 'required' => false, 'example' => 'modifyCors', 'title' => ''], ], [ - 'name' => 'UserDefault', + 'name' => 'PluginData', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each user.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The statement that is used to modify the plug-in definition.', 'type' => 'string', 'required' => false, 'example' => 'Plugin definition', 'title' => ''], ], [ - 'name' => 'AppDefault', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each app.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The description of the plug-in. The description can contain a maximum of 200 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'modify plugin first', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The description of the throttling policy.'."\n", - 'type' => 'string', + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n" + ."\n" + .'N can be an integer from 1 to 20.\\`\\`', 'type' => 'string', 'required' => true, 'example' => '\' \'', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'ThrottlingTestDescription'."\n", + 'example' => 'Key, Value', + 'maxItems' => 500, + 'title' => '', ], ], ], @@ -26117,108 +20978,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TrafficControlId' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'tf123456', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TrafficControlId\\": \\"tf123456\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTrafficControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TrafficControlId>tf123456</TrafficControlId>\\r\\n</CreateTrafficControlResponse>","errorExample":""}]', - 'title' => 'CreateTrafficControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* Throttling policies must be bound to APIs to take effect. After a policy is bound to an API, it goes into effect on that API immediately.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'DeleteAllTrafficSpecialControl' => [ - 'summary' => 'Deletes all custom special policies of a specified throttling policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'title' => 'ModifyPlugin', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- The name of the plug-in must be unique.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlugin'], ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'TrafficControlId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf123456', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Plugin', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}'], ], ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAllTrafficSpecialControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteAllTrafficSpecialControlResponse>","errorExample":""}]', - 'title' => 'DeleteAllTrafficSpecialControl', - 'description' => '* This API is intended for API providers.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","type":"json"}]', ], - 'DeleteTrafficControl' => [ - 'summary' => 'Deletes a custom throttling policy and the special throttling rules in the policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifySignature' => [ + 'summary' => 'Modifies a backend signature key.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94299', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94448', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'TrafficControlId', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf123456', - ], + 'schema' => ['description' => 'The ID of the signature key that you want to manage.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + ], + [ + 'name' => 'SignatureName', + 'in' => 'query', + 'schema' => ['description' => 'The new name of the key. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.', 'type' => 'string', 'required' => false, 'example' => 'backendsignature', 'title' => ''], + ], + [ + 'name' => 'SignatureKey', + 'in' => 'query', + 'schema' => ['description' => 'The new Key value of the key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores (\\_). It must start with a letter.', 'type' => 'string', 'required' => false, 'example' => 'qwertyuiop', 'title' => ''], + ], + [ + 'name' => 'SignatureSecret', + 'in' => 'query', + 'schema' => ['description' => 'The new Secret value of the key. The value must be 6 to 30 characters in length and can contain letters, digits, and special characters. Special characters include underscores (\\_), at signs (@), number signs (#), exclamation points (!), and asterisks (\\*). The value must start with a letter.', 'type' => 'string', 'required' => false, 'example' => 'asdfghjkl', 'title' => ''], ], ], 'responses' => [ @@ -26226,79 +21053,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], + 'SignatureId' => ['description' => 'The ID of the key.', 'type' => 'string', 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + 'SignatureName' => ['description' => 'The name of the key.', 'type' => 'string', 'example' => 'backendsignature', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTrafficControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteTrafficControlResponse>","errorExample":""}]', - 'title' => 'DeleteTrafficControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* If the throttling policy you want to delete is bound to APIs, you need to unbind the policy first. Otherwise, an error is reported when you delete the policy.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteTrafficSpecialControl' => [ - 'summary' => 'Deletes a custom special throttling policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifySignature', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- This API operation modifies the name, Key value, and Secret value of an existing signature key.'."\n" + ."\n" + .'- Note that the modification takes effect immediately. If the key has been bound to an API, you must adjust the backend signature verification based on the new key accordingly.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySignature'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifySignature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"SignatureId\\": \\"dd05f1c54d6749eda95f9fa6d491449a\\",\\n \\"SignatureName\\": \\"backendsignature\\"\\n}","type":"json"}]', + ], + 'ModifyStageModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94300', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TrafficControlId', + 'name' => 'StageAlias', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf123456', - ], + 'schema' => ['description' => 'The stage alias.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '生产环境', 'title' => ''], ], [ - 'name' => 'SpecialType', + 'name' => 'StageModelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the special throttling policy. Valid values:'."\n" - ."\n" - .'* **APP**'."\n" - .'* **USER**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'APP', - ], + 'schema' => ['description' => 'The stage configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sdljflsjflj324xxx', 'title' => ''], ], [ - 'name' => 'SpecialKey', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the app or Alibaba Cloud account. You can view your account ID on the [Account Management](https://account.console.aliyun.com/?spm=a2c4g.11186623.2.15.343130a8sDi8cO#/secure) page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3382463', - ], + 'schema' => ['description' => 'The stage description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -26306,30 +21125,37 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'example' => '6C87A26A-6A18-4B8E-8099-705278381xxx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTrafficSpecialControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteTrafficSpecialControlResponse>","errorExample":""}]', - 'title' => 'DeleteTrafficSpecialControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* You can obtain the input parameters required in this operation by calling other APIs.'."\n", + 'title' => 'ModifyStageModel', + 'summary' => 'Modifies a stage model.', + 'description' => 'This operation is for Open API users.'."\n" + ."\n" + .'- This operation supports only full updates.'."\n" + ."\n" + .'- API names must be unique within an API group.'."\n" + ."\n" + .'- Paths must be unique within an API group.'."\n" + ."\n" + .'- The rate limit for this operation is 50 queries per second (QPS) per user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381xxx\\"\\n}","type":"json"}]', ], 'ModifyTrafficControl' => [ - 'summary' => 'Modifies the settings of a custom throttling policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Modifies settings for a custom throttling policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26338,88 +21164,51 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '94449', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'tf123456', - ], + 'schema' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'required' => true, 'example' => 'tf123456', 'title' => ''], ], [ 'name' => 'TrafficControlName', 'in' => 'query', - 'schema' => [ - 'description' => 'The throttling policy name. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It cannot start with an underscore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ThrottlingTest'."\n", - ], + 'schema' => ['description' => 'The throttling policy name. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (\\_). It cannot start with an underscore.', 'type' => 'string', 'example' => 'Throttling test', 'required' => false, 'title' => ''], ], [ 'name' => 'TrafficControlUnit', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit to be used in the throttling policy. Valid values:'."\n" - ."\n" - .'* **SECOND**'."\n" - .'* **MINUTE**'."\n" - .'* **HOUR**'."\n" - .'* **DAY**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HOUR', - ], + 'schema' => ['description' => 'The unit to be used in the throttling policy. Valid values:'."\n" + ."\n" + .'- **SECOND**'."\n" + ."\n" + .'- **MINUTE**'."\n" + ."\n" + .'- **HOUR**'."\n" + ."\n" + .'- **DAY**', 'type' => 'string', 'required' => false, 'example' => 'HOUR', 'title' => ''], ], [ 'name' => 'ApiDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each API.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The default throttling value for each API.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'UserDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each user.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The default throttling value for each user.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'AppDefault', 'in' => 'query', - 'schema' => [ - 'description' => 'The default throttling value for each app.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The default throttling value for each app.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the throttling policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ThrottlingTestDescription'."\n", - ], + 'schema' => ['description' => 'The description of the throttling policy.', 'type' => 'string', 'example' => 'Throttling test description', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -26427,423 +21216,363 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 ', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 ', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 \\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyTrafficControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</ModifyTrafficControlResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 \\"\\n}","type":"json"}]', 'title' => 'ModifyTrafficControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* The modifications take effect on the bound APIs instantly.'."\n" - .'* The QPS limit on this operation is 50 per user.'."\n", - ], - 'SetTrafficControlApis' => [ - 'summary' => 'Binds a throttling policy to APIs.', - 'methods' => [ - 'post', - 'get', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The modifications take effect on the bound APIs instantly.'."\n" + ."\n" + .'- The QPS limit on this operation is 50 per user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTrafficControl'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyTrafficControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'TrafficControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyVpcAccessAndUpdateApis' => [ + 'summary' => 'Modifies the information of a VPC access authorization and updates the metadata of the associated API.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94486', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TrafficControlId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the new VPC.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-m5e7jqfppv5wbvmdw5pg2', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group containing the APIs to which you want to bind a specified throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The ID of the new instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => ' '."\n" + .'i-uf6bzcg1pr4oh5jjmxxx'."\n", 'title' => ''], ], [ - 'name' => 'ApiIds', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => 'The API ID for the specified operation. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', - ], + 'schema' => ['description' => 'The new port number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '80', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The name of the VPC authorization.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- The name of a VPC authorization cannot be changed. You cannot use this parameter to change the name of a VPC authorization.'."\n" + ."\n" + .'- You must set this parameter to the name of the current VPC authorization.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VpcName', 'title' => ''], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => ['description' => 'The token of the request.', 'type' => 'string', 'required' => false, 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', 'title' => ''], + ], + [ + 'name' => 'NeedBatchWork', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to update the associated API.'."\n" + ."\n" + .'\\*\\*'."\n" + ."\n" + .'**Warning:** If you want to update the VPC authorization of a published API, you must set this parameter to true. Otherwise, the update will not be synchronized to the backend service of the API.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Refresh', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to update the VPC authorization.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If the ID of the instance in your VPC is changed but the IP address of the instance remains unchanged, you can set this parameter to true to update the VPC authorization.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'VpcTargetHostName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The hostname of the backend service.', 'type' => 'string', 'required' => false, 'example' => 'iot.hu***ng.com', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'OperationId' => ['description' => 'The ID of the asynchronous task.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- If the associated API is updated, you can use the task ID in the **DescribeUpdateVpcInfoTask** operation to query the update result.', 'type' => 'string', 'example' => '7b6d0cb72b2e4215b0129f675c889746', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<SetTrafficControlApisResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</SetTrafficControlApisResponse>","errorExample":""}]', - 'title' => 'SetTrafficControlApis', - 'description' => '* This API is intended for API providers.'."\n" - .'* This API allows you to bind a specific throttling policy to up to 100 APIs at a time.'."\n", - ], - 'DescribeTrafficControls' => [ - 'summary' => 'Queries custom throttling policies and their details. Conditional queries are supported.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyVpcAccessAndUpdateApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyVpcAccessAndUpdateApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyVpcAccessAndUpdateApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"7b6d0cb72b2e4215b0129f675c889746\\",\\n \\"RequestId\\": \\"C2CEC6EA-EEBA-5FD6-8BD9-2CF01980FE39\\"\\n}","type":"json"}]', + ], + 'OpenApiGatewayService' => [ + 'summary' => 'Activates the gateway service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94409', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], - ], - 'parameters' => [ [ - 'name' => 'TrafficControlId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tf123456', - ], + 'APP' => [], ], [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The specified group ID. This parameter must be specified together with ApiId and StageName.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'PrivateKey' => [], ], [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The specified API ID. This parameter must be specified together with GroupId and StageName.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], + 'BearerToken' => [], ], - [ - 'name' => 'StageName', - 'in' => 'query', + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '94453', + 'abilityTreeNodes' => ['FEATUREapigatewayAQG9N5'], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The environment name. This parameter must be specified together with GroupId and ApiId. Valid values:********'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The order ID for activating the service.', 'type' => 'string', 'example' => '210981***530495', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'OpenApiGatewayService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenApiGatewayService'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'TrafficControlName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the throttling policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ThrottlingTest'."\n", + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'apigateway:OpenApiGatewayService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"210981***530495\\",\\n \\"RequestId\\": \\"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989\\"\\n}","type":"json"}]', + ], + 'QueryRequestLogs' => [ + 'summary' => 'Queries the request logs of a user.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94456', + 'abilityTreeNodes' => ['FEATUREapigatewayQEORTA'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'RequestLogId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the request log.', 'type' => 'string', 'required' => true, 'example' => '95657ED9-2F6F-426F-BD99-79C8********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '93D91A99-F093-4596-87BA-3C4FBFD3FD8A', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TrafficControls' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C81********', 'title' => ''], + 'RequestLogs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'TrafficControl' => [ - 'description' => 'The returned throttling policy information. It is an array consisting of TrafficControl data.'."\n", + 'RequestLog' => [ + 'description' => 'The request logs.', 'type' => 'array', 'items' => [ + 'description' => 'The request log.', 'type' => 'object', 'properties' => [ - 'UserDefault' => [ - 'description' => 'The default throttling value for each user.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15000', - ], - 'ApiDefault' => [ - 'description' => 'The default throttling value for each API.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'ModifiedTime' => [ - 'description' => 'The last modification time (UTC) of the throttling policy.'."\n", - 'type' => 'string', - 'example' => '2016-01-27T10:34:38Z', - ], - 'Description' => [ - 'description' => 'The description of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TrafficControlUnit' => [ - 'description' => 'The unit to be used in the throttling policy. Valid values:'."\n" - ."\n" - .'* MINUTE'."\n" - .'* HOUR'."\n" - .'* DAY'."\n", - 'type' => 'string', - 'example' => 'Minute', - ], - 'TrafficControlName' => [ - 'description' => 'The name of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'wulingtestq1', - ], - 'AppDefault' => [ - 'description' => 'The default throttling value for each app.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8000', - ], - 'TrafficControlId' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'cfed6c970d45481dbe136d6b5ac68c41', - ], - 'CreatedTime' => [ - 'description' => 'The creation time (UTC) of the throttling policy.'."\n", - 'type' => 'string', - 'example' => '2016-01-27T10:19:39Z', - ], - 'SpecialPolicies' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'SpecialPolicy' => [ - 'description' => 'The returned information about a special throttling policy. It is an array consisting of SpecialPolicy data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SpecialType' => [ - 'description' => 'The type of the special throttling policy. Valid values:'."\n" - ."\n" - .'* **APP**'."\n" - .'* **USER**'."\n", - 'type' => 'string', - 'example' => 'USER', - ], - 'Specials' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Special' => [ - 'description' => 'The returned information about a special throttling policy. It is an array consisting of Special data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrafficValue' => [ - 'description' => 'The throttling value.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'SpecialKey' => [ - 'description' => 'The AppId or user account corresponding to SpecialType.'."\n", - 'type' => 'string', - 'example' => 'test_wg@aliyun.com', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'string', 'example' => '4b83229ebcab4ecd88956fb3********', 'title' => ''], + 'ApiName' => ['description' => 'The API name.', 'type' => 'string', 'example' => 'ApiName', 'title' => ''], + 'ConsumerAppKey' => ['description' => 'The App Key that is used by the caller.', 'type' => 'string', 'example' => '20412****', 'title' => ''], + 'TotalLatency' => ['description' => 'The total time consumed by the request. Unit: milliseconds.', 'type' => 'string', 'example' => '1345', 'title' => ''], + 'HttpMethod' => ['description' => 'The HTTP method that is used to send the request.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'Domain' => ['description' => 'The requested domain name in the request.', 'type' => 'string', 'example' => '360bdd88695c48ae8085c7f2********-ap-southeast-1.alicloudapi.com', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Backend service connect failed `Timeout connecting to [/1XX.20.0.XX:8080]`', 'title' => ''], + 'ConsumerAppId' => ['description' => 'The application ID that is used by the caller.', 'type' => 'string', 'example' => '11096****', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the API Gateway instance to which the API belongs.', 'type' => 'string', 'example' => 'apigateway-bj-ab2b********', 'title' => ''], + 'ClientNonce' => ['description' => 'The X-Ca-Nonce header included in the request from the client.', 'type' => 'string', 'example' => 'd43df9db-3b05-4cd6-888a-1c0b********', 'title' => ''], + 'RequestSize' => ['description' => 'The size of the request. Unit: bytes.', 'type' => 'string', 'example' => '1923', 'title' => ''], + 'StageId' => ['description' => 'The ID of the API environment.', 'type' => 'string', 'example' => '8a305b7f10334052a52d9156********', 'title' => ''], + 'StageName' => ['description' => 'The name of the API environment.', 'type' => 'string', 'example' => 'RELEASE', 'title' => ''], + 'HttpPath' => ['description' => 'The path of the request.', 'type' => 'string', 'example' => '/testPath', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group to which the API belongs.', 'type' => 'string', 'example' => 'dc024277fe6c4cada79ba0bd6********', 'title' => ''], + 'GroupName' => ['description' => 'The name of the API group to which the API belongs.', 'type' => 'string', 'example' => 'GroupName', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code that is returned.', 'type' => 'string', 'example' => 'X500ER', 'title' => ''], + 'ResponseSize' => ['description' => 'The size of returned data. Unit: bytes.', 'type' => 'string', 'example' => '23441', 'title' => ''], + 'Region' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'StatusCode' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client that sends the request.', 'type' => 'string', 'example' => '21.237.XXX.XXX', 'title' => ''], + 'ServiceLatency' => ['description' => 'The total time consumed to access the backend resources. The total time includes the time consumed to request a connection to the resources, the time consumed to establish the connection, and the time consumed to call the backend service. Unit: milliseconds.', 'type' => 'string', 'example' => '324', 'title' => ''], + 'RequestTime' => ['description' => 'The request time, in UTC.', 'type' => 'string', 'example' => '2022-10-29T03:59:59Z', 'title' => ''], + 'Exception' => ['description' => 'The specific error message returned by the backend service.', 'type' => 'string', 'example' => 'error msg', 'title' => ''], + 'CustomTraceId' => ['description' => 'The custom trace ID.', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********', 'title' => ''], + 'JwtClaims' => ['description' => 'The JSON web token (JWT) claims. The claims can be configured at the group level.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'RequestProtocol' => ['description' => 'The protocol used by the client to send the request. Valid values: HTTP, HTTPS, and WS.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'RequestHeaders' => ['description' => 'The request headers.', 'type' => 'string', 'example' => 'content-type: application/x-www-form-urlencoded', 'title' => ''], + 'RequestQueryString' => ['description' => 'The query string for the request.', 'type' => 'string', 'example' => 'username=name', 'title' => ''], + 'RequestBody' => ['description' => 'The request body. A request body cannot exceed 1,024 bytes in size.', 'type' => 'string', 'example' => 'param=paramName', 'title' => ''], + 'ResponseHeaders' => ['description' => 'The headers in the API response.', 'type' => 'string', 'example' => 'content-type: application/x-www-form-urlencoded'."\n", 'title' => ''], + 'ResponseBody' => ['description' => 'The response body. A response body cannot exceed 1,024 bytes in size.', 'type' => 'string', 'example' => 'param=paramName'."\n", 'title' => ''], + 'plugin' => ['description' => 'The plug-in hit by the request and the relevant context.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'InitialRequestId' => ['description' => 'The initial request ID when API Gateway calls an API. For example, if API-1 calls API-2, the initialRequestId parameter in the log of API-2 indicates the ID of the request from API-1.', 'type' => 'string', 'example' => '95657ED9-2F6F-426F-BD99-79C8********', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'VIPROOM_VIPROOM', 'title' => ''], + 'FrontRequestStart' => ['description' => 'The time when API Gateway started to receive the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224968', 'title' => ''], + 'FrontRequestEnd' => ['description' => 'The time when API Gateway finished receiving the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224968', 'title' => ''], + 'BackendRequestStart' => ['description' => 'The time when API Gateway started to forward the request to the backend service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224969', 'title' => ''], + 'BackendRequestEnd' => ['description' => 'The time when API Gateway finished forwarding the request to the backend service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224969', 'title' => ''], + 'BackendResponseStart' => ['description' => 'The time when API Gateway started to receive the response from the backend service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989', 'title' => ''], + 'BackendResponseEnd' => ['description' => 'The time when API Gateway finished receiving the response from the backend service.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989', 'title' => ''], + 'FrontResponseStart' => ['description' => 'The time when API Gateway started to forward the response to the client.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989', 'title' => ''], + 'FrontResponseEnd' => ['description' => 'The time when API Gateway finished forwarding the response to the client.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731487224989', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeTrafficControlsResponse>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <RequestId>93D91A99-F093-4596-87BA-3C4FBFD3FD8A</RequestId>\\r\\n <TrafficControls>\\r\\n <TrafficControl>\\r\\n <TrafficControlId>cfed6c970d45481dbe136d6b5ac68c41</TrafficControlId>\\r\\n <ApiDefault>20000</ApiDefault>\\r\\n <TrafficControlUnit>Minute</TrafficControlUnit>\\r\\n <TrafficControlName>wulingtestq1</TrafficControlName>\\r\\n <ModifiedTime>2016-01-27T10:34:38Z</ModifiedTime>\\r\\n <UserDefault>15000</UserDefault>\\r\\n <AppDefault>8000</AppDefault>\\r\\n <Description>test</Description>\\r\\n <CreateTime>2016-01-27T10:19:39Z</CreateTime>\\r\\n <SpecialPolicies>\\r\\n <SpecialPolicy>\\r\\n <SpecialType>User</SpecialType>\\r\\n <Specials>\\r\\n <Special>\\r\\n <TrafficValue>100</TrafficValue>\\r\\n <SpecialKey>test_wg@aliyun.com</SpecialKey>\\r\\n </Special>\\r\\n </Specials>\\r\\n </SpecialPolicy>\\r\\n <SpecialPolicy>\\r\\n <SpecialType>App</SpecialType>\\r\\n <Specials>\\r\\n <Special>\\r\\n <TrafficValue>100</TrafficValue>\\r\\n <SpecialKey>12345678</SpecialKey>\\r\\n </Special>\\r\\n </Specials>\\r\\n </SpecialPolicy>\\r\\n </SpecialPolicies>\\r\\n </TrafficControl>\\r\\n </TrafficControls>\\r\\n</DescribeTrafficControlsResponse>","errorExample":""}]', - 'title' => 'DescribeTrafficControls', - 'description' => '* This API is intended for API providers.'."\n" - .'* This API can be used to query all existing throttling policies (including special throttling policies) and their details.'."\n" - .'* You can specify query conditions. For example, you can query the throttling policies bound to a specified API or in a specified environment.'."\n", - ], - 'DescribeTrafficControlsByApi' => [ - 'summary' => 'Queries the throttling policy that is bound to a specific API.', - 'methods' => [ - 'post', - 'get', + 'title' => 'QueryRequestLogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRequestLogs'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:QueryRequestLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'Reactivates a custom domain name whose validity status is Abnormal.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94410', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94457', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the group to which the API to be queried belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The runtime environment of the API. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], ], ], 'responses' => [ @@ -26851,110 +21580,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'TrafficControlItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TrafficControlItem' => [ - 'description' => 'The returned throttling policy information. It is an array consisting of TrafficControlItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TrafficControlItemId' => [ - 'description' => 'The ID of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'BoundTime' => [ - 'description' => 'The binding time of the policy.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'TrafficControlItemName' => [ - 'description' => 'The name of the throttling policy.'."\n", - 'type' => 'string', - 'example' => 'mysecret', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeTrafficControlByApiResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TrafficControlItems>\\r\\n <TrafficControlItem>\\r\\n <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId> \\r\\n <TrafficControlName>mysecret</TrafficControlName>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </TrafficControlItem>\\r\\n </TrafficControlItems>\\r\\n</DescribeTrafficControlByApiResponse>","errorExample":""}]', - 'title' => 'DescribeTrafficControlsByApi', - 'description' => '* This API is intended for API providers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApisByTrafficControl' => [ - 'summary' => 'Queries the APIs to which a specified throttling policy is bound.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ReactivateDomain', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- You must solve the problem that is mentioned in the domain name exception prompt before you can reactivate the domain name.'."\n" + ."\n" + .'- A typical reason why a custom domain name becomes abnormal is that the domain name does not have an ICP filing or the domain name is included in a blacklist by the administration. When a custom domain name is abnormal, users cannot use it to call APIs.'."\n" + ."\n" + .'- reactivate the domain name to resume normal access.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReactivateDomain'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","type":"json"}]', + ], + 'RemoveAccessControlListEntry' => [ + 'summary' => 'This operation removes IP address entries from the access control policy of a dedicated API Gateway instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94327', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TrafficControlId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy that you want to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'AclId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the access control policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp12ag0xxcfhq1ll68wp9', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'AclEntrys', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The entries to remove from the access control policy.'."\n" + ."\n" + .'- entry: The IP address entry in the access control policy. You can specify an IP address or a CIDR block. Separate multiple IP addresses or CIDR blocks with a comma.'."\n" + ."\n" + .'- comment: The comment for the access control policy entry.'."\n" + ."\n" + .'> If an access control policy is associated with a listener, deleting all of its IP address entries is not allowed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{\\"entry\\":\\"192.168.1.0/24\\",\\"comment\\":\\"WhiteIp\\"}]', 'title' => ''], ], ], 'responses' => [ @@ -26962,171 +21653,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ApiInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiInfo' => [ - 'description' => 'The returned API information. It is an array consisting of ApiInfo data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The binding time of the API.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'Visibility' => [ - 'description' => 'Indicates whether the API is public. Valid values:'."\n" - ."\n" - .'* **PUBLIC**'."\n" - .'* **PRIVATE**'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the group to which an API belongs.'."\n", - 'type' => 'string', - 'example' => 'mygroup', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '0009db9c828549768a200320714b8930', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'ApiName' => [ - 'description' => 'The name of the API'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], - 'RegionId' => [ - 'description' => 'The region where the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"描述\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeApisByTrafficControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiInfos>\\r\\n <ApiInfo>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>0009db9c828549768a200320714b8930</GroupId> \\r\\n <GroupName>mygroup</GroupName>\\r\\n <StageName>test</StageName>\\r\\n <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>\\r\\n <ApiName>testapi</ApiName>\\r\\n <Description>描述</Description>\\r\\n <Visibility>public</Visibility>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiInfo>\\r\\n </ApiInfos>\\r\\n</DescribeApisByTrafficControlResponse>","errorExample":""}]', - 'title' => 'DescribeApisByTrafficControl', - 'description' => '* This API is intended for API providers.'."\n" - .'* You can specify PageNumber to obtain the result on the specified page.'."\n", - ], - 'RemoveTrafficControlApis' => [ - 'summary' => 'Unbinds a specified throttling policy from APIs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'RemoveAccessControlListEntry', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAccessControlListEntry'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94468', - 'abilityTreeNodes' => [ - 'FEATUREapigateway6HGZRN', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'TrafficControlId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the throttling policy that you want to unbind from APIs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group containing the APIs from which you want to unbind a specified throttling policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], - ], - [ - 'name' => 'ApiIds', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the APIs from which you want to unbind a specified throttling policy.'."\n" - ."\n" - .'* If this parameter is not specified, the throttling policy is unbound from all the APIs in the specified environment of the API group.'."\n" - .'* Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110982490', 'title' => ''], ], [ - 'name' => 'StageName', + 'name' => 'ApiProductIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', + 'description' => 'The API products.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => false, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], 'required' => true, - 'example' => 'TEST', + 'title' => '', + 'example' => '', ], ], ], @@ -27135,81 +21720,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveTrafficControlApisResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</RemoveTrafficControlApisResponse>","errorExample":""}]', - 'title' => 'RemoveTrafficControlApis', - 'description' => '* This API is intended for API providers.'."\n" - .'* This API allows you to unbind a specified throttling policy from up to 100 APIs at a time.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddIpControlPolicyItem' => [ - 'summary' => 'Adds a policy to an existing ACL.', - 'methods' => [ - 'post', - 'get', + 'title' => 'RemoveApiProductsAuthorities', + 'summary' => 'Revokes permissions on API products from an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApiProductsAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveApiProductsAuthorities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', + ], + 'RemoveApisAuthorities' => [ + 'summary' => 'Revokes the access permissions on multiple APIs from a specified application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94246', - 'abilityTreeNodes' => [ - 'FEATUREapigatewaySKO2I5', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94461', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The restriction policy on app IDs for a specific policy. You can restrict app IDs only for whitelists. The IpControlType values of whitelists are ALLOW.'."\n" - ."\n" - .'* You can add only one app ID restriction policy at a time.'."\n" - .'* If this parameter is empty, no restriction is imposed on the app IDs.'."\n" - .'* If this parameter is not empty, there is restriction not only on IP addresses, but also on apps.'."\n" - .'* Please note that if this parameter is not empty and the security authentication method of the API is No Authentication, all API calls are restricted.'."\n" - .'* If this parameter is not empty for a blacklist, API Gateway automatically skips this parameter and sets only restriction on IP addresses. The IpControlType value of a blacklist is REFUSE.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1111111', - ], + 'schema' => ['description' => 'The ID of the appplication. The ID is generated by the system and globally unique.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789', 'title' => ''], ], [ - 'name' => 'CidrIp', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses or CIDR blocks involved in the policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can specify a maximum of 10 IP addresses or CIDR blocks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '113.125.1.101;101.11.1.1', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the authorization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Query weather by region name', 'title' => ''], ], ], 'responses' => [ @@ -27217,41 +21802,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PolicyItemId' => [ - 'description' => 'The ID of the policy. The ID is unique.'."\n", - 'type' => 'string', - 'example' => 'P151617000829241', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyItemId\\": \\"P151617000829241\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIpControlPolicyItemResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <PolicyItemId>P151617000829241</PolicyItemId>\\r\\n</AddIpControlPolicyItemResponse>","errorExample":""}]', - 'title' => 'AddIpControlPolicyItem', - 'description' => 'When you call this operation, note that:'."\n" - ."\n" - .'* This operation is intended for API providers.'."\n" - .'* An added policy immediately takes effect on all APIs that are bound to the access control list (ACL).'."\n" - .'* A maximum of 100 policies can be added to an ACL.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveApisAuthoritiesResponse>\\r\\n <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>\\r\\n</RemoveApisAuthoritiesResponse>","errorExample":""}]', + 'title' => 'RemoveApisAuthorities', + 'description' => '* This operation is intended for API providers and callers.'."\n" + .'* Before you revoke access permissions, check by whom the permissions were granted. API providers can only revoke permissions granted by a Provider, and API callers can only revoke permissions granted by a Consumer.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateIpControl' => [ - 'summary' => 'Creates an access control list (ACL) in a region.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveApisAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => [], @@ -27259,86 +21848,34 @@ ], 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '94273', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94462', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'IpControlName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ACL. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (\\_). The name cannot start with an underscore (\\_).``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'controlNameTest', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'IpControlType', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the ACL. Valid values:'."\n" - ."\n" - .'* **ALLOW**: an IP address whitelist'."\n" - .'* **REFUSE**: an IP address blacklist'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ALLOW', - ], + 'schema' => ['description' => 'The ID of the API. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The description. The description can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], ], [ - 'name' => 'IpControlPolicys', + 'name' => 'AppIds', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The information about the policies. The information is an array of ipcontrolpolicys data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the application that is restricted by the policy. You can configure the AppId parameter only when the value of the IpControlType parameter is ALLOW.'."\n" - ."\n" - .'* You can add only one application ID at a time.'."\n" - .'* If this parameter is empty, no applications are restricted.'."\n" - .'* If this parameter is not empty, not only IP addresses but also applications are restricted.'."\n" - .'* If this parameter is not empty and no security authentication method is specified for the API, all API calls are restricted.'."\n" - .'* If the value of the IpControlType parameter is REFUSE and the AppId parameter is not empty, API Gateway automatically ignores the AppId parameter and restricts only the IP addresses.'."\n" - .'* Valid values of N in IpControlPolicys.N: `[1,100]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '11111', - ], - 'CidrIp' => [ - 'description' => 'The IP address or CIDR block involved in a policy.'."\n" - ."\n" - .'* If you want to specify a policy when you create an ACL, this parameter is required.'."\n" - .'* The IP address or CIDR block that is defined in each policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks.'."\n" - .'* Valid values of N in IpControlPolicys.N: `[1,100]`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '114.1.1.0/24', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The IDs of applications. Separate multiple application IDs with commas (,). A maximum of 100 applications IDs can be entered.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2386789,3286798', 'title' => ''], ], ], 'responses' => [ @@ -27346,41 +21883,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'IpControlId' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IpControlId\\": \\"7ea91319a34d48a09b5c9c871d9768b1\\",\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateIpControlResponse>\\r\\n <RequestId>CE5722A6-AE78-4741-A9B0-6C817D360510</RequestId>\\r\\n <IpControlId>7ea91319a34d48a09b5c9c871d9768b1</IpControlId>\\r\\n</CreateIpControlResponse>","errorExample":""}]', - 'title' => 'CreateIpControl', - 'description' => '* This operation is intended for API providers.'."\n" - .'* An ACL must be bound to an API to take effect. After an ACL is bound to an API, the ACL takes effect on the API immediately.'."\n" - .'* You can add policies to an ACL when you create the ACL.'."\n" - .'* If an ACL does not have any policy, the ACL is ineffective.'."\n", + 'title' => 'RemoveAppsAuthorities', + 'summary' => 'Revokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API.', + 'description' => '- This operation is intended for API providers and callers.'."\n" + ."\n" + .'- Before you revoke access permissions, check by whom the permissions were granted. API providers can only revoke permissions granted by a Provider, and API callers can only revoke permissions granted by a Consumer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteIpControl' => [ - 'summary' => 'Deletes an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAppsAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","type":"json"}]', + ], + 'RemoveIpControlApis' => [ + 'summary' => 'Unbinds an API from an access control list (ACL).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27388,21 +21933,37 @@ ], 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '94292', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'abilityTreeCode' => '94465', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], + 'schema' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the APIs from which you want to unbind the ACL.'."\n" + ."\n" + .'- If this parameter is not specified, the ACL is unbound from all the APIs in the specified environment of the API group.'."\n" + ."\n" + .'- The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -27410,77 +21971,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIpControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</DeleteIpControlResponse>","errorExample":""}]', - 'title' => 'DeleteIpControl', - 'description' => '* This operation is intended for API providers.'."\n" - .'* If the ACL is bound to an API, you must unbind the ACL from the API before you can delete the ACL. Otherwise, an error is returned.'."\n" - .'* If you call this operation on an ACL that does not exist, a success message is returned.'."\n", + 'title' => 'RemoveIpControlApis', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- The unbinding takes effect immediately. After the API is unbound from the ACL, the corresponding environment does not have any IP address access control in place for the API.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyIpControl' => [ - 'summary' => 'Modifies an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveIpControlApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'RemoveIpControlPolicyItem' => [ + 'summary' => 'Removes one or more policies from an access control list (ACL).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94443', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94466', + 'abilityTreeNodes' => ['FEATUREapigatewayRIDGJ9'], ], 'parameters' => [ [ 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], - ], - [ - 'name' => 'IpControlName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ACL. The name must be 4 to 50 characters in length, and can contain letters, digits, and underscores (\\_). The name cannot start with an underscore (\\_).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testControl11', - ], + 'schema' => ['description' => 'The ID of the ACL. The ID is unique.', 'type' => 'string', 'required' => true, 'example' => '7ea91319a34d48a09b5c9c871d9768b1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PolicyItemIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The description. The description can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description', - ], + 'schema' => ['description' => 'The ID of a policy. Separate multiple IDs with semicolons (;). A maximum of 100 IDs can be entered.', 'type' => 'string', 'required' => true, 'example' => 'P151533572852362;P151533557750260', 'title' => ''], ], ], 'responses' => [ @@ -27488,92 +22039,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</ModifyIpControlResponse>","errorExample":""}]', - 'title' => 'ModifyIpControl', - 'description' => '* This operation is intended for API providers.'."\n" - .'* This operation allows you to modify only the name and description of an ACL. You cannot modify the type of the ACL.'."\n", + 'title' => 'RemoveIpControlPolicyItem', + 'description' => '- This operation is intended for API providers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyIpControlPolicyItem' => [ - 'summary' => 'Modifies a policy in an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveIpControlPolicyItem'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'RemoveSignatureApis' => [ + 'summary' => 'Unbinds a backend signature key from APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '94444', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94467', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], + 'schema' => ['description' => 'The ID of the signature key.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'PolicyItemId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'P151617000829241', - ], + 'schema' => ['description' => 'The ID of the API group to which the API that you want to manage belongs.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application that is restricted by the policy. You can configure the AppId parameter only when the value of the IpControlType parameter is ALLOW.'."\n" - ."\n" - .'* You can add only one application ID at a time.'."\n" - .'* If this parameter is empty, no applications are restricted.'."\n" - .'* If this parameter is not empty, not only IP addresses but also applications are restricted.'."\n" - .'* If this parameter is not empty and no security authentication method is specified for the API, all API calls are restricted.'."\n" - .'* If the value of the IpControlType parameter is REFUSE and the AppId parameter is not empty, API Gateway automatically ignores the AppId parameter and restricts only the IP addresses.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The IDs of the APIs from which you want to unbind the signature key.'."\n" + ."\n" + .'- If this parameter is not specified, the signature key is unbound from all the APIs in the specified environment of the API group.'."\n" + ."\n" + .'- The IDs of the APIs that you want to manage. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'CidrIp', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address or CIDR block that is defined in a policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can add a maximum of 10 IP addresses or CIDR blocks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '113.125.1.101;101.11.1.1', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -27581,88 +22123,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyIpControlPolicyItemResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</ModifyIpControlPolicyItemResponse>","errorExample":""}]', - 'title' => 'ModifyIpControlPolicyItem', - 'description' => '* This operation is intended for API providers.'."\n" - .'* The modification immediately takes effect on all the APIs that are bound to the policy.'."\n" - .'* This operation causes a full modification of the content of a policy.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetIpControlApis' => [ - 'summary' => 'Creates a binding relationship between specified access control lists (ACLs) and APIs.', - 'methods' => [ - 'post', - 'get', + 'title' => 'RemoveSignatureApis', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- The operation takes effect immediately. The request sent from API Gateway to the backend service does not contain the signature string. The corresponding verification step can be removed from the backend.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSignatureApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveSignatureApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'RemoveTrafficControlApis' => [ + 'summary' => 'Unbinds a specified throttling policy from APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', + 'abilityTreeCode' => '94468', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The ID of the throttling policy that you want to unbind from APIs.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The ID of the API group containing the APIs from which you want to unbind a specified throttling policy.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The API IDs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', - ], + 'schema' => ['description' => 'The IDs of the APIs from which you want to unbind a specified throttling policy.'."\n" + ."\n" + .'- If this parameter is not specified, the throttling policy is unbound from all the APIs in the specified environment of the API group.'."\n" + ."\n" + .'- Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **PRE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -27670,107 +22206,77 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<SetIpControlApisResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</SetIpControlApisResponse>","errorExample":""}]', - 'title' => 'SetIpControlApis', - 'description' => '* This operation is intended for API callers.'."\n" - .'* A maximum of 100 APIs can be bound at a time.'."\n", + 'title' => 'RemoveTrafficControlApis', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- This API allows you to unbind a specified throttling policy from up to 100 APIs at a time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeApiIpControls' => [ - 'summary' => 'Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveTrafficControlApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveTrafficControlApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'RemoveVpcAccess' => [ + 'summary' => 'Deletes a VPC access authorization without unpublishing the associated APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94317', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94469', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', - ], + 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf657qec7lx42paw3qxxx', 'title' => ''], ], [ - 'name' => 'ApiIds', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123,234', - ], + 'schema' => ['description' => 'The ID of an ECS or SLB instance in the VPC.', 'type' => 'string', 'required' => true, 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The port number that corresponds to the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '80', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NeedBatchWork', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Specifies whether batch work is required.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -27778,155 +22284,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiIpControls' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'Apis' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'ApiIpControlItem' => [ - 'description' => 'The information about the ACLs. The information is an array of ApiIpControlItem data.'."\n", + 'Api' => [ + 'description' => 'API operations', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'BoundTime' => [ - 'description' => 'The time of binding.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '46fbb52840d146f186e38e8e70fc8c90', - ], - 'IpControlId' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], - 'IpControlName' => [ - 'description' => 'The name of the ACL.'."\n", - 'type' => 'string', - 'example' => 'testControlName', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], + 'ApiId' => ['description' => 'API Id', 'type' => 'string', 'example' => '551877242a4b4f3a84a56b7c3570e4a7', 'title' => ''], + 'StageId' => ['description' => 'The ID of the runtime environment.', 'type' => 'string', 'example' => 'd1e1ee28f9fb4b729db0ee8ca76ff0a5', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group.', 'type' => 'string', 'example' => '78d54ac4424d4b1792e33ca35637e8e4', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeApiIpControlsResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiSignatures>\\r\\n <ApiSignatureItem>\\r\\n <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>\\r\\n <ApiName>testapi</ApiName> \\r\\n <IpControlId>dd05f1c54d6749eda95f9fa6d491449a</IpControlId>\\r\\n <IpControlName>testControlName</IpControlName>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiSignatureItem>\\r\\n </ApiSignatures>\\r\\n</DescribeApiIpControlsResponse>","errorExample":""}]', - 'title' => 'DescribeApiIpControls', - 'description' => '* This operation is intended for API callers.'."\n" - .'* If an optional parameter is not specified, all results are returned on separate pages.'."\n" + 'title' => 'RemoveVpcAccess', + 'description' => '- This API is intended for API providers.'."\n" ."\n" - .'·'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeIpControlPolicyItems' => [ - 'summary' => 'Queries the rule entries of an IP address-based traffic control policy.', - 'methods' => [ - 'post', - 'get', + .'- Revokes the permissions of API Gateway to access your VPC instance.'."\n" + ."\n" + .'> Deleting an authorization affects the associated API. Before you delete the authorization, make sure that it is not used by the API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccess'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveVpcAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'RemoveVpcAccessAndAbolishApis' => [ + 'summary' => 'Removes a VPC authorization and unpublishes the associated APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94373', - 'abilityTreeNodes' => [ - 'FEATUREapigatewaySKO2I5', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94470', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], + 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp1iw82phcgkvupgfv0o8', 'title' => ''], ], [ - 'name' => 'PolicyItemId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P151617000829241', - ], + 'schema' => ['description' => 'The ID of the instance in the VPC. The instance can be an Elastic Compute Service (ECS) instance or a Server Load Balancer instance.', 'type' => 'string', 'required' => true, 'example' => 'i-uf6iaale3gfef9t9cb41', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The service port.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8080', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NeedBatchWork', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Specifies whether to perform batch operations.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -27934,166 +22387,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'IpControlPolicyItems' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IpControlPolicyItem' => [ - 'description' => 'The information about policies. The information is an array of IpControlPolicyItem data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the policy was modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2018-01-17T06:25:13Z', - ], - 'PolicyItemId' => [ - 'description' => 'The ID of the policy.'."\n", - 'type' => 'string', - 'example' => 'P151617000829241', - ], - 'CidrIp' => [ - 'description' => 'The IP addresses or CIDR blocks.'."\n", - 'type' => 'string', - 'example' => '113.125.XX.XX;101.11.XX.XX', - ], - 'CreateTime' => [ - 'description' => 'The time when the policy was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2018-01-17T06:20:08Z', - ], - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => '11112', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'OperationId' => ['description' => 'The ID of the operation.', 'type' => 'string', 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeIpControlPolicyItemsResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>2</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <IpControlPolicyItems>\\r\\n <IpControlPolicyItem>\\r\\n <PolicyItemId>P151617000829241</PolicyItemId>\\r\\n <CreateTime>2018-01-17T06:20:08Z</CreateTime>\\r\\n <ModifiedTime>2018-01-17T06:25:13Z</ModifiedTime>\\r\\n <CidrIp>113.125.1.101;101.11.1.1</CidrIp>\\r\\n <AppId>11112</AppId>\\r\\n </IpControlPolicyItem>\\r\\n <IpControlPolicyItem>\\r\\n <PolicyItemId>P151616809156728</PolicyItemId>\\r\\n <CreateTime>2018-01-17T05:48:11Z</CreateTime>\\r\\n <ModifiedTime>2018-01-17T05:48:11Z</ModifiedTime>\\r\\n <CidrIp>102.0.0.0/8</CidrIp>\\r\\n </IpControlPolicyItem>\\r\\n </IpControlPolicyItems>\\r\\n</DescribeIpControlPolicyItemsResponse>","errorExample":""}]', - 'title' => 'DescribeIpControlPolicyItems', - 'description' => '* This operation is intended for API providers.'."\n" - .'* You can filter the query results by policy ID.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeIpControls' => [ - 'summary' => 'Queries custom access control lists (ACLs) on separate pages.', - 'methods' => [ - 'post', - 'get', + 'title' => 'RemoveVpcAccessAndAbolishApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveVpcAccessAndAbolishApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveVpcAccessAndAbolishApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', + ], + 'ResetAppCode' => [ + 'summary' => 'Resets the AppCode of an application. This operation can be called only once per minute for each user.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94374', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94471', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'IpControlId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], - ], - [ - 'name' => 'IpControlName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ACL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ACL test'."\n", - ], - ], - [ - 'name' => 'IpControlType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the ACL. Valid values:'."\n" - ."\n" - .'* **ALLOW**: a whitelist'."\n" - .'* **REFUSE**: a blacklist'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALLOW', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'AppCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The AppCode of the application.', 'type' => 'string', 'required' => true, 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NewAppCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The new AppCode of the application.', 'type' => 'string', 'required' => false, 'example' => '6f0e7ab2aa5f4b8fb18421e6edf4fb6c2', 'title' => ''], ], ], 'responses' => [ @@ -28101,153 +22451,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IpControlInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'IpControlInfo' => [ - 'description' => 'The information about the ACL. The information is an array that consists of IpControlInfo data. The information does not include specific policies.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IpControlId' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], - 'IpControlType' => [ - 'description' => 'The type of the ACL.'."\n", - 'type' => 'string', - 'example' => 'ALLOW', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the ACL was modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2018-01-17T06:00:38Z', - ], - 'IpControlName' => [ - 'description' => 'The name of the ACL.'."\n", - 'type' => 'string', - 'example' => 'testControl11', - ], - 'Description' => [ - 'description' => 'The description of the ACL.'."\n", - 'type' => 'string', - 'example' => 'description', - ], - 'CreateTime' => [ - 'description' => 'The time when the ACL was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2018-01-17T05:48:11Z', - ], - 'RegionId' => [ - 'description' => 'The ID of the region in which the ACL is deployed.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"<DescribeIpControlsResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <IpControlInfos>\\r\\n <IpControlInfo>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <IpControlId>7ea91319a34d48a09b5c9c871d9768b1</IpControlId>\\r\\n <IpControlName>testControl11</IpControlName>\\r\\n <IpControlType>ALLOW</IpControlType>\\r\\n <Description>description</Description>\\r\\n <CreateTime>2018-01-17T05:48:11Z</CreateTime>\\r\\n <ModifiedTime>2018-01-17T06:00:38Z</ModifiedTime>\\r\\n </IpControlInfo>\\r\\n </IpControlInfos>\\r\\n</DescribeIpControlsResponse>","errorExample":""}]', - 'title' => 'DescribeIpControls', - 'description' => '* This operation is intended for API providers.'."\n" - .'* This operation is used to query the ACLs in a region. Region is a system parameter.'."\n" - .'* You can filter the query results by ACL ID, name, or type.'."\n" - .'* This operation cannot be used to query specific policies. If you want to query specific policies, call the [DescribeIpControlPolicyItems](~~DescribeIpControlPolicyItems~~) operation.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApisByIpControl' => [ - 'summary' => 'Queries the APIs that are bound to an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'title' => 'Reset an application', + 'description' => 'Resetting the AppCode has a latency of approximately 2 seconds.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppCode'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ResetAppCode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1B18FFE-4A81-59D8-AA02-1817098977CD\\"\\n}","type":"json"}]', + ], + 'ResetAppSecret' => [ + 'summary' => 'Resets the key for an app.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94324', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '94472', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The key of the application that is used to make an API call.', 'type' => 'string', 'required' => true, 'example' => '60030986', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NewAppKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The new AppKey that you set must be globally unique.', 'type' => 'string', 'required' => false, 'example' => 'testAppKey', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'NewAppSecret', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The new key of the application. To improve compatibility, we recommend that you use other parameters.', 'type' => 'string', 'required' => false, 'example' => 'test***', 'title' => ''], ], ], 'responses' => [ @@ -28255,177 +22519,131 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ApiInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiInfo' => [ - 'description' => 'The returned API information. It is an array of ApiInfo data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BoundTime' => [ - 'description' => 'The time of API binding.'."\n", - 'type' => 'string', - 'example' => '2016-07-23T08:28:48Z', - ], - 'Visibility' => [ - 'description' => 'The visibility of the API. Valid values:'."\n" - ."\n" - .'* **PUBLIC**'."\n" - .'* **PRIVATE**'."\n", - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'ApiId' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'string', - 'example' => '3b81fd160f5645e097cc8855d75a1cf6', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Description'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'mygroup', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '0009db9c828549768a200320714b8930', - ], - 'StageName' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST.'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'ApiName' => [ - 'description' => 'The name of the API'."\n", - 'type' => 'string', - 'example' => 'testapi', - ], - 'RegionId' => [ - 'description' => 'The region in which the API is located.'."\n", - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"描述\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"GroupId\\": \\"0009db9c828549768a200320714b8930\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"testapi\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeApisByIpControlResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n <TotalCount>20</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <PageNumber>1</PageNumber>\\r\\n <ApiInfos>\\r\\n <ApiInfo>\\r\\n <RegionId>cn-qingdao</RegionId>\\r\\n <GroupId>0009db9c828549768a200320714b8930</GroupId> \\r\\n <GroupName>mygroup</GroupName>\\r\\n <StageName>test</StageName>\\r\\n <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>\\r\\n <ApiName>testapi</ApiName>\\r\\n <Description>描述</Description>\\r\\n <Visibility>public</Visibility>\\r\\n <BoundTime>2016-07-23T08:28:48Z</BoundTime>\\r\\n </ApiInfo>\\r\\n </ApiInfos>\\r\\n</DescribeApisByIpControlResponse>","errorExample":""}]', - 'title' => 'DescribeApisByIpControl', - 'description' => '* This operation is intended for API callers.'."\n" - .'* You can specify PageNumber to obtain the result on the specified page.'."\n", + 'title' => 'ResetAppSecret', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- A new secret is automatically generated after you have called this operation. This secret cannot be customized.'."\n" + ."\n" + .'- The results returned by this operation do not contain the application secret. You can obtain the secret by calling DescribeAppSecurity.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemoveIpControlApis' => [ - 'summary' => 'Unbinds an API from an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAppSecret'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ResetAppSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\"\\n}","type":"json"}]', + ], + 'SdkGenerateByApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94465', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94474', + 'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', - ], + 'schema' => ['description' => 'The unique ID of the application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110797019', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Language', 'in' => 'query', + 'schema' => ['description' => 'The programming language for which you want to generate the SDK.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'java', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0009db9c828549768a200320714b8930', + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => ['description' => 'The Base64-encoded SDK. Decode the value to obtain the file.', 'type' => 'string', 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'SdkGenerateByApp', + 'summary' => 'Generates a software development kit (SDK) for an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByApp'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'ApiIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the APIs from which you want to unbind the ACL.'."\n" - ."\n" - .'* If this parameter is not specified, the ACL is unbound from all the APIs in the specified environment of the API group.'."\n" - .'* The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:SdkGenerateByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => [ [ - 'name' => 'StageName', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the runtime environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**'."\n" - .'* **TEST**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TEST', - ], + 'schema' => ['description' => 'The ID of the app. This ID is generated by the system and is globally unique.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '110906109', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The programming language of the SDK to be generated.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Java', 'title' => ''], ], ], 'responses' => [ @@ -28433,66 +22651,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'DownloadLink' => ['description' => 'The Base64-encoded SDK. Decode the string to obtain the file.', 'type' => 'string', 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveIpControlApisResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</RemoveIpControlApisResponse>","errorExample":""}]', - 'title' => 'RemoveIpControlApis', - 'description' => '* This operation is intended for API callers.'."\n" - .'* The unbinding takes effect immediately. After the API is unbound from the ACL, the corresponding environment does not have any IP address access control in place for the API.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveIpControlPolicyItem' => [ - 'summary' => 'Removes one or more policies from an access control list (ACL).', - 'methods' => [ - 'post', - 'get', + 'title' => 'SdkGenerateByAppForRegion', + 'summary' => 'Generates an SDK for APIs associated with an app.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByAppForRegion'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Generate an SDK by API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '94466', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIDGJ9', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '94475', + 'abilityTreeNodes' => ['FEATUREapigatewayY6W7D1'], ], 'parameters' => [ [ - 'name' => 'IpControlId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACL. The ID is unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7ea91319a34d48a09b5c9c871d9768b1', - ], + 'schema' => ['description' => 'The API group ID, which is system-generated and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1a991a450b9548a1a3df38fd3af117c2', 'title' => ''], ], [ - 'name' => 'PolicyItemIds', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of a policy. Separate multiple IDs with semicolons (;). A maximum of 100 IDs can be entered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'P151533572852362;P151533557750260', - ], + 'schema' => ['description' => 'Specify the return language. Values: -**zh-cn** (default): Chinese -**en-us**: English', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'java', 'title' => ''], ], ], 'responses' => [ @@ -28500,138 +22716,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', - ], + 'DownloadLink' => ['description' => 'The download link.', 'type' => 'string', 'example' => 'http://oss-bucket/object', 'title' => ''], + 'RequestId' => ['description' => 'The ID of this request.', 'type' => 'string', 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveIpControlPolicyItemResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>\\r\\n</RemoveIpControlPolicyItemResponse>","errorExample":""}]', - 'title' => 'RemoveIpControlPolicyItem', - 'description' => '* This operation is intended for API providers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeApisWithStageNameIntegratedByApp' => [ - 'summary' => 'Queries APIs by application and returns the result by environment.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SdkGenerateByGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SdkGenerateByGroup'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '191542', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'AclName', 'in' => 'query', - 'schema' => [ - 'title' => 'APP的ID', - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2386789', - ], + 'schema' => ['description' => 'Access control policy group name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testAcl', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'AclId', 'in' => 'query', + 'schema' => ['description' => 'Access control policy group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acl-bp1ohqkonqybecf4llbrc', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '当前页码', - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'SetAccessControlListAttribute', + 'summary' => 'This feature provides instance-level access control for API Gateway exclusive instances and lets you modify the access control policy name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccessControlListAttribute'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页条目', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + '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' => 'Grants permissions on API products to an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApiUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'API的ID', - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b19240592b1b4e74961fb8438ed7550c', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'ApiName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => 'API名称', - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiName', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '111385984', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'ApiProductIds', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'simple', 'schema' => [ - 'title' => 'API请求路径', - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/tt', + 'description' => 'The API products.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => false, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Method', + 'name' => 'AuthValidTime', 'in' => 'query', - 'schema' => [ - 'title' => 'API的请求HTTP Method', - 'description' => 'The request HTTP method of the API.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], + 'schema' => ['description' => 'The end time of the authorization validity period.,Use Greenwich Mean Time (GMT).(GMT), If this parameter is empty,,indicates permanent authorization..', 'type' => 'string', 'required' => false, 'example' => '2023-06-12T03:07:37Z', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The API description. The description can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The authorization description.', 'type' => 'string', 'example' => 'Description', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -28639,203 +22856,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'title' => '当前页码', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', - ], - 'PageSize' => [ - 'title' => '每页条目', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '总条目数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AppApiRelationInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AppApiRelationInfo' => [ - 'description' => 'The authorization information of the API.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'title' => 'API的ID', - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => 'c625795a1e664782a918eaa629e96ab5', - ], - 'AuthorizationSource' => [ - 'title' => '授权来源', - 'description' => 'The authorization source.'."\n", - 'type' => 'string', - 'example' => 'SELF', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'b1008kz', - ], - 'GroupName' => [ - 'title' => '分组名称', - 'description' => 'The name of the API group.'."\n", - 'type' => 'string', - 'example' => 'manager_vehicles', - ], - 'GroupId' => [ - 'title' => '分组ID', - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '38bed48d664149e4b9b5ea576319673f', - ], - 'Operator' => [ - 'description' => 'The authorizer. Valid values:'."\n" - ."\n" - .'* **PROVIDER:** the API owner'."\n" - .'* **CONSUMER:** the API caller'."\n", - 'type' => 'string', - 'example' => 'PROVIDER', - ], - 'CreatedTime' => [ - 'title' => '授权时间', - 'description' => 'The time when the authorization was created.'."\n", - 'type' => 'string', - 'example' => 'Sun, 02 Jan 2022 16:00:00 GMT', - ], - 'ApiName' => [ - 'title' => 'API名称', - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'sd2_h5_player_history_competition', - ], - 'RegionId' => [ - 'title' => '地区ID', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'Path' => [ - 'title' => 'API的请求路径', - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/api/offline/cacheData', - ], - 'Method' => [ - 'title' => 'API的请求HTTP Method', - 'description' => 'The request HTTP method of the API.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'StageNameAndAuth' => [ - 'description' => 'The mapping information between environments and authorizations.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'RELEASE', - 'description' => 'The environment name.'."\n", - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2603F41E-77FC-59A3-840E-296578A9BDE0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeApisWithStageNameIntegratedByApp', - ], - 'DescribeGroupLatency' => [ - 'summary' => 'Queries the average latency of an API group in an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2603F41E-77FC-59A3-840E-296578A9BDE0\\"\\n}","type":"json"}]', + 'title' => 'SetApiProductsAuthorities', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApiProductsAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:SetApiProductsAuthorities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetApisAuthorities' => [ + 'summary' => 'Authorizes a specified application to call multiple APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94358', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-03-30T16:00:00Z', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-04-14T06:26:14Z', - ], + 'schema' => ['description' => 'The ID of the application. This ID is generated by the system and globally unique.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2386789', 'title' => ''], ], [ 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which you want to perform the query. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'd825094fdd114a869f5adb443d9b7ead', - ], + 'schema' => ['description' => 'The IDs of the APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38,jkscc489e63a4cb6a41920d9d3f92d78', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the authorization.', 'type' => 'string', 'example' => 'Query weather by region name', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'AuthValidTime', + 'in' => 'query', + 'schema' => ['description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.', 'type' => 'string', 'required' => false, 'example' => 'Fri,05Oct201816:00:00GMT', 'title' => ''], ], ], 'responses' => [ @@ -28843,121 +22940,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '75DC3AB0-421C-5371-8170-86AEABF77AD0', - ], - 'LatencyPacket' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The latency information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The latency. Unit: ms.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'ItemTime' => [ - 'description' => 'The point in time when the latency data was collected. The format is YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'example' => '2023-03-30T16:10:00Z', - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* latency: the backend processing latency'."\n" - .'* gatewayLatency: the API Gateway processing latency'."\n", - 'type' => 'string', - 'example' => 'latency', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeGroupLatency', - ], - 'DescribeGroupTraffic' => [ - 'summary' => 'Queries the traffic of an API group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","type":"json"}]', + 'title' => 'SetApisAuthorities', + 'description' => '- This operation is intended for API providers and callers.'."\n" + ."\n" + .'- API providers can authorize all applications to call their APIs.'."\n" + ."\n" + .'- API callers can authorize their own applications to call the APIs that they have purchased.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApisAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetApisAuthorities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetAppsAuthToApiProduct' => [ + 'summary' => 'Authorizes multiple applications to call APIs in an API product.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '94360', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayWECSVA', - ], - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'ApiProductId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2023-01-29T01:27:43Z', - ], + 'schema' => ['description' => 'The ID of the API product.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AppIds', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The end time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the applications that you want to authorize.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the application that you want to authorize.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '110966607', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => '2023-06-16T02:16:53Z', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StageName', + 'name' => 'AuthValidTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment to which the APIs in the API group are published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE ', - ], + 'schema' => ['description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.', 'type' => 'string', 'required' => false, 'example' => '2023-05-31T08:15:39Z', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '16df9d11caa04900bcafe23b38a81600', - ], + 'schema' => ['description' => 'The description of the authorization.', 'type' => 'string', 'example' => 'Description', 'required' => false, 'title' => ''], ], ], 'responses' => [ @@ -28965,136 +23027,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], - 'TrafficPerSecond' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'MonitorItem' => [ - 'description' => 'The traffic information per second.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ItemValue' => [ - 'description' => 'The traffic volume per second.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'ItemTime' => [ - 'description' => 'The corresponding time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'example' => '2023-01-29T01:30:00Z', - ], - 'Item' => [ - 'description' => 'The metric. Valid values:'."\n" - ."\n" - .'* inbound: traffic consumed by requests'."\n" - .'* outbound: traffic consumed by responses'."\n", - 'type' => 'string', - 'example' => 'inbound', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeGroupTraffic', - ], - 'ModifyApiGroupInstance' => [ - 'summary' => '变更分组实例', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + 'title' => 'SetAppsAuthToApiProduct', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthToApiProduct'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:SetAppsAuthToApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apiproduct/{#ApiProductId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetAppsAuthorities' => [ + 'summary' => 'Grants access permissions on a specified API to multiple applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '94432', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', - ], + 'abilityTreeCode' => '94478', + 'abilityTreeNodes' => ['FEATUREapigatewayCRDGVZ'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '01c97ed08a614118849b00079753d1e2', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', 'title' => ''], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'ApiId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance to which you want to migrate the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apigateway-bj-c325375b1ebe', - ], + 'schema' => ['description' => 'The ID of the API. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'baacc592e63a4cb6a41920d9d3f91f38', 'title' => ''], ], [ - 'name' => 'Remark', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'migrate', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TEST', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'AppIds', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag of objects that match the rule. You can specify multiple tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The IDs of applications. Separate multiple application IDs with commas (,). A maximum of 100 applications IDs can be entered.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2386789,3389798', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the authorization.', 'type' => 'string', 'example' => 'Query weather by region name', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'AuthValidTime', + 'in' => 'query', + 'schema' => ['description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.', 'type' => 'string', 'required' => false, 'example' => 'Fri,05Oct201816:00:00GMT', 'title' => ''], ], ], 'responses' => [ @@ -29102,29 +23115,51 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D\\"\\n}","type":"json"}]', - 'title' => 'ModifyApiGroupInstance', - ], - 'ModifyApiGroupNetworkPolicy' => [ - 'summary' => 'Modifies the network policy of an API group.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","type":"json"}]', + 'title' => 'SetAppsAuthorities', + 'description' => '- This operation is intended for API providers and callers.'."\n" + ."\n" + .'- API providers can authorize all applications to call their APIs.'."\n" + ."\n" + .'- API callers can authorize their own applications to call the APIs that they have purchased.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAppsAuthorities'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetDomain' => [ + 'summary' => 'Binds a custom domain name to a specified API group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29133,89 +23168,53 @@ 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '94433', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayRIX31M', - ], + 'abilityTreeCode' => '94479', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0162c75d7d34ff48506f1aff878b05e', - ], - ], - [ - 'name' => 'HttpsPolicy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTPS security policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS1_1_TLS1_0', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'InternetEnable', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the virtual private cloud (VPC) second-level domain name.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], ], [ - 'name' => 'InternetIPV6Enable', + 'name' => 'BindStageName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable IPv6. Valid values: **true** and **false**.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The environment which you can access by using the domain name. If you do not specify this parameter, the domain name can be used to access all environments.'."\n" + ."\n" + .'If you specify an environment, the domain name can be used to access only the specified environment. Valid values:'."\n" + ."\n" + .'- TEST'."\n" + ."\n" + .'- PRE'."\n" + ."\n" + .'- RELEASE'."\n" + ."\n" + .'If you want to use the domain name to access all environments, set this parameter to an empty string ("").', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RELEASE', 'title' => ''], ], [ - 'name' => 'VpcIntranetEnable', + 'name' => 'CustomDomainType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the VPC domain name. Valid values:'."\n" - ."\n" - .'* TRUE'."\n" - .'* FALSE'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The network type of the domain name to be bound. Default value: INTERNET. Valid values:'."\n" + ."\n" + .'- INTERNET'."\n" + ."\n" + .'- INTRANET. If you set this parameter to this value, the domain name cannot be used on the Internet.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'INTERNET', 'title' => ''], ], [ - 'name' => 'VpcSlbIntranetEnable', + 'name' => 'IsForce', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the self-calling domain name.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether this binding relationship takes precedence over the binding relationships between the domain name and other API groups. If you set this parameter to true, this binding relationship takes precedence, and the domain name is automatically unbound from other API groups. This operation brings risks. Proceed with caution.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'InnerDomainEnable', + 'name' => 'IsHttpRedirectToHttps', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to disable the public second-level domain name.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to redirect HTTP requests to HTTPS requests.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -29223,83 +23222,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0AA90E87-3506-5AA6-AFFB-A4D53B4F6231', 'title' => ''], + 'DomainLegalStatus' => ['description' => 'The validity status of the domain name. Valid values:'."\n" + ."\n" + .'- **NORMAL**: The domain name is valid.'."\n" + ."\n" + .'- **ABNORMAL**: The domain name is invalid. This status affects API calls and must be resolved as soon as possible.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], + 'SubDomain' => ['description' => 'The second-level domain name assigned to the API group. This domain name is used to test API calls.', 'type' => 'string', 'example' => 'xxx-cn-hangzhou.alicloudapi.com', 'title' => ''], + 'DomainName' => ['description' => 'The custom domain name.', 'type' => 'string', 'example' => 'api.demo.com', 'title' => ''], + 'DomainBindingStatus' => ['description' => 'The binding status of the custom domain name. Valid values:'."\n" + ."\n" + .'- **BINDING**: The domain name has been bound.'."\n" + ."\n" + .'- **BOUND**: The domain name has not been bound.', 'type' => 'string', 'example' => 'BINDING', 'title' => ''], + 'DomainRemark' => ['description' => 'The remarks on the domain name, such as the cause of an exception.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'DomainWebSocketStatus' => ['description' => 'The status of the domain name that uses the WebSocket feature.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E707B25-5119-5ACF-9D26-7D2A2762F05C\\"\\n}","type":"json"}]', - 'title' => 'ModifyApiGroupNetworkPolicy', - ], - 'DetachApiProduct' => [ - 'summary' => 'Detaches APIs from an API product.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SetDomain', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomain'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Uploads an SSL certificate for a specified custom domain name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94480', + 'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '927d50c0f2e54b359919923d908bb015', 'title' => ''], ], [ - 'name' => 'Apis', + 'name' => 'DomainName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The APIs that you want to detach from the API product.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ba84c55eca46488598da17c0609f3ead', - ], - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'api.demo.com', 'title' => ''], + ], + [ + 'name' => 'CertificateName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the SSL certificate.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_cert', 'title' => ''], + ], + [ + 'name' => 'CertificateBody', + 'in' => 'query', + 'schema' => ['description' => 'The content of the certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n" + .'MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud'."\n" + .'....'."\n" + .'-----END CERTIFICATE-----', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'CertificatePrivateKey', + 'in' => 'query', + 'schema' => ['description' => 'The private key of the SSL certificate.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----'."\n" + .'MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud'."\n" + .'....'."\n" + .'-----END RSA PRIVATE KEY-----', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'CaCertificateBody', + 'in' => 'query', + 'schema' => ['description' => 'The content of the CA certificate.', 'type' => 'string', 'example' => 'CA certificate encoding content', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SslVerifyDepth', + 'in' => 'query', + 'schema' => ['description' => 'The certificate verification depth.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'SslOcspEnable', + 'in' => 'query', + 'schema' => ['description' => 'If enable ssl OCSP.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'SslOcspCacheEnable', + 'in' => 'query', + 'schema' => ['description' => 'If enable ssl OCSP cache.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'ClientCertSDnPassThrough', + 'in' => 'query', + 'schema' => ['description' => 'If pass ssl\\_client\\_s\\_dn of the cert to backend header \'X-Client-S-Dn\'.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''], ], ], 'responses' => [ @@ -29307,88 +23348,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB\\"\\n}","type":"json"}]', - 'title' => 'DetachApiProduct', - ], - 'SetApiProductsAuthorities' => [ - 'summary' => 'Grants permissions on API products to an application.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","type":"json"}]', + 'title' => 'SetDomainCertificate', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- The SSL certificate must match the custom domain name.'."\n" + ."\n" + .'- After the SSL certificate is bound, HTTPS-based API services become available.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainCertificate'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetDomainCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetDomainWebSocketStatus' => [ + 'summary' => 'Enables or disables WebSocket for a custom domain name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '94481', + 'abilityTreeNodes' => ['FEATUREapigatewayRIX31M'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '111385984', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cf976e63b70c4993807e7bb9345d4695', 'title' => ''], ], [ - 'name' => 'ApiProductIds', + 'name' => 'DomainName', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'simple', - 'schema' => [ - 'description' => 'The API products.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ac.fluvet.cn', 'title' => ''], ], [ - 'name' => 'AuthValidTime', + 'name' => 'ActionValue', 'in' => 'query', - 'schema' => [ - 'description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT), 如果为空,即为授权永久有效。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-06-12T03:07:37Z', - ], + 'schema' => ['description' => 'The action.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'WSSEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The authorization description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'If enable WSS.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -29396,73 +23429,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2603F41E-77FC-59A3-840E-296578A9BDE0', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2603F41E-77FC-59A3-840E-296578A9BDE0\\"\\n}","type":"json"}]', - 'title' => 'SetApiProductsAuthorities', - ], - 'DescribeApiProductsByApp' => [ - 'summary' => 'Queries API products by application.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SetDomainWebSocketStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDomainWebSocketStatus'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'IpControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110962435', - ], + 'schema' => ['description' => 'The ID of the ACL.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the API group.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The API IDs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **PRE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'TEST', 'title' => ''], ], ], 'responses' => [ @@ -29470,110 +23503,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0B805201-AF4C-5788-AC9E-C3EEC83DC82A', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ApiProductInfoList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiProductInfo' => [ - 'description' => 'The information about API products.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApiProductId' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeApiProductsByApp', - ], - 'DescribeApiProductApis' => [ - 'summary' => 'Queries the attached APIs of an API product.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [], + 'title' => 'SetIpControlApis', + 'summary' => 'Creates a binding relationship between specified access control lists (ACLs) and APIs.', + 'description' => '- This operation is intended for API callers.'."\n" + ."\n" + .'- A maximum of 100 APIs can be bound at a time.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetIpControlApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetIpControlApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'SetSignatureApis' => [ + 'summary' => 'Binds a signature key to APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '94485', + 'abilityTreeNodes' => ['FEATUREapigatewayXW2LMR'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'SignatureId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'The signature ID.', 'type' => 'string', 'required' => true, 'example' => '9242e31589fc41f4ba15dd52ffa2ce61', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => true, 'example' => 'b1eed5faa2404af4945cca26d611a136', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The API IDs.', 'type' => 'string', 'required' => true, 'example' => '7ce7022b23a340c7becd947487fad84c', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the testing environment', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ @@ -29581,312 +23590,185 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '03442A3D-3B7D-434C-8A95-A5FEB989B519', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ApiInfoList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiInfo' => [ - 'description' => 'The information about the returned APIs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => 'dd46297680014a7e8e318308f3345951', - ], - 'Description' => [ - 'description' => 'The API description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'GroupName' => [ - 'description' => 'The name of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'testApiGroup', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group.'."\n", - 'type' => 'string', - 'example' => '1e377f18142345dfb700cd8911c2463a', - ], - 'Path' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/test', - ], - 'Method' => [ - 'description' => 'The request method of the API.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'testApi', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the API is deployed.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '27F9C50D-7EB4-5623-8472-45B3C7602C91', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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"}]', - 'title' => 'DescribeApiProductApis', - ], - 'DescribeAppsByApiProduct' => [ - 'summary' => 'Queries authorized applications by API product.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SetSignatureApis', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSignatureApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Binds a throttling policy to APIs.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '94486', + 'abilityTreeNodes' => ['FEATUREapigateway6HGZRN'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'TrafficControlId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'The ID of the throttling policy.', 'type' => 'string', 'required' => true, 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the API group containing the APIs to which you want to bind a specified throttling policy.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApiIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The API ID for the specified operation. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.', 'type' => 'string', 'required' => true, 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'StageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testApp', - ], + 'schema' => ['description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**'."\n" + ."\n" + .'- **TEST**', 'type' => 'string', 'required' => true, 'example' => 'RELEASE', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AC866798-62D3-52F4-8AB5-CA149A53984F', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'AuthorizedApps' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AuthorizedApp' => [ - 'description' => 'The information about authorized applications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'APP_02580_DEV', - ], - 'Description' => [ - 'description' => 'The authorization description.'."\n", - 'type' => 'string', - 'example' => 'Test share with nsc qiming', - ], - 'AuthValidTime' => [ - 'description' => 'The expiration time of the authorization. The time is in GMT. An empty value indicates that the authorization does not expire.'."\n", - 'type' => 'string', - 'example' => '2023-06-17T03:41:53Z', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110982419', - ], - 'Extend' => [ - 'description' => 'The extended information.'."\n", - 'type' => 'string', - 'example' => 'extra info', - ], - 'AuthorizedTime' => [ - 'description' => 'The time when the authorization was created. The time is in GMT.'."\n", - 'type' => 'string', - 'example' => '2016-07-21T06:17:20Z', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": \\"授权描述\\",\\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' => 'DescribeAppsByApiProduct', - ], - 'AttachApiProduct' => [ - 'summary' => 'Attaches APIs to an API product. If the API product does not exist, the system automatically creates the API product.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SetTrafficControlApis', + 'description' => '- This API is intended for API providers.'."\n" + ."\n" + .'- This API allows you to bind a specific throttling policy to up to 100 APIs at a time.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTrafficControlApis'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","type":"json"}]', + ], + 'SetVpcAccess' => [ + 'summary' => 'Creates a virtual private cloud (VPC) access authorization and enables reverse access.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '94487', + 'abilityTreeNodes' => ['FEATUREapigatewayNPQVBL'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'The name of the authorization. The name must be unique.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Apis', + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf657qec7lx42paw3qxxx', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of an ECS or SLB instance in the VPC.', 'type' => 'string', 'required' => true, 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The port number that corresponds to the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the VPC.', 'type' => 'string', 'example' => 'VPC description', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'VpcTargetHostName', + 'in' => 'query', + 'schema' => ['description' => 'The host of the backend service.', 'type' => 'string', 'required' => false, 'example' => 'iot.hu***ng.com', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The APIs to be attached.'."\n", + 'description' => 'The tag of objects that match the rule. You can specify multiple tags.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '551877242a4b4f3a84a56b7c3570e4a7', - ], - 'StageName' => [ - 'description' => 'The environment. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RELEASE', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -29895,49 +23777,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', 'title' => ''], + 'VpcAccessId' => ['description' => 'The ID of the VPC access authorization.', 'type' => 'string', 'example' => '4c68e061860f441ab72af7404137440e', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA20890E-75C7-41BC-9C8B-73276B58F550\\"\\n}","type":"json"}]', - 'title' => 'AttachApiProduct', - ], - 'DeleteApiProduct' => [ - 'summary' => 'Deletes an API product. Deleting an API product causes the association between APIs and the deleted API product to be deleted as well. Exercise caution when you delete an API product. If any API in the API product is associated with an application, the API product fails to be deleted.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"VpcAccessId\\": \\"4c68e061860f441ab72af7404137440e\\"\\n}","type":"json"}]', + 'title' => 'SetVpcAccess', + 'description' => '- This operation is intended for API providers.'."\n" + ."\n" + .'- authorize API Gateway to access your VPC instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVpcAccess'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetVpcAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'SetWildcardDomainPatterns' => [ + 'summary' => 'Specifies a wildcard domain name template for a bound custom domain name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'abilityTreeCode' => '94488', + 'abilityTreeNodes' => ['FEATUREapigatewayJWZLU8'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'The ID of the API group. This ID is generated by the system and globally unique.', 'type' => 'string', 'required' => true, 'example' => '0009db9c828549768a200320714b8930', 'title' => ''], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The custom domain name.', 'type' => 'string', 'required' => true, 'example' => '*.prd.e-eir.com', 'title' => ''], + ], + [ + 'name' => 'WildcardDomainPatterns', + 'in' => 'query', + 'schema' => ['description' => 'The wildcard domain name mode.', 'type' => 'string', 'required' => false, 'example' => '[\\"{svc}.prd.e-eir.com\\"]', 'title' => ''], ], ], 'responses' => [ @@ -29945,70 +23852,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\"\\n}","type":"json"}]', - 'title' => 'DeleteApiProduct', - ], - 'RemoveApiProductsAuthorities' => [ - 'summary' => 'Revokes permissions on API products from an application.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SetWildcardDomainPatterns', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWildcardDomainPatterns'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Switches the definition of an API in a specified runtime environment to a historical version.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110982490', - ], + 'schema' => ['description' => 'The API group ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '8dfec8759a6e4831bf73d8a982c20778', 'title' => ''], ], [ - 'name' => 'ApiProductIds', + 'name' => 'ApiId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The API products.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The API ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b41f334843c445619bc3b85419895b3e', 'title' => ''], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => ['description' => 'The environment. Valid values:'."\n" + ."\n" + .'- **RELEASE**: the production environment'."\n" + ."\n" + .'- **PRE**: the staging environment'."\n" + ."\n" + .'- **TEST**: the test environment', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RELEASE', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description. The description can be up to 200 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'for_demo', 'title' => ''], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => ['description' => 'The historical version number of the API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20210305180312839', 'title' => ''], ], ], 'responses' => [ @@ -30016,86 +23932,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FB263467-7F5D-5A1B-88E8-06CB0228E0FE', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\"\\n}","type":"json"}]', - 'title' => 'RemoveApiProductsAuthorities', - ], - 'SetAppsAuthToApiProduct' => [ - 'summary' => 'Authorizes multiple applications to call APIs in an API product.', - 'methods' => [ - 'post', - 'get', + 'title' => 'SwitchApi', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchApi'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Create tag-resource relationships (user tags).', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', + 'abilityTreeCode' => '94494', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'ApiProductId', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the API product.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', - ], + 'schema' => ['description' => 'Resource type. Currently, groups, plug-ins, and applications support tags. API-related operations use group-level tags:'."\n" + ."\n" + .'- **apiGroup**'."\n" + ."\n" + .'- **plugin**'."\n" + ."\n" + .'- **app**'."\n" + ."\n" + .'- **api**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup', 'title' => ''], ], [ - 'name' => 'AppIds', + 'name' => 'Tag', 'in' => 'query', - 'style' => 'flat', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the applications that you want to authorize.'."\n", + 'description' => 'The tag value of the resource.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the application that you want to authorize.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key.'."\n" + ."\n" + .'n ranges from 1 to `20`.', 'type' => 'string', 'required' => true, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'Tag value.'."\n" + ."\n" + .'n ranges from 1 to `20`.', 'type' => 'string', 'required' => true, 'example' => '\' \'', 'title' => ''], + ], 'required' => false, - 'example' => '110966607', + 'description' => 'The tag of objects that match the lifecycle rule. You can specify multiple tags.', + 'title' => '', + 'example' => '', ], 'required' => true, + 'example' => '2021022811', + 'maxItems' => 10000, + 'title' => '', ], ], [ - 'name' => 'AuthValidTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time (UTC) when the authorization expires. If this parameter is empty, the authorization does not expire.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-31T08:15:39Z', - ], - ], - [ - 'name' => 'Description', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The description of the authorization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test', + 'description' => 'Resource ID.'."\n" + ."\n" + .'n ranges from 1 to `50`.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, + 'example' => '285bb759342649a1b70c2093a772e087', + 'maxItems' => 10000, + 'title' => '', ], ], ], @@ -30104,76 +24042,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', - 'title' => 'SetAppsAuthToApiProduct', - ], - 'DescribeApisByVpcAccess' => [ - 'summary' => 'Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region.', - 'methods' => [ - 'post', - 'get', + 'title' => 'TagResources', + 'description' => '- All tags apply to all resource IDs in the list. This means that each ResourceId.N is associated with all specified key-value pairs.'."\n" + ."\n" + .'- For Tag.N.Key and Tag.N.Value, the same N value indicates a matching key-value pair.'."\n" + ."\n" + .'- Tag multiple resources in one call. The operation either succeeds for all resources or fails for all resources.'."\n" + ."\n" + .'- If you specify Tag.1.Value, you must also specify Tag.1.Key. Otherwise, the system returns the error InvalidParameter.TagKey. If you specify a Tag.N.Value, the corresponding Tag.N.Key must exist. The Tag.N.Key value can be an empty string.'."\n" + ."\n" + .'- If you specify a resource and a tag key that already exists, the existing tag value is overwritten.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '94328', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayNPQVBL', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '94496', + 'abilityTreeNodes' => ['FEATUREapigatewayX0L6BS'], ], 'parameters' => [ [ - 'name' => 'VpcName', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the VPC access authorization.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'lynkco-iov-uat', - ], + 'schema' => ['description' => 'The type of the resource. Tags are bound to API groups, plug-ins, and applications. You can use tags to manage cloud resources by group. Valid values:'."\n" + ."\n" + .'* **apiGroup**'."\n" + .'* **plugin**'."\n" + .'* **app**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'apiGroup', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to delete all tags. This parameter is valid only when the **TagKey.N**parameter is not specified. Default value: false. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '10', + 'description' => 'The resource IDs.'."\n", + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The ID of the resource.'."\n" + ."\n" + .'Valid values of N: `1 to 50.`'."\n", 'example' => '285bb759342649a1b70c2093a772e087', 'title' => ''], + 'required' => true, + 'example' => '285bb759342649a1b70c2093a772e087', + 'maxItems' => 10000, + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The tag keys of the resource.'."\n", + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => 'The key of tag N.'."\n" + ."\n" + .'Valid values of N: `1 to 20.`'."\n", 'example' => 'thirdparty', 'title' => ''], 'required' => false, - 'minimum' => '1', - 'example' => '2', + 'example' => 'env', + 'maxItems' => 10000, + 'title' => '', ], ], ], @@ -30182,137 +24153,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'ApiVpcAccessInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ApiVpcAccessInfo' => [ - 'description' => 'The returned API information. It is an array consisting of ApiInfo data.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'example' => '09839002de484e76b5a213b040a6a3ca', - ], - 'VpcId' => [ - 'description' => 'vpc id'."\n", - 'type' => 'string', - 'example' => 'vpc-2ze7bj64wstznvftrskbk', - ], - 'InstanceId' => [ - 'description' => 'The instance ID or IP address in the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'Ib-04e41XXXXXd95e9c1', - ], - 'Port' => [ - 'description' => 'The port number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'StageId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => '57e17906a69b4424914fb1e05f67c78a', - ], - 'VpcName' => [ - 'description' => 'The name of the VPC access authorization.'."\n", - 'type' => 'string', - 'example' => 'aliYun_service_prod', - ], - 'GroupId' => [ - 'description' => 'The ID of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => '41c33748cbfb41f6b00870156203b72a', - ], - 'GroupName' => [ - 'description' => 'The name of the API group to which the API belongs.'."\n", - 'type' => 'string', - 'example' => 'RT_PLU_IP_CTRL_group', - ], - 'Description' => [ - 'description' => 'The description, which can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'StageName' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the staging environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'example' => 'RELEASE', - ], - 'ApiName' => [ - 'description' => 'The API name.'."\n", - 'type' => 'string', - 'example' => 'iwc', - ], - 'Path' => [ - 'description' => 'The request path of the API.'."\n", - 'type' => 'string', - 'example' => '/api/v1/friends/rc/status', - ], - 'Method' => [ - 'description' => 'The HTTP request method of the API.'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', 'title' => ''], ], 'description' => '', + 'title' => '', ], ], ], - '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"}]', - 'title' => 'DescribeApisByVpcAccess', - ], - 'DeleteAppCode' => [ - 'summary' => 'Deletes the AppCode of an application.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\r\\n <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>\\r\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + 'summary' => 'Removes tags from resources.', + 'description' => '* If you call this operation to untag multiple resources simultaneously, either all or none of the resources will be untagged.'."\n" + .'* If you specify resource IDs without specifying tag keys and set the All parameter to true, all tags bound to the specified resources will be deleted. If a resource does not have any tags, the request is not processed but a success is returned.'."\n" + .'* If you specify resource IDs without specifying tag keys and set the All parameter to false, the request is not processed but a success is returned.'."\n" + .'* When tag keys are specified, the All parameter is invalid.'."\n" + .'* When multiple resources and key-value pairs are specified, the specified tags bound to the resources are deleted.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Modifies an internal domain name resolution.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30320,99 +24201,111 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '207739', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => ['description' => 'The internal domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'api.demo.com', 'title' => ''], + ], + [ + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The application ID.'."\n", + 'description' => 'The internal domain name resolution type. Valid values:'."\n" + ."\n" + .'* VPC: resolution for virtual private cloud (VPC) access authorizations. A resolution of this type can be bound only to traditional dedicated instances.'."\n" + .'* A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '111265074', + 'enumValueTitles' => ['A' => 'A', 'VPC' => 'VPC'], + 'example' => 'A', + 'title' => '', ], ], [ - 'name' => 'AppCode', - 'in' => 'query', + 'name' => 'Records', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The application AppCode.'."\n", - 'type' => 'string', + 'description' => 'The resolution records. This parameter is valid only when Type is set to A.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the resolution record.'."\n", + 'type' => 'object', + 'properties' => [ + 'Record' => ['description' => 'The resolution record.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.0.2', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '0d13f021c5cd4997831a9717e75b0663', + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7'], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99\\"\\n}","type":"json"}]', - 'title' => 'DeleteAppCode', - ], - 'DeleteAppKey' => [ - 'summary' => 'Deletes the AppKey and AppSecret of an application.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + 'title' => 'UpdatePrivateDNS', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateDNS'], + ], + 'product' => ['code' => 'apigateway', 'title' => 'API 网关'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:UpdatePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ValidateVpcConnectivity' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '207740', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'VpcAccessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '110840611', - ], + 'schema' => ['description' => 'The ID of the VPC access authorization.'."\n", 'type' => 'string', 'required' => true, 'example' => '5f1b3216f9********e2c1297b6741dc', 'title' => ''], ], [ - 'name' => 'AppKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The AppKey of the application. The AppKey is used for calling an API.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '203708622', - ], + 'schema' => ['description' => 'The ID of the API Gateway instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'apigateway-hz-72bc18******', 'title' => ''], ], ], 'responses' => [ @@ -30420,947 +24313,3162 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '79EF055D-AC00-5161-8F35-6A36AAED7422', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1', 'title' => ''], + 'Connected' => ['description' => 'Indicates whether the API Gateway instance is connected to the port. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'IpType' => ['description' => 'Indicates whether the instance in the authorization is an ECS instance or an SLB instance when the instance ID in the authorization is an IP address. Valid values:'."\n" + ."\n" + .'* **ECS**'."\n" + .'* **SLB**'."\n" + .'* **INVALID**: The instance type corresponding to the IP address is invalid.'."\n", 'type' => 'string', 'example' => 'ECS', 'title' => ''], ], 'description' => '', + 'title' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A591B5B-0EC2-5463-B8B8-1984AE3AEBF1\\",\\n \\"Connected\\": true,\\n \\"IpType\\": \\"ECS\\"\\n}","type":"json"}]', + 'title' => 'ValidateVpcConnectivity', + 'summary' => 'Tests the network connectivity between an API Gateway instance and a port on an Elastic Compute Service (ECS) or Server Load Balance (SLB) instance in a virtual private cloud (VPC) access authorization.', + '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' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79EF055D-AC00-5161-8F35-6A36AAED7422\\"\\n}","type":"json"}]', - 'title' => 'DeleteAppKey', ], - 'CreateAppCode' => [ - 'summary' => 'Adds an AppCode to an application.', - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.ap-northeast-2.aliyuncs.com', 'endpoint' => 'apigateway.ap-northeast-2.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.ap-southeast-7.aliyuncs.com', 'endpoint' => 'apigateway.ap-southeast-7.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-beijing.aliyuncs.com', 'endpoint' => 'apigateway.cn-beijing.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-chengdu.aliyuncs.com', 'endpoint' => 'apigateway.cn-chengdu.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-guangzhou.aliyuncs.com', 'endpoint' => 'apigateway.cn-guangzhou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-hangzhou.aliyuncs.com', 'endpoint' => 'apigateway.cn-hangzhou.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-heyuan.aliyuncs.com', 'endpoint' => 'apigateway.cn-heyuan.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-hongkong.aliyuncs.com', 'endpoint' => 'apigateway.cn-hongkong.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-huhehaote.aliyuncs.com', 'endpoint' => 'apigateway.cn-huhehaote.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-qingdao.aliyuncs.com', 'endpoint' => 'apigateway.cn-qingdao.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-shanghai.aliyuncs.com', 'endpoint' => 'apigateway.cn-shanghai.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-shenzhen.aliyuncs.com', 'endpoint' => 'apigateway.cn-shenzhen.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'apigateway.cn-wulanchabu.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'apigateway.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'apigateway.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'apigateway-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'apigateway.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'apigateway.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'apigateway.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => ''], + ['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' => 'CloudAPI'], + ], + 'ram' => [ + 'productCode' => 'ApiGateway', + 'productName' => 'API Gateway', + 'ramCodes' => ['apigateway', 'cloudapi'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DescribeIpControls', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeIpControls', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'IpControl', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:ipcontrol/*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeAppsByApiProduct', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppsByApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeApiProductsByApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiProductsByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApp', + 'description' => '', + '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' => '', + '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' => 'All Resource', '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' => '', + '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', - 'abilityTreeCode' => '207738', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', + 'ramAction' => [ + 'action' => 'apigateway:CreateModel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '111203109', + [ + 'apiName' => 'DeleteDomainCertificate', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteDomainCertificate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], - [ - 'name' => 'AppCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application AppCode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88', - ], - ], - 'description' => '', + [ + '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}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88\\"\\n}","type":"json"}]', - 'title' => 'CreateAppCode', - ], - 'CreateAppKey' => [ - 'summary' => 'Adds an AppKey and AppSecret pair to an application.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'OpenApiGatewayService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'apigateway:OpenApiGatewayService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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/*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAccessControlListAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAccessControlListAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SetIpControlApis', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetIpControlApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDatasetItem', + 'description' => '', 'operationType' => 'create', - 'abilityTreeCode' => '207737', - 'abilityTreeNodes' => [ - 'FEATUREapigatewayCRDGVZ', + 'ramAction' => [ + 'action' => 'apigateway:CreateDatasetItem', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Dataset', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:dataset/{#DatasetId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '111053351', + [ + 'apiName' => 'DescribeVpcAccesses', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeVpcAccesses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'Vpc', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:vpcaccess/{#VpcAccessId}'], ], ], - [ - 'name' => 'AppKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application AppKey.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '204203237', + ], + [ + '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}'], ], ], - [ - 'name' => 'AppSecret', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application AppSecret.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6f0a4ad7918a4b41a57fc087d5b066d0', + ], + [ + 'apiName' => 'DescribeApisWithStageNameIntegratedByApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisWithStageNameIntegratedByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5D524309-6BED-5BB4-A735-F7D9F98B7B88', - ], - ], - 'description' => '', + [ + '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}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D524309-6BED-5BB4-A735-F7D9F98B7B88\\"\\n}","type":"json"}]', - 'title' => 'CreateAppKey', - ], - 'DescribeInstanceClusterInfo' => [ - 'summary' => 'Queries the information about a dedicated instance cluster.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribePluginsByApi', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginsByApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'AddAccessControlListEntry', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:AddAccessControlListEntry', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'AccessControlList', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribePluginsByGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePluginsByGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeDeployApiTask', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '175318', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDeployApiTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceClusterName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dedicated instance cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testvpc', + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'InstanceClusterName' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'InstanceClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'apigateway-ht-04e41d95e9c1'."\n", - ], - 'InstanceClusterStatus' => [ - 'description' => 'The cluster status.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'InstanceClusterVersion' => [ - 'description' => 'The cluster version.'."\n", - 'type' => 'string', - 'example' => '3.5.3.856', - ], - 'Description' => [ - 'description' => 'The cluster description, which can be up to 200 characters in length.'."\n", - 'type' => 'string', - 'example' => 'v0.0.4', - ], - 'RegionId' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CreatedTime' => [ - 'description' => 'The time when the cluster was created.'."\n", - 'type' => 'string', - 'example' => '2022-10-10T18:29:27', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the cluster was last modified.'."\n", - 'type' => 'string', - 'example' => '2023-06-19 10:40:29 +0800', - ], - 'InstanceClusterAttribute' => [ - 'description' => 'The cluster details.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpsPolicies' => [ - 'description' => 'The HTTPS security policy.'."\n", - 'type' => 'string', - 'example' => 'HTTPS2_TLS1_0', - ], - 'InternetEgressAddress' => [ - 'description' => 'The outbound public IP address.'."\n", - 'type' => 'string', - 'example' => '39.106.XX.XX', - ], - 'IntranetEgressAddress' => [ - 'description' => 'The outbound private IP address.'."\n", - 'type' => 'string', - 'example' => '100.104.XX.XX/26', - ], - 'VpcIntranetEnable' => [ - 'description' => 'Indicates whether a virtual private cloud (VPC) domain name is enabled.'."\n", - 'type' => 'boolean', - ], - 'IntranetSegments' => [ - 'description' => 'The custom CIDR block. The configured CIDR block is considered as a private block.'."\n", - 'type' => 'string', - 'example' => '123.0.0.1', - ], - 'UserVpcId' => [ - 'description' => 'The ID of the client VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zew2v4vcg78mXXXX', - ], - 'UserVswitchId' => [ - 'description' => 'The vSwitch of the client VPC.'."\n", - 'type' => 'string', - 'example' => 'vsw-2zecr5r7ao44tslsXXXX', - ], - 'VpcOwnerId' => [ - 'description' => 'The ID of the account to which the VPC belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '165438596694XXXX', - ], - 'IPV4AclId' => [ - 'description' => 'The ID of the IPv4 access control list (ACL).'."\n", - 'type' => 'string', - 'example' => 'acl-t4n8i4rvvp70kcyuoXXXX', - ], - 'IPV4AclName' => [ - 'description' => 'The name of the IPv4 ACL.'."\n", - 'type' => 'string', - 'example' => 'test-black', - ], - 'IPV4AclStatus' => [ - 'description' => 'Indicates whether IPv4 access control is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'IPV4AclType' => [ - 'description' => 'The type of the IPv4 ACL.'."\n" - ."\n" - .'* black: blacklist'."\n" - .'* white: whitelist'."\n", - 'type' => 'string', - 'example' => 'black', - ], - 'EgressIpv6Enable' => [ - 'description' => 'Indicates whether outbound IPv6 traffic is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportIpv6' => [ - 'description' => 'Indicates whether IPv6 traffic is supported.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IPV6AclName' => [ - 'description' => 'The name of the IPv6 ACL.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'IPV6AclId' => [ - 'description' => 'The ID of the IPv6 ACL.'."\n", - 'type' => 'string', - 'example' => 'acl-t4nevzhwbpe7cup18XXXX', - ], - 'IPV6AclStatus' => [ - 'description' => 'Indicates whether IPv6 access control is enabled. Valid values:'."\n" - ."\n" - .'* **on**'."\n" - .'* **off**'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'IPV6AclType' => [ - 'description' => 'The type of the IPv6 ACL. Valid values:'."\n" - ."\n" - .'* black: blacklist'."\n" - .'* white: whitelist'."\n", - 'type' => 'string', - 'example' => 'white', - ], - 'VipTypeList' => [ - 'description' => 'The VIPs of the cluster.'."\n", - 'type' => 'string', - 'example' => 'VPC_INTERNET_IPV6', - ], - 'VpcSlbIntranetEnable' => [ - 'description' => 'Indicates whether self-calling is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ConnectVpcId' => [ - 'description' => 'The ID of the user VPC that is connected to the cluster if the cluster consists of VPC integration instances.'."\n", - 'type' => 'string', - 'example' => 'vpc-p0w3kxxxxxxxxxxxxxxxx', - ], - 'ConnectCidrBlocks' => [ - 'description' => 'The internal CIDR block of the user VPC that can be accessed by the cluster if the cluster consists of VPC integration instances.'."\n", - 'type' => 'string', - 'example' => '["192.168.1.0/24","192.168.0.0/24"]', - ], - ], - ], - 'InstanceList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Instance' => [ - 'description' => 'The dedicated instances contained in the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceName' => [ - 'description' => 'The instance name.'."\n", - 'type' => 'string', - 'example' => 'tf-testacceu-central-1apigatewayinstance8752', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'apigateway-ht-04e41d95e9c1', - ], - 'Status' => [ - 'description' => 'The instance status.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the call fails.'."\n", - 'type' => 'string', - 'example' => 'Instance not found.', - ], - ], - ], - ], - ], - ], - 'InstanceClusterType' => [ - 'description' => 'The cluster type.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - ], - 'description' => '', + [ + '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}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeInstanceHttpCode', + 'description' => '', + '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\\": \\"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' => 'DescribeInstanceClusterInfo', - ], - 'DescribeInstanceClusterList' => [ - 'summary' => 'Queries dedicated instance clusters.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ValidateVpcConnectivity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:ValidateVpcConnectivity', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyVpcAccessAndUpdateApis', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyVpcAccessAndUpdateApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeAuthorizedApps', + 'description' => '', + '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' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeImportOASTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DetachApiProduct', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DetachApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyApp', + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeUpdateVpcInfoTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ImportSwagger', + 'description' => '', + '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' => '', + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAccessControlList', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteAccessControlList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetDomainCertificate', + 'description' => '', + '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' => 'All Resource', '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyApiConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApiDoc', + 'description' => '', + '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' => '', + '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', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '175317', - 'abilityTreeNodes' => [ - 'FEATUREapigateway910B7T', + 'ramAction' => [ + 'action' => 'apigateway:DescribeStageModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceClusterName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-cluster', + [ + '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}'], ], ], - [ - 'name' => 'InstanceClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx', + ], + [ + 'apiName' => 'DescribeAppSecurity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppSecurity', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'CreateApi', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateApi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + '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}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'InstanceClusters' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'InstanceCluster' => [ - 'description' => 'The instance cluster list.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceClusterName' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => 'test-cluster', - ], - 'InstanceClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx'."\n", - ], - 'Description' => [ - 'description' => 'The cluster description.'."\n", - 'type' => 'string', - 'example' => 'Test TrafficControl', - ], - 'CreatedTime' => [ - 'description' => 'The time when the cluster was created. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-08-14T17:46:59+08:00', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the cluster was last modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-01-12T10:11:08+08:00', - ], - 'RegionId' => [ - 'description' => 'The region ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'InstanceClusterStatus' => [ - 'description' => 'The cluster status.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'InstanceClusterType' => [ - 'description' => 'The cluster type.'."\n", - 'type' => 'string', - 'example' => 'normal', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeAbolishApiTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAbolishApiTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeInstanceSlbConnect', + 'description' => '', + '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\\": \\"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"}]', - 'title' => 'DescribeInstanceClusterList', - ], - 'DescribeAppSecurities' => [ - 'summary' => 'Queries the key-related information of an application.', - 'methods' => [ - 'post', - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + '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}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeAppSecurities', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppSecurities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + '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}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '110862931', + [ + 'apiName' => 'SetDomainWebSocketStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:SetDomainWebSocketStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', - ], - 'AppSecuritys' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'AppSecurity' => [ - 'description' => 'The associated security policy information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppSecret' => [ - 'description' => 'The application AppSecret.'."\n", - 'type' => 'string', - 'example' => 'ea5291a7aff343769eb3139a2f6de8c9', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the AppSecret was last modified. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-08-14T18:03:00+08:00', - ], - 'AppKey' => [ - 'description' => 'The application AppKey.'."\n", - 'type' => 'string', - 'example' => '34379343', - ], - 'CreatedTime' => [ - 'description' => 'The time when the AppKey was created.'."\n", - 'type' => 'string', - 'example' => '2021-09-14T18:50:59', - ], - 'AppCode' => [ - 'description' => 'The application AppCode.'."\n", - 'type' => 'string', - 'example' => 'd2350ecd62c44cbfbe35a7f182e35105', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeApiLatencyData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiLatencyData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], ], - '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"}]', - 'title' => 'DescribeAppSecurities', - ], - 'ExportOAS' => [ - 'summary' => 'Exports APIs based on OpenAPI Specification (OAS).', - 'methods' => [ - 'post', - 'get', + [ + '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}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateLogConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateLogConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteApiGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteApiGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteStageModel', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteStageModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateIpControl', + 'description' => '', + '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' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAppAttributes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'App', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:app/*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DataFormat', - 'in' => 'query', - 'schema' => [ - 'description' => 'The exported format:'."\n" - ."\n" - .'* json'."\n" - .'* yaml'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yaml', + [ + '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}'], ], ], - [ - 'name' => 'ApiIdList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The APIs that you want to export.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8afff6c8c4c6447abb035812e4d66xxx', - ], - 'required' => false, - 'docRequired' => false, - 'maxItems' => 300, - 'minItems' => 1, + ], + [ + '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}'], ], ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The API group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '42925e7f5209438186d5560239af5xxx', + ], + [ + 'apiName' => 'DescribeApiGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiGroups', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/*'], ], ], - [ - 'name' => 'StageName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment to which the API is published. Valid values:'."\n" - ."\n" - .'* **RELEASE**: the production environment'."\n" - .'* **PRE**: the pre-release environment'."\n" - .'* **TEST**: the test environment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RELEASE', + ], + [ + 'apiName' => 'DescribeHistoryApis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeHistoryApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], - [ - 'name' => 'OasVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The OAS version. Valid values:'."\n" - ."\n" - .'* **oas2**'."\n" - .'* **oas3**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oas2', + ], + [ + 'apiName' => 'DescribeDatasetInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeDatasetInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'WithXExtensions', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to export API Gateway extensions at the same time.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + '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}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of pages in which you want to export the APIs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribePurchasedApis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribePurchasedApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'ApiGroup', 'arn' => 'acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The Base64-encoded data of the exported Swagger file. You can obtain the file by using Base64 decoding.'."\n", - 'type' => 'string', - 'example' => 'UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx', - ], - ], - 'description' => '', + [ + '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}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...\\",\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx\\"\\n}","type":"json"}]', - 'title' => 'ExportOAS', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'apigateway.cn-heyuan-acdr-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'apigateway.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'apigateway.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'apigateway.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'apigateway.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'apigateway.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'apigateway.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'apigateway.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'apigateway.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'apigateway.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'apigateway.cn-north-2-gov-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'apigateway.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'apigateway.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'apigateway.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'apigateway.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'apigateway.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'apigateway.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'apigateway.cn-beijing-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'apigateway.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'apigateway.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'apigateway.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'apigateway.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'apigateway.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'apigateway.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'apigateway.cn-shanghai-inner.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'apigateway.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'apigateway.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'apigateway.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'apigateway.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'apigateway.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'apigateway.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'apigateway.cn-beijing.aliyuncs.com', + [ + 'apiName' => 'ModifyIpControl', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyIpControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreatePrivateDNS', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreatePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceQps', + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyInstanceSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyInstanceSpec', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAllTrafficSpecialControl', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeleteAllTrafficSpecialControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveApiProductsAuthorities', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveApiProductsAuthorities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DryRunSwagger', + 'description' => '', + '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' => '', + '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' => '', + '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' => 'All Resource', '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' => '', + '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:BatchDeployApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppCode', + 'description' => '', + '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' => '', + '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' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveVpcAccess', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSystemParameters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeSystemParameters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', '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' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:SdkGenerateByApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateStageModel', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:CreateStageModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApiQpsData', + 'description' => '', + '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' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApiProductApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceClusterList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'apigateway:DescribeInstanceClusterList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AssociateInstanceWithPrivateDNS', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:AssociateInstanceWithPrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAccessControlLists', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeAccessControlLists', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyApi', + 'description' => '', + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppKey', + 'description' => '', + '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ResetAppSecret', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => '', + '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' => 'All Resource', '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' => '', + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreatePlugin', + 'description' => '', + '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' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyApiGroupInstance', + 'description' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeInstanceClusterInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeInstanceClusterInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeletePrivateDNS', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:DeletePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:BatchAbolishApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdatePrivateDNS', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:UpdatePrivateDNS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => 'All Resource', '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' => '', + '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' => '', + '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' => '', + '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' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApiMarketAttributes', + 'description' => '', + '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' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'apigateway:RemoveVpcAccessAndAbolishApis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetApiProductsAuthorities', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:SetApiProductsAuthorities', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeApisByTrafficControl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'apigateway:DescribeApisByTrafficControl', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', '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' => '', + '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' => '', + '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' => '', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AttachApiProduct', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'apigateway:AttachApiProduct', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DetachPlugin', + 'description' => '', + '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' => '', + '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' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'apigateway:ModifyInstanceVpcAttributeForConsole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ApiGateway', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeGroupQps', + 'description' => '', + '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' => 'All Resource', '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/*'], ], ], ]; |
