diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/cloudapi | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cloudapi')
| -rw-r--r-- | data/en_us/cloudapi/2016-02-01/api-docs.php | 3853 | ||||
| -rw-r--r-- | data/en_us/cloudapi/2016-07-01/api-docs.php | 1700 | ||||
| -rw-r--r-- | data/en_us/cloudapi/2016-07-14/api-docs.php | 31366 | ||||
| -rw-r--r-- | data/en_us/cloudapi/2018-06-01/api-docs.php | 5237 |
4 files changed, 42156 insertions, 0 deletions
diff --git a/data/en_us/cloudapi/2016-02-01/api-docs.php b/data/en_us/cloudapi/2016-02-01/api-docs.php new file mode 100644 index 0000000..b559dcb --- /dev/null +++ b/data/en_us/cloudapi/2016-02-01/api-docs.php @@ -0,0 +1,3853 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CloudAPI', + 'version' => '2016-02-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CheckAoneAppAudit', + 'CreateApiGroup', + 'CreateAppForBackend', + 'CreateAppForInner', + 'CreateInstance', + 'CreateUserWhiteList', + 'DeleteApiGroup', + 'DeleteAppForInner', + 'DescribeApiDoc', + 'DescribeApiDocs', + 'DescribeApiGroups', + 'DescribeApiMarketInstance', + 'DescribeApis', + 'DescribeApisForConsole', + 'DescribeAppSecurities', + 'DescribeApps', + 'DescribeAvailableVips', + 'DescribeBidByUserIdForInner', + 'DescribeDeployedApis', + 'DescribeModelsForInner', + 'DescribePurchasedApiGroups', + 'DescribeRegions', + 'DescribeSecretKeys', + 'DescribeSystemParameters', + 'DescribeTrafficControls', + 'DescribeUserWhiteLists', + 'ModifyApiMarketInstanceAttribute', + 'ModifyApp', + 'ModifyAppForInner', + 'ModifyGroupAuthAppCodeForBackend', + 'ResetAppCodeForInner', + 'ResetSecretByAppKeyForInner', + 'SetAccessPermissionByGroupForBackend', + 'SetPurchasedApiGroupStatus', + 'DescribeAppSecurityForInner', + 'DeleteUserWhiteListByType', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CheckAoneAppAudit' => [ + 'summary' => '检查aone app', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '94504', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AoneAppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CheckResult' => [ + 'type' => 'boolean', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateApiGroup' => [ + 'summary' => '创建API分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94510', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SubDomain' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateAppForBackend' => [ + 'summary' => '创建APP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94513', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateAppForInner' => [ + 'summary' => '创建APP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94514', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AppSecret', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateInstance' => [ + 'summary' => '创建实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94515', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayAQG9N5', + ], + ], + 'parameters' => [ + [ + 'name' => 'AccountQuantity', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ExpiredOn', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'BillingType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SkuId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CloudMarketInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceAttributes', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AlarmQuota', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateUserWhiteList' => [ + 'summary' => '创建用户白名单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94519', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AoneId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'LimitCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteApiGroup' => [ + 'summary' => '删除API分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94523', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteAppForInner' => [ + 'summary' => '删除APP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94525', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApiDoc' => [ + 'summary' => '查询API文档', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94535', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayY6W7D1', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'type' => 'string', + ], + 'HttpMethod' => [ + 'type' => 'string', + ], + 'ResultType' => [ + 'type' => 'string', + ], + 'ResultSample' => [ + 'type' => 'string', + ], + 'HttpProtocol' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'FailResultSample' => [ + 'type' => 'string', + ], + 'PostBodyType' => [ + 'type' => 'string', + ], + 'BodyFormat' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'Path' => [ + 'type' => 'string', + ], + 'PostBodyDescription' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'ServiceTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SdkDemos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SdkDemo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallDemo' => [ + 'type' => 'string', + ], + 'IdeKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ErrorCodeSamples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorCodeSample' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ResultDescriptions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultDescription' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'Key' => [ + 'type' => 'string', + ], + 'HasChild' => [ + 'type' => 'boolean', + ], + 'Description' => [ + 'type' => 'string', + ], + 'Pid' => [ + 'type' => 'string', + ], + 'Mandatory' => [ + 'type' => 'boolean', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PathParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PathParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'RequestQueries' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + 'RequestBody' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApiDocs' => [ + 'summary' => '查询api基础信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'GroupDescription' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApiGroups' => [ + 'summary' => '查询API分组列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94543', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiGroupAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiGroupAttribute' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'IllegalStatus' => [ + 'type' => 'string', + ], + 'BillingStatus' => [ + 'type' => 'string', + ], + 'TrafficLimit' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SubDomain' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApiMarketInstance' => [ + 'summary' => '查询API云市场实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94546', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceAttributes' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApis' => [ + 'summary' => '查询API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94550', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApisForConsole' => [ + 'summary' => '查询API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94554', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'DeployedInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StageName' => [ + 'type' => 'string', + ], + 'EffectiveVersion' => [ + 'type' => 'string', + ], + 'DeployedStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeAppSecurities' => [ + 'summary' => '查询APP秘钥信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94559', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'AppSecuritys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppSecurity' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppSecret' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'AppKey' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'AppCode' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApps' => [ + 'summary' => '查询APP列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94557', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Apps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'App' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'AppId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeAvailableVips' => [ + 'summary' => '查询可用VIP列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94563', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vip', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'AvailableVips' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableVip' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeBidByUserIdForInner' => [ + 'summary' => '通过UID查询用户的BID', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94564', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Bid' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeDeployedApis' => [ + 'summary' => '查询发布的API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94568', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeModelsForInner' => [ + 'summary' => '查询模型列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94573', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ModelDetails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModelDetail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'Schema' => [ + 'type' => 'string', + ], + 'ModelName' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ModelRef' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribePurchasedApiGroups' => [ + 'summary' => '查询购买的API分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94576', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PurchasedApiGroupAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PurchasedApiGroupAttribute' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'ExpireTime' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'InvokeTimesMax' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupDescription' => [ + 'type' => 'string', + ], + 'InvokeTimesNow' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'BillingType' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeRegions' => [ + 'summary' => '查询地域列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94580', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'type' => 'string', + ], + 'EndPoint' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSecretKeys' => [ + 'summary' => '查询秘钥的key', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94582', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecretKeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SecretKeyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SecretKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecretKey' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecretKeyId' => [ + 'type' => 'string', + ], + 'SecretKey' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'SecretKeyName' => [ + 'type' => 'string', + ], + 'SecretKeyValue' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSystemParameters' => [ + 'summary' => '查询系统参数列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94583', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayZKRUYC', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParamName' => [ + 'type' => 'string', + ], + 'ParamType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeTrafficControls' => [ + 'summary' => '查询流控插件列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94585', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TrafficControlName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TrafficControls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficControl' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'TrafficControlUnit' => [ + 'type' => 'string', + ], + 'TrafficControlName' => [ + 'type' => 'string', + ], + 'AppDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TrafficControlId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'SpecialPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SpecialPolicy' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpecialType' => [ + 'type' => 'string', + ], + 'Specials' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Special' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SpecialKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeUserWhiteLists' => [ + 'summary' => '查询用户白名单列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94586', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'UserWhiteListInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserWhiteListInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Uid' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AoneId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyApiMarketInstanceAttribute' => [ + 'summary' => '修改云市场实例属性', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94594', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'InstanceAttributes', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyApp' => [ + 'summary' => '修改APP', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94595', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyAppForInner' => [ + 'summary' => '修改APP信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94596', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Disabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyGroupAuthAppCodeForBackend' => [ + 'summary' => '修改分组授权AppCode', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94598', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthAppCode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'enum' => [ + 'UNSUPPORT', + 'SUPPORT', + ], + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ResetAppCodeForInner' => [ + 'summary' => '重置AppCode', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94619', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '248213c1bb9049ba8fbd4a398ac2a093', + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1707234864281204', + ], + ], + [ + 'name' => 'NewAppCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'a6245c6af01b46ac838993f17027b2bd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DA4EF310-163D-5560-B73C-10F1C3ADF865', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA4EF310-163D-5560-B73C-10F1C3ADF865\\"\\n}","type":"json"}]', + ], + 'ResetSecretByAppKeyForInner' => [ + 'summary' => '重置APP秘钥', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94621', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '204169484', + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1009768422449530', + ], + ], + [ + 'name' => 'NewAppSecret', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'b7e752d1580227e0af3ab1b5e643a497', + ], + ], + [ + 'name' => 'NewAppKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'testAppKey', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '72B9CFC0-80EA-5DBC-894F-C52921F085BE', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72B9CFC0-80EA-5DBC-894F-C52921F085BE\\"\\n}","type":"json"}]', + ], + 'SetAccessPermissionByGroupForBackend' => [ + 'summary' => '设置分组的访问权限', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94623', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetPurchasedApiGroupStatus' => [ + 'summary' => '设置购买API分组的状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94631', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'BillingStatus', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CloseOrder', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeAppSecurityForInner' => [ + 'summary' => '查询APP秘钥信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94561', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '110862931', + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1037842620328768', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AppSecret' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c1ae97aaa7e45f21d10824bc44678fee', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88', + ], + 'AppKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60030986', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-01-29T09:33:01Z', + ], + 'AppCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + ], + 'CreatedTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2019-01-29T09:33:01Z', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppSecret\\": \\"c1ae97aaa7e45f21d10824bc44678fee\\",\\n \\"RequestId\\": \\"418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88\\",\\n \\"AppKey\\": \\"60030986\\",\\n \\"ModifiedTime\\": \\"2019-01-29T09:33:01Z\\",\\n \\"AppCode\\": \\"3aaf905a0a1f4f0eabc6d891dfa08afc\\",\\n \\"CreatedTime\\": \\"2019-01-29T09:33:01Z\\"\\n}","type":"json"}]', + ], + 'DeleteUserWhiteListByType' => [ + 'summary' => '根据type、uid以及entityId(如果有)删除白名单中的用户', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Uid', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], +]; diff --git a/data/en_us/cloudapi/2016-07-01/api-docs.php b/data/en_us/cloudapi/2016-07-01/api-docs.php new file mode 100644 index 0000000..9fb1948 --- /dev/null +++ b/data/en_us/cloudapi/2016-07-01/api-docs.php @@ -0,0 +1,1700 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CloudAPI', + 'version' => '2016-07-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateLogConfig', + 'DeleteIpControl', + 'DeleteLogConfig', + 'DeleteTrafficControl', + 'DescribeApiIpControls', + 'DescribeApis', + 'DescribeApisForConsole', + 'DescribeApps', + 'DescribeAppsForProvider', + 'DescribeDeployedApis', + 'DescribeRegions', + 'DescribeSystemParameters', + 'DescribeSystemParams', + 'ExportSwagger', + 'ModifyLogConfig', + 'VpcDescribeAccesses', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateLogConfig' => [ + 'summary' => '创建日志配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94659', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SlsLogStore', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteIpControl' => [ + 'summary' => '删除IP控制', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94673', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIDGJ9', + ], + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteLogConfig' => [ + 'summary' => '删除日志配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94674', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + 'parameters' => [ + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DeleteTrafficControl' => [ + 'summary' => '删除流控策略', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94678', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApiIpControls' => [ + 'summary' => '查询API的IP访问控制', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94691', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiIpControls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiIpControlItem' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BoundTime' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'IpControlId' => [ + 'type' => 'string', + ], + 'IpControlName' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApis' => [ + 'summary' => '查询API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94695', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApisForConsole' => [ + 'summary' => '查询API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94700', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'DeployedInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StageName' => [ + 'type' => 'string', + ], + 'EffectiveVersion' => [ + 'type' => 'string', + ], + 'DeployedStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeApps' => [ + 'summary' => '查询APP列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94704', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + 'required' => true, + ], + 'Value' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Apps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'App' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'AppId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeAppsForProvider' => [ + 'summary' => '查询APP列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94708', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'AppOwnerId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Apps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'App' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'AppId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeDeployedApis' => [ + 'summary' => '查询发布的API列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94712', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeRegions' => [ + 'summary' => '查询地域列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '94732', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'type' => 'string', + ], + 'LocalName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSystemParameters' => [ + 'summary' => '查询系统参数列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94735', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParamName' => [ + 'type' => 'string', + ], + 'ParamType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSystemParams' => [ + 'summary' => '查询系统参数', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94736', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SystemParams' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParamName' => [ + 'type' => 'string', + ], + 'ParamType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ExportSwagger' => [ + 'summary' => '导出swagger', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '94739', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayY6W7D1', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataFormat', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyLogConfig' => [ + 'summary' => '修改日志配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94752', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SlsLogStore', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'VpcDescribeAccesses' => [ + 'summary' => '查询vpc授权', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94786', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstancePort', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'VpcAccessAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VpcAccessAttribute' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'VpcId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + ], + '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', + ], + ], +]; diff --git a/data/en_us/cloudapi/2016-07-14/api-docs.php b/data/en_us/cloudapi/2016-07-14/api-docs.php new file mode 100644 index 0000000..5465f72 --- /dev/null +++ b/data/en_us/cloudapi/2016-07-14/api-docs.php @@ -0,0 +1,31366 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CloudAPI', + 'version' => '2016-07-14', + ], + 'directories' => [ + [ + 'id' => 198578, + 'title' => 'Intranet domain name resolution', + 'type' => 'directory', + 'children' => [ + 'DissociateInstanceWithPrivateDNS', + 'DeletePrivateDNS', + 'AssociateInstanceWithPrivateDNS', + 'CreatePrivateDNS', + 'ListPrivateDNS', + 'UpdatePrivateDNS', + ], + ], + [ + 'id' => 141706, + 'title' => 'Instances', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceVpcAttributeForConsole', + 'CreateInstance', + 'DeleteInstance', + 'ModifyInstanceAttribute', + 'ModifyInstanceSpec', + 'EnableInstanceAccessControl', + 'DisableInstanceAccessControl', + 'DescribeInstances', + ], + ], + [ + 'id' => 141711, + 'title' => 'API groups', + 'type' => 'directory', + 'children' => [ + 'ModifyIntranetDomainPolicy', + 'CreateApiGroup', + 'DeleteApiGroup', + 'ModifyApiGroup', + 'DescribeApiGroup', + 'DescribeApiGroups', + 'DescribePurchasedApiGroup', + 'DescribePurchasedApiGroups', + ], + ], + [ + 'id' => 141719, + 'title' => 'Domains', + 'type' => 'directory', + 'children' => [ + 'DeleteDomain', + 'DeleteDomainCertificate', + 'SetDomain', + 'SetDomainCertificate', + 'SetDomainWebSocketStatus', + 'SetWildcardDomainPatterns', + 'DescribeDomain', + 'ReactivateDomain', + ], + ], + [ + 'id' => 141728, + 'title' => 'Monitor', + 'type' => 'directory', + 'children' => [ + 'CreateMonitorGroup', + 'DeleteMonitorGroup', + 'DescribeApiLatencyData', + 'DescribeApiQpsData', + 'DescribeApiTrafficControls', + 'DescribeApiTrafficData', + 'DescribeInstanceDropPacket', + 'DescribeInstanceDropConnections', + 'DescribeInstanceHttpCode', + 'DescribeInstanceLatency', + 'DescribeInstanceNewConnections', + 'DescribeInstancePackets', + 'DescribeInstanceQps', + 'DescribeInstanceSlbConnect', + 'DescribeInstanceTraffic', + 'DescribeGroupQps', + ], + ], + [ + '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', + ], + ], + [ + 'id' => 141764, + 'title' => 'Applications', + 'type' => 'directory', + 'children' => [ + 'CreateApp', + 'DeleteApp', + 'ModifyApp', + 'DescribeApps', + 'DescribeAppAttributes', + 'DescribeAuthorizedApps', + 'DescribeApp', + 'DescribeAppSecurity', + 'ResetAppCode', + ], + ], + [ + 'id' => 141774, + 'title' => 'VPC', + 'type' => 'directory', + 'children' => [ + 'RemoveVpcAccess', + 'RemoveVpcAccessAndAbolishApis', + 'ModifyVpcAccessAndUpdateApis', + 'ModifyApiGroupVpcWhitelist', + 'SetVpcAccess', + 'DescribeApiGroupVpcWhitelist', + 'DescribeVpcAccesses', + 'DescribeUpdateVpcInfoTask', + 'ValidateVpcConnectivity', + ], + ], + [ + 'id' => 168793, + 'title' => 'Access control', + 'type' => 'directory', + 'children' => [ + 'CreateAccessControlList', + 'DeleteAccessControlList', + 'SetAccessControlListAttribute', + 'AddAccessControlListEntry', + 'RemoveAccessControlListEntry', + 'DescribeAccessControlListAttribute', + 'DescribeAccessControlLists', + ], + ], + [ + 'id' => 141782, + 'title' => 'Plugins', + 'type' => 'directory', + 'children' => [ + 'DetachGroupPlugin', + 'AttachGroupPlugin', + 'DescribePluginsByGroup', + 'DescribePluginGroups', + 'CreatePlugin', + 'DeletePlugin', + 'AttachPlugin', + 'ModifyPlugin', + 'DetachPlugin', + 'DescribePluginApis', + 'DescribePluginsByApi', + 'DescribePluginSchemas', + 'DescribePluginTemplates', + 'DescribePlugins', + ], + ], + [ + 'id' => 172506, + 'title' => 'Custom datasets', + 'type' => 'directory', + 'children' => [ + 'CreateDataset', + 'CreateDatasetItem', + 'DeleteDataset', + 'DeleteDatasetItem', + 'ModifyDataset', + 'ModifyDatasetItem', + 'DescribeDatasetInfo', + 'DescribeDatasetList', + 'DescribeDatasetItemInfo', + 'DescribeDatasetItemList', + ], + ], + [ + 'id' => 141804, + 'title' => 'Models', + 'type' => 'directory', + 'children' => [ + 'CreateModel', + 'DeleteModel', + 'ModifyModel', + 'DescribeModels', + ], + ], + [ + 'id' => 141809, + 'title' => 'Authorization', + 'type' => 'directory', + 'children' => [ + 'SetApisAuthorities', + 'SetAppsAuthorities', + 'RemoveApisAuthorities', + 'RemoveAppsAuthorities', + 'ResetAppSecret', + ], + ], + [ + 'id' => 141815, + 'title' => 'Tags', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 141819, + 'title' => 'Service', + 'type' => 'directory', + 'children' => [ + 'DescribeSummaryData', + 'DescribeRegions', + 'DescribeSystemParameters', + 'DescribeZones', + 'OpenApiGatewayService', + ], + ], + [ + 'id' => 141824, + 'title' => 'Logs', + 'type' => 'directory', + 'children' => [ + 'CreateLogConfig', + 'DeleteLogConfig', + 'ModifyLogConfig', + 'QueryRequestLogs', + 'DescribeLogConfig', + ], + ], + [ + 'id' => 141841, + 'title' => 'SDK', + 'type' => 'directory', + 'children' => [ + 'SdkGenerateByAppForRegion', + 'SdkGenerateByApp', + 'SdkGenerateByGroup', + ], + ], + [ + 'id' => 141854, + 'title' => 'Backends', + 'type' => 'directory', + 'children' => [ + 'CreateBackend', + 'DeleteBackend', + 'ModifyBackend', + 'DescribeBackendList', + 'DescribeBackendInfo', + 'DescribeUpdateBackendTask', + ], + ], + [ + 'id' => 141861, + 'title' => 'Backend models', + 'type' => 'directory', + 'children' => [ + 'CreateBackendModel', + 'DeleteBackendModel', + 'ModifyBackendModel', + ], + ], + [ + 'id' => 141844, + 'title' => 'Signature plugin(Classic network instances)', + 'type' => 'directory', + 'children' => [ + 'CreateSignature', + 'DeleteSignature', + 'ModifySignature', + 'SetSignatureApis', + 'DescribeSignatures', + 'DescribeApisBySignature', + 'DescribeApiSignatures', + 'DescribeSignaturesByApi', + 'RemoveSignatureApis', + ], + ], + [ + 'id' => 141829, + 'title' => 'Traffic control plugin(Classic network instances)', + 'type' => 'directory', + 'children' => [ + 'AddTrafficSpecialControl', + 'CreateTrafficControl', + 'DeleteAllTrafficSpecialControl', + 'DeleteTrafficControl', + 'DeleteTrafficSpecialControl', + 'ModifyTrafficControl', + 'SetTrafficControlApis', + 'DescribeTrafficControls', + 'DescribeTrafficControlsByApi', + 'DescribeApisByTrafficControl', + 'RemoveTrafficControlApis', + ], + ], + [ + 'id' => 141791, + 'title' => 'Access control plugin(Classic network instances)', + 'type' => 'directory', + 'children' => [ + 'AddIpControlPolicyItem', + 'CreateIpControl', + 'DeleteIpControl', + 'ModifyIpControl', + 'ModifyIpControlPolicyItem', + 'SetIpControlApis', + 'DescribeApiIpControls', + 'DescribeIpControlPolicyItems', + 'DescribeIpControls', + 'DescribeApisByIpControl', + 'RemoveIpControlApis', + 'RemoveIpControlPolicyItem', + ], + ], + [ + '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', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DissociateInstanceWithPrivateDNS' => [ + 'summary' => 'Disassociates an internal domain name resolution from a dedicated instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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', + ], + ], + [ + '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', + ], + 'required' => true, + 'minItems' => 1, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'api.demo.com', + ], + ], + [ + 'name' => 'Type', + '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' => true, + 'enumValueTitles' => [ + 'A' => 'A', + 'VPC' => 'VPC', + ], + 'example' => 'A', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\"\\n}","type":"json"}]', + 'title' => 'DeletePrivateDNS', + ], + 'AssociateInstanceWithPrivateDNS' => [ + 'summary' => 'Associates an internal domain name resolution with a dedicated instance.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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", + ], + ], + [ + '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', + ], + 'required' => true, + 'minItems' => 1, + ], + ], + ], + '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' => '03442A3D-3B7D-434C-8A95-A5FEB999B529', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'api.demo.com', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + '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", + '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', + ], + 'Weight' => [ + 'description' => 'The weight of the record.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + 'required' => false, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215588', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + 'parameters' => [ + [ + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'api.demo.com', + ], + ], + [ + 'name' => 'Type', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + ], + ], + ], + '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-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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'IntranetDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The internal domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'api.demo.com', + ], + ], + [ + 'name' => 'Type', + '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' => 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", + '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', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94442', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayAQG9N5', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'apigateway-bj-f28baxxxxb51', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-8vbnnd66xxxx2xb5oig4f', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '505959c38776d9324945dbff709582', + ], + ], + [ + 'name' => 'VpcOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account to which the VPC belongs.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1121011712128923', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bj9e2i8w3wz7shkvnuj9a', + ], + ], + [ + 'name' => 'DeleteVpcAccess', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D08741CF-BE59-5DA6-B06F-BB65173110C0', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ChargeType', + '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', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance Name', + 'type' => 'string', + 'required' => true, + 'example' => 'ApigatewayInstance', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance specifications', + 'type' => 'string', + 'required' => true, + 'example' => 'api.s1.small', + ], + ], + [ + 'name' => 'ZoneId', + '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)', + ], + ], + [ + 'name' => 'HttpsPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTPS policy.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'HTTPS2_TLS1_2', + ], + ], + [ + 'name' => 'Duration', + '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', + ], + ], + [ + 'name' => 'PricingCycle', + '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', + ], + ], + [ + 'name' => 'AutoPay', + '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', + ], + ], + [ + 'name' => 'Token', + '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', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + [ + 'name' => 'InstanceType', + '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', + ], + ], + [ + 'name' => 'InstanceCidr', + '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", + ], + ], + [ + 'name' => 'UserVpcId', + '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", + ], + ], + [ + 'name' => 'ZoneVSwitchSecurityGroup', + '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", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94291', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayAQG9N5', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'apigateway-sh-ae502ee79ef8', + ], + ], + [ + 'name' => 'Tag', + '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", + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94438', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'If enable outbound IPv6 Traffic.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'VpcSlbIntranetEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the self-calling domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', + ], + ], + [ + 'name' => 'IntranetSegments', + 'in' => 'query', + 'schema' => [ + 'description' => 'Custom private CIDR block.', + 'type' => 'string', + 'required' => false, + 'example' => '172.0.0.1/24', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maintainable start time.', + 'type' => 'string', + 'required' => false, + 'example' => '18:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maintainable end time.', + 'type' => 'string', + 'required' => false, + 'example' => '23:00Z', + ], + ], + [ + 'name' => 'ToConnectVpcIpBlock', + 'in' => 'query', + 'style' => 'json', + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DeleteVpcIpBlock', + 'in' => 'query', + 'schema' => [ + 'description' => 'If delete VPC Ip block.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3186326-2C57-58E1-B6E9-XXXXXXXXXXXX\\"\\n}","type":"json"}]', + 'title' => 'ModifyInstanceAttribute', + ], + 'ModifyInstanceSpec' => [ + 'summary' => 'Upgrades or downgrades the configurations of an API Gateway instance.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94441', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayAQG9N5', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-v6419k43xxxxx', + ], + ], + [ + 'name' => 'InstanceSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The specifications of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'api.s1.small', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + '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', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'b5845042-2f2f-4e96-bd5c-36c6e5c2a68c', + ], + ], + [ + 'name' => 'ModifyAction', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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 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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ACL type. Valid values:'."\n" + ."\n" + .'* black: blacklist'."\n" + .'* white: whitelist'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'black', + ], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version. Valid values: **ipv4** and **ipv6**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ipv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acl-grgqc0mnuhkqciwtam', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'apigateway-cn-v6419k43xxxxx', + ], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP version. Valid values: **ipv4** and **ipv6**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ipv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94370', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayAQG9N5', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. If you do not specify this parameter, all instances are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'api-shared-vpc-001', + ], + ], + [ + 'name' => 'Language', + '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', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'VPC_SHARED', + 'VPC_DEDICATED', + ], + ], + ], + [ + 'name' => 'EnableTagAuthorization', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether tag authorization is enabled.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag that is bound to the instance.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEB6EC62-B6C7-5082-A45A-45A204724AC2\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"InstanceAttribute\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"VpcSlbIntranetEnable\\": true,\\n \\"ClassicEgressAddress\\": \\"10.0.0.1\\",\\n \\"ZoneLocalName\\": \\"多可用区 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '192821', + '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' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + 'name' => 'VpcIntranetEnable', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","type":"json"}]', + 'title' => 'ModifyIntranetDomainPolicy', + ], + 'CreateApiGroup' => [ + 'summary' => 'Creates an API group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94264', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Weather', + ], + ], + [ + 'name' => 'BasePath', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '/qqq', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + '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' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94431', + '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' => '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The root path of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/eeee', + ], + ], + [ + 'name' => 'Description', + '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.', + ], + ], + [ + 'name' => 'UserLogConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user log configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"requestBody\\":false,\\"responseBody\\":false,\\"queryString\\":\\"\\",\\"requestHeaders\\":\\"\\",\\"responseHeaders\\":\\"\\",\\"jwtClaims\\":\\"\\"}', + ], + ], + [ + 'name' => 'CustomTraceConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom trace configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"parameterLocation\\":\\"HEADER\\",\\"parameterName\\":\\"traceId\\"}', + ], + ], + [ + 'name' => 'CompatibleFlags', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of associated tags. Separate multiple tags with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'depart:dep1', + ], + ], + [ + 'name' => 'CustomerConfigs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data of custom configuration items.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'removeResponseServerHeader', + ], + ], + [ + 'name' => 'PassthroughHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to pass headers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eagleeye-rpcid,x-b3-traceid,host', + ], + ], + [ + 'name' => 'DefaultDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default domain name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mkt.api.gaore.com', + ], + ], + [ + 'name' => 'RpcPattern', + 'in' => 'query', + 'schema' => [ + 'description' => 'The RPC mode.', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + 'example' => 'Key, Value', + ], + ], + [ + 'name' => 'SupportSSE', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'If support SSE.', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FilterAppCodeForBackend', + 'in' => 'query', + 'schema' => [ + 'description' => 'If filter AppCode for backend.', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CustomAppCodeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom appcode configuration.', + 'type' => 'string', + 'required' => false, + 'example' => '{"location":"HEADER","name":"myAppCodeHeader"}', + ], + ], + [ + 'name' => 'RpsLimitForServerless', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94311', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The object tags that match the lifecycle rule. You can specify multiple tags.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + '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"}', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"NORMAL\\",\\n \\"CompatibleFlags\\": \\"depart:dep1\\",\\n \\"BasePath\\": \\"/qqq\\",\\n \\"Ipv6Status\\": \\"UNBIND\\",\\n \\"UserLogConfig\\": \\"{\\\\\\\\\\\\\\"requestBody\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"responseBody\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"queryString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"requestHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"responseHeaders\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"jwtClaims\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"CustomerConfigs\\": \\"removeResponseServerHeader\\",\\n \\"RequestId\\": \\"03442A3D-3B7D-434C-8A95-A5FEB989B519\\",\\n \\"Description\\": \\"New weather informations.\\",\\n \\"HttpsPolicy\\": \\"HTTPS2_TLS1_0\\",\\n \\"SubDomain\\": \\"27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com\\",\\n \\"CreatedTime\\": \\"2016-08-01T06:53:02Z\\",\\n \\"DefaultDomain\\": \\"mkt.api.gaore.com\\",\\n \\"CmsMonitorGroup\\": \\"217008423\\",\\n \\"BillingStatus\\": \\"NORMAL\\",\\n \\"TrafficLimit\\": 500,\\n \\"PassthroughHeaders\\": \\"eagleeye-rpcid,x-b3-traceid\\",\\n \\"InstanceId\\": \\"apigateway-cn-v6419k43xxxxx\\",\\n \\"VpcDomain\\": \\"e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com\\",\\n \\"InstanceType\\": \\"VPC_SHARED\\",\\n \\"CustomTraceConfig\\": \\"{\\\\\\\\\\\\\\"parameterLocation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HEADER\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parameterName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\"}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ModifiedTime\\": \\"2016-08-01T06:54:32Z\\",\\n \\"GroupId\\": \\"523e8dc7bbe04613b5b1d726c2a7889d\\",\\n \\"GroupName\\": \\"NewWeather\\",\\n \\"IllegalStatus\\": \\"NORMAL\\",\\n \\"VpcSlbIntranetDomain\\": \\"257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com\\",\\n \\"CustomDomains\\": {\\n \\"DomainItem\\": [\\n {\\n \\"BindStageName\\": \\"TEST\\",\\n \\"DomainLegalStatus\\": \\"ABNORMAL\\",\\n \\"CertificateName\\": \\"myCertificate\\",\\n \\"CustomDomainType\\": \\"intranet\\",\\n \\"DomainCNAMEStatus\\": \\"RESOLVED\\",\\n \\"WildcardDomainPatterns\\": \\"[\\\\\\\\\\\\\\"{test}.test.com\\\\\\\\\\\\\\"]\\",\\n \\"DomainBindingStatus\\": \\"BINDING\\",\\n \\"DomainName\\": \\"api.demo.com\\",\\n \\"DomainRemark\\": \\"该域名未备案\\",\\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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApiGroups' => [ + 'summary' => 'Queries existing API groups and their basic information.', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable tag verification.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'apigateway-cn-v6419k43245xx', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of 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 value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + 'description' => '', + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePurchasedApiGroup' => [ + 'summary' => 'Queries the details about an API group purchased from Alibaba Cloud Marketplace.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94387', + '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, + 'example' => '102b631ae1094e33a77c45312226184e', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94388', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + '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' => '20', + ], + ], + ], + 'responses' => [ + 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' => '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94289', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + '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", + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94290', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + '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' => 'CertificateId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94479', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'IsForce', + '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', + ], + ], + [ + 'name' => 'IsHttpRedirectToHttps', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to redirect HTTP requests to HTTPS requests.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94480', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + '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', + '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", + ], + ], + [ + 'name' => 'CaCertificateBody', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the CA certificate.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Content of the CA certificate'."\n", + ], + ], + [ + 'name' => 'SslVerifyDepth', + 'in' => 'query', + 'schema' => [ + 'description' => 'The certificate verification depth.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'SslOcspEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'If enable ssl OCSP.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'SslOcspCacheEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'If enable ssl OCSP cache.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94481', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'If enable WSS.', + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94488', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The wildcard domain name mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[\\"{svc}.prd.e-eir.com\\"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94353', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94457', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayJWZLU8', + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94276', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '42925e7f5209438186d5560239af5286', + ], + ], + [ + 'name' => 'RawMonitorGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the monitoring group.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '166636221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C7E2CBAA-47FF-569F-AF12-B14B80E25422', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94318', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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" + ."\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94320', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94333', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + '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', + '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', + ], + ], + [ + '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' => '20', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94334', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94364', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-v641b9dxc00p', + ], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'* Maximum'."\n" + .'* Minimum'."\n" + .'* Average'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94363', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'* Maximum'."\n" + .'* Minimum'."\n" + .'* Average'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94365', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-m7r227yy2004', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94366', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-v641jf5tt01v', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94367', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-2r426lavr001', + ], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'* Maximum'."\n" + .'* Minimum'."\n" + .'* Average'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94368', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + ], + ], + [ + 'name' => 'SbcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'* Maximum'."\n" + .'* Minimum'."\n" + .'* Average'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94369', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-bj-6c219f1fd5d4', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94371', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The statistical metric. Valid values:'."\n" + ."\n" + .'* Maximum'."\n" + .'* Minimum'."\n" + .'* Average'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94372', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + [ + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-cn-2r426lavr001', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94359', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '264c60db9f764345a13ac5c825b229b9', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable backend services.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of 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' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateApiStageVariable' => [ + 'summary' => 'Adds a variable to an environment.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94265', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayN14L0I', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the runtime environment.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', + ], + ], + [ + 'name' => 'VariableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the variable to be added. This parameter is case-sensitive.'."\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', + ], + ], + [ + 'name' => 'StageRouteModel', + '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" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03442A3D-3B7D-434C-8A95-A5FEB999B529', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pre-inspection.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16 ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ017', + ], + ], + 'description' => '', + ], + ], + ], + '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" + .'* The QPS limit on this operation is 50 per user.'."\n", + ], + 'DeleteApiStageVariable' => [ + 'summary' => 'Deletes a specified variable in a specified environment.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94286', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayN14L0I', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the environment.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6EF60BEC-0242-43AF-BB20-270359FB54A7', + ], + ], + [ + 'name' => 'VariableName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '03442A3D-3B7D-434C-8A95-A5FEB969B529', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + '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', + ], + ], + [ + '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~~).'."\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"}]', + ], + ], + [ + '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~~).'."\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"}]', + ], + ], + [ + '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~~).'."\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"}]', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'JSON', + ], + ], + [ + '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}', + ], + ], + [ + '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"}', + ], + ], + [ + '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"}]', + ], + ], + [ + '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" + .'* FALSE: uses the information about the custom backend service.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'TRUE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration Mode', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '6C87A26A-6A18-4B8E-8099-705278381A2C', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118586', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backend service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '4ac69b7a17524781b275ed4c5eb25c54', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'description' => 'The information about the returned API list.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94305', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8afff6c8c4c6447abb035812e4d66b65', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'BackendConfig' => [ + 'description' => 'Backend configurations'."\n", + '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', + ], + ], + ], + 'RequestConfig' => [ + 'description' => 'The configuration items of API requests sent by the consumer to API Gateway.'."\n", + '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', + ], + ], + ], + 'ServiceConfig' => [ + 'description' => 'The configuration items of API requests that API Gateway sends to the backend service.'."\n", + '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', + ], + '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.'."\n", + 'type' => 'string', + 'example' => '86400', + ], + 'HeaderName' => [ + 'description' => 'The HTTP header.'."\n", + 'type' => 'string', + 'example' => 'Content-Length', + ], + ], + '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***', + ], + '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', + ], + ], + ], + '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://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', + ], + ], + ], + 'OssConfig' => [ + 'description' => 'The information returned when the backend service is Object Storage Service (OSS).'."\n", + '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', + ], + ], + ], + 'EventBridgeConfig' => [ + 'description' => 'Configuration items of EventBridge'."\n", + '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', + ], + ], + ], + ], + ], + 'OpenIdConnectConfig' => [ + 'description' => 'Configuration items of the third-party OpenID Connect authentication method'."\n", + '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', + ], + ], + ], + 'ErrorCodeSamples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorCodeSample' => [ + 'description' => 'The sample error codes returned by the backend service.'."\n", + '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", + ], + ], + 'description' => '', + ], + ], + ], + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'description' => 'System parameters sent by API Gateway to the backend service'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'CustomSystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomSystemParameter' => [ + 'description' => 'Custom system parameters'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'ConstantParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConstantParameter' => [ + 'description' => 'System parameters sent by API Gateway to the backend service'."\n", + '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' => '', + ], + ], + ], + ], + 'RequestParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParameter' => [ + 'description' => 'The parameters of API requests sent by the consumer to API Gateway.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'ServiceParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServiceParameter' => [ + 'description' => 'The parameters of API requests sent by API Gateway to the backend service.'."\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 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', + ], + ], + 'description' => '', + ], + ], + ], + ], + '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", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'DeployedInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedInfo' => [ + 'description' => 'The API publishing status.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'TagList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'Tag List.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'Label key.', + 'type' => 'string', + 'example' => 'APP', + ], + 'TagValue' => [ + 'description' => 'Label value.', + 'type' => 'string', + 'example' => 'value3', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"8afff6c8c4c6447abb035812e4d66b65\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"WebSocketApiType\\": \\"COMMON\\",\\n \\"DisableInternet\\": false,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"200\\",\\n \\"AppCodeAuthType\\": \\"HEADER\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"400\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"ModifiedTime\\": \\"2016-07-28T13:13:12Z\\",\\n \\"RequestId\\": \\"D0FF585F-7966-40CF-BC60-75DB070B23D5<\\",\\n \\"Description\\": \\"Api description\\",\\n \\"GroupName\\": \\"ApiTest\\",\\n \\"GroupId\\": \\"08ae4aa0f95e4321849ee57f4e0b3077\\",\\n \\"Mock\\": \\"CLOSED\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"CreatedTime\\": \\"2016-07-28T09:50:43Z\\",\\n \\"ApiName\\": \\"ApiName\\",\\n \\"BackendEnable\\": true,\\n \\"BackendConfig\\": {\\n \\"BackendId\\": \\"0038e00c3dca44fcba3a94015d8f5bbf\\",\\n \\"BackendType\\": \\"HTTP\\",\\n \\"BackendName\\": \\"testoss\\"\\n },\\n \\"RequestConfig\\": {\\n \\"BodyModel\\": \\"https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab\\",\\n \\"RequestPath\\": \\"/api/billing/test/[type]\\",\\n \\"RequestHttpMethod\\": \\"POST\\",\\n \\"BodyFormat\\": \\"STREAM\\",\\n \\"RequestMode\\": \\"MAPPING\\",\\n \\"PostBodyDescription\\": \\"fwefwef\\",\\n \\"RequestProtocol\\": \\"HTTP\\",\\n \\"EscapePathParam\\": true\\n },\\n \\"ServiceConfig\\": {\\n \\"AoneAppName\\": \\"ib-blank\\",\\n \\"MockStatusCode\\": 200,\\n \\"ContentTypeValue\\": \\"application/x-www-form-urlencoded; charset=UTF-8\\",\\n \\"ServiceProtocol\\": \\"HTTP\\",\\n \\"ServicePath\\": \\"/object/add\\",\\n \\"ContentTypeCatagory\\": \\"CUSTOM\\",\\n \\"ServiceAddress\\": \\"http://api.a.com:8080\\",\\n \\"Mock\\": \\"TRUE\\",\\n \\"ServiceVpcEnable\\": \\"TRUE\\",\\n \\"MockResult\\": \\"test result\\",\\n \\"ServiceHttpMethod\\": \\"POST\\",\\n \\"ServiceTimeout\\": 1000,\\n \\"MockHeaders\\": {\\n \\"MockHeader\\": [\\n {\\n \\"HeaderValue\\": \\"86400\\",\\n \\"HeaderName\\": \\"Content-Length\\"\\n }\\n ]\\n },\\n \\"VpcConfig\\": {\\n \\"VpcId\\": \\"vpc-2zeafsc3fygk1***\\",\\n \\"VpcScheme\\": \\"HTTP\\",\\n \\"InstanceId\\": \\"i-bp1h497hkijewv2***\\",\\n \\"Port\\": 8080,\\n \\"Name\\": \\"glmall-app-test\\"\\n },\\n \\"FunctionComputeConfig\\": {\\n \\"FcType\\": \\"HttpTrigger\\",\\n \\"RoleArn\\": \\"acs:ram::111***:role/aliyunserviceroleforsas\\",\\n \\"Method\\": \\"GET\\",\\n \\"FcBaseUrl\\": \\"https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/\\",\\n \\"ContentTypeValue\\": \\"application/x-www-form-urlencoded; charset=UTF-8\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"OnlyBusinessPath\\": false,\\n \\"FunctionName\\": \\"edge_function\\",\\n \\"ContentTypeCatagory\\": \\"DEFAULT\\",\\n \\"Path\\": \\"/api/offline/cacheData\\",\\n \\"ServiceName\\": \\"fcservicename\\",\\n \\"Qualifier\\": \\"2\\",\\n \\"TriggerName\\": \\"\\",\\n \\"FcVersion\\": \\"\\"\\n },\\n \\"OssConfig\\": {\\n \\"Key\\": \\"/folder/test.json\\",\\n \\"Action\\": \\"GetObject\\",\\n \\"OssRegionId\\": \\"cn-hangzhou\\",\\n \\"BucketName\\": \\"cbg-db\\"\\n },\\n \\"EventBridgeConfig\\": {\\n \\"EventBus\\": \\"testBus\\",\\n \\"EventSource\\": \\"baas_driver\\",\\n \\"EventBridgeRegionId\\": \\"cn-beijing\\",\\n \\"RoleArn\\": \\"acs:ram::1933122015759***:role/adminoidcaliyun\\"\\n }\\n },\\n \\"OpenIdConnectConfig\\": {\\n \\"OpenIdApiType\\": \\"IDTOKEN\\",\\n \\"IdTokenParamName\\": \\"xxx\\",\\n \\"PublicKeyId\\": \\"88483727556929326703309904351185815489\\",\\n \\"PublicKey\\": \\"EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92\\"\\n },\\n \\"ErrorCodeSamples\\": {\\n \\"ErrorCodeSample\\": [\\n {\\n \\"Code\\": \\"400\\",\\n \\"Model\\": \\"[\\\\\\\\\\\\\\"*\\\\\\\\\\\\\\"]\\",\\n \\"Message\\": \\"Missing the parameter UserId\\",\\n \\"Description\\": \\"请求缺少参数 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"}]', + 'title' => 'DescribeApi', + 'description' => '* This operation is intended for API providers.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApiMarketAttributes' => [ + 'summary' => 'Queries the Alibaba Cloud Marketplace attributes of an API.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94319', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b693252f3f19445e9a01dac177c4454c', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1f9b5e9ba80943099cac52e040b7e160', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'MarketChargingMode' => [ + 'description' => 'The billing method used by the Alibaba Cloud Marketplace.'."\n", + 'type' => 'string', + 'example' => 'PREPAID_BY_USAGE', + ], + 'NeedCharging' => [ + 'description' => 'Indicates whether fees are charged.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c4a4d2de657548a2bd485d5d4df42b4a', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f68c19ee3bd1478fb58aa05ce8ae9b5a', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API name. The name is used for fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'weather', + ], + ], + [ + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1553414085247362', + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable tag verification.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags of objects that match the rule.'."\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', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 50, + ], + ], + [ + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiSummary' => [ + 'description' => 'The queried API definitions.'."\n", + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'The tags that are added to the APIs.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 3,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\",\\n \\"PageSize\\": 15,\\n \\"TotalCount\\": 32,\\n \\"ApiSummarys\\": {\\n \\"ApiSummary\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"ModifiedTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Description\\": \\"创建对象接口\\",\\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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApiHistory' => [ + 'summary' => 'Queries the details of a specified historical version of a specified API definition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94316', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dc6e17ee3120404c839bbcd7622ab6ed', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the version number that you want to query.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20211122155403834', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'BackendConfig' => [ + 'description' => 'Backend configurations'."\n", + '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', + ], + ], + ], + 'RequestConfig' => [ + 'description' => 'The 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/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', + ], + ], + ], + 'ServiceConfig' => [ + 'description' => 'The information about a backend service call.'."\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', + ], + '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', + ], + 'MockHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MockHeader' => [ + 'description' => 'The simulated Headers.'."\n", + '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', + ], + ], + '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***', + ], + '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', + ], + ], + ], + '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/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', + ], + ], + ], + 'OssConfig' => [ + 'description' => 'Information when the backend service is OSS'."\n", + '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', + ], + ], + ], + 'EventBridgeConfig' => [ + 'description' => 'Configuration items of EventBridge'."\n", + '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', + ], + ], + ], + ], + ], + '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 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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'ResultDescriptions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResultDescription' => [ + 'description' => 'The return description of the API.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'description' => 'The common parameters of the APIs, in JSON format.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'CustomSystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomSystemParameter' => [ + 'description' => 'The custom system parameters.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'ConstantParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConstantParameter' => [ + 'description' => 'The constant parameters.'."\n", + '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' => '', + ], + ], + ], + ], + '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' => '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', + ], + ], + '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 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', + ], + ], + 'description' => '', + ], + ], + ], + ], + '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~~).'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"200\\",\\n \\"ApiId\\": \\"bebf996e4b3d445d83078094b72b0d91\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"WebSocketApiType\\": \\"COMMON\\",\\n \\"DisableInternet\\": true,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"status\\\\\\\\\\\\\\": 0,\\\\\\\\n \\\\\\\\\\\\\\"data\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 1,\\\\\\\\n \\\\\\\\\\\\\\"list\\\\\\\\\\\\\\": [\\\\\\\\n \\\\\\\\\\\\\\"352\\\\\\\\\\\\\\"\\\\\\\\n ]\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"success\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"AppCodeAuthType\\": \\"HEADER\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\",\\n \\"Description\\": \\"根据地区名称查询天气情况\\",\\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"}]', + 'title' => 'DescribeApiHistory', + 'description' => 'Queries the details of 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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94323', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP的ID', + 'description' => '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', + 'in' => 'query', + 'schema' => [ + 'title' => 'API的ID', + 'description' => 'The API ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b19240592b1b4e74961fb8438ed7550c', + ], + ], + [ + 'name' => 'ApiName', + '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', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'title' => 'API请求路径', + 'description' => 'The request path of the API.', + 'type' => 'string', + 'required' => false, + 'example' => '/tt', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'title' => 'API的请求HTTP Method', + 'description' => 'The request HTTP method of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppApiRelationInfo' => [ + 'description' => 'The API authorizations.'."\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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ015\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AppApiRelationInfos\\": {\\n \\"AppApiRelationInfo\\": [\\n {\\n \\"ApiId\\": \\"c625795a1e664782a918eaa629e96ab5\\",\\n \\"AuthorizationSource\\": \\"SELF\\",\\n \\"AuthVaildTime\\": \\"Sun, 02 Jan 2022 16:00:00 GMT\\",\\n \\"Description\\": \\"b1008kz\\",\\n \\"GroupName\\": \\"wb2022012101605749\\",\\n \\"GroupId\\": \\"38bed48d664149e4b9b5ea576319673f\\",\\n \\"Operator\\": \\"PROVIDER\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"StageAlias\\": \\"线上\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94342', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AuthorizedApi' => [ + 'description' => 'The authorized API set.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AuthorizedApis\\": {\\n \\"AuthorizedApi\\": [\\n {\\n \\"ApiId\\": \\"baacc592e63a4cb6a41920d9d3f91f38\\",\\n \\"AuthorizationSource\\": \\"CONSOLE\\",\\n \\"AuthVaildTime\\": \\"2018-10-05T16:00:00Z\\",\\n \\"Description\\": \\"根据地区名称查询天气情况\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94306', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3b81fd160f5645e097cc8855d75a1cf6', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParameter' => [ + 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned frontend input parameters in the API. It is an array consisting of RequestParameter data.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"b24be7e59a104e52bffbf432cc9272af\\",\\n \\"ResultType\\": \\"JSON\\",\\n \\"DisableInternet\\": true,\\n \\"ResultSample\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"status\\\\\\\\\\\\\\": 0,\\\\\\\\n \\\\\\\\\\\\\\"data\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"count\\\\\\\\\\\\\\": 1,\\\\\\\\n \\\\\\\\\\\\\\"list\\\\\\\\\\\\\\": [\\\\\\\\n \\\\\\\\\\\\\\"352\\\\\\\\\\\\\\"\\\\\\\\n ]\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"success\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"F253FB5F-9AE1-5DDA-99B5-46BE00A3719E\\",\\n \\"GroupId\\": \\"f51d08c5b7c84342905544ebaec26d35\\",\\n \\"GroupName\\": \\"会员时代交易服务\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94351', + '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' => false, + 'example' => '81750604ccff48c48f34d6c0165e09db', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ab7c95a01a7e42f28718f34497bbf47c', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiId\\": \\"4eed13a57d4e42fbb51316be8a5329ff\\",\\n \\"ResultType\\": \\"HTML\\",\\n \\"DisableInternet\\": true,\\n \\"ResultBodyModel\\": \\"{}\\",\\n \\"ResultSample\\": \\"{code: 200, message:\'success\', data: \'\'}\\",\\n \\"AllowSignatureMethod\\": \\"HmacSHA256\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ForceNonceCheck\\": true,\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"FailResultSample\\": \\"{\\\\\\"errorCode\\\\\\":\\\\\\"fail\\\\\\",\\\\\\"errorMessage\\\\\\":\\\\\\"param invalid\\\\\\"}\\",\\n \\"AuthType\\": \\"APP\\",\\n \\"RequestId\\": \\"EF924FE4-2EDD-4CD3-89EC-34E4708574E7\\",\\n \\"Description\\": \\"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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94362', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0ccb66aadb5345b78a40f57d192d8aa4', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a12068f555964ca8a0c9c33288f1e5a7', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the API. The name is used for fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'getPersonInfo', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the current page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 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' => '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', + ], + 'ApiHisItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiHisItem' => [ + 'description' => 'The returned API information. It is an array consisting of ApiHisItems.'."\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', + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"6C87A26A-6A18-4B8E-8099-705278381A2C\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiHisItems\\": {\\n \\"ApiHisItem\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"Description\\": \\"创建对象接口\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '155133', + 'abilityTreeNodes' => [ + 'FEATUREapigateway9WMX21', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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", + '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', + ], + ], + ], + ], + ], + ], + 'TaskStatus' => [ + 'description' => 'The status of the import task. Valid values:'."\n" + ."\n" + .'* Running'."\n" + .'* Finished'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\",\\n \\"ApiResults\\": {\\n \\"ApiResult\\": [\\n {\\n \\"ApiId\\": \\"c5a0c2900ff746b789c007545be22fb8\\",\\n \\"Path\\": \\"/creator/getByCreatorId\\",\\n \\"Method\\": \\"GET\\",\\n \\"Description\\": \\"这个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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3b81fd160f5645e097cc8855d75a1cf6', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Cz88IpQuery'."\n", + ], + ], + [ + 'name' => 'Visibility', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CE5722A6-AE78-4741-A9B0-6C817D360510\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"PurchasedApis\\": {\\n \\"PurchasedApi\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"PurchasedTime\\": \\"2021-06-11T13:57:38+08:00\\",\\n \\"ApiId\\": \\"eb6e54c1576d41149746e8e69b0a0792\\",\\n \\"ModifiedTime\\": \\"2021-06-11T13:57:38+08:00\\",\\n \\"Description\\": \\"test测试\\",\\n \\"GroupName\\": \\"DMS_DEFAULT_GROUP_408589\\",\\n \\"GroupId\\": \\"3013a55c0c44483f984d26df27120513\\",\\n \\"DeployedTime\\": \\"2021-06-1113:57:38\\",\\n \\"StageName\\": \\"TEST\\",\\n \\"ApiName\\": \\"gw_rado_tissot_\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribePurchasedApis', + ], + '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', + ], + ], + [ + '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 ', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c076144d7878437b8f82fb85890ce6a0', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + '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', + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 3,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ003\\",\\n \\"PageSize\\": 15,\\n \\"TotalCount\\": 32,\\n \\"ApiHisItems\\": {\\n \\"ApiHisItem\\": [\\n {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ApiId\\": \\"5af418828f0344a3b588c0cc1331a3bc\\",\\n \\"Description\\": \\"创建对象接口\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94352', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '63be9002440b4778a61122f14c2b2bbb', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c076144d7878437b8f82fb85890ce6a0', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable tag verification.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags.'."\n", + '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', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ApiPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request path of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/st4', + ], + ], + [ + 'name' => 'ApiMethod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The HTTP method of the API request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + ], + ], + 'responses' => [ + 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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedApiItem' => [ + 'description' => 'The returned API information. It is an array consisting of DeployedApiItem data.'."\n", + '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', + ], + 'ApiMethod' => [ + 'description' => 'The HTTP method of the API request.'."\n", + 'type' => 'string', + 'example' => 'POST', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ002\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"DeployedApis\\": {\\n \\"DeployedApiItem\\": [\\n {\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"c076144d7878437b8f82fb85890ce6a0\\",\\n \\"Description\\": \\"分页显示对象列表\\",\\n \\"GroupName\\": \\"myGroup3\\",\\n \\"GroupId\\": \\"63be9002440b4778a61122f14c2b2bbb\\",\\n \\"DeployedTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"StageName\\": \\"RELEASE\\",\\n \\"ApiName\\": \\"获取对象列表\\",\\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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMarketRemainsQuota' => [ + 'summary' => 'Queries the number of remaining ordered relationships for a purchaser.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94376', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom domain name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*.demo.com', + ], + ], + ], + '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' => '', + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94350', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '51524fb8f12846d694d0a1de9a0cf274', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CA4B3261-F14A-5E33-8608-F75A1DF27AD4', + ], + 'DeployedResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DeployedResult' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94303', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the unpublishing operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fc54****dd4c4***ad7edd7****39401', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', + ], + 'ApiAbolishResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiAbolishResult' => [ + 'description' => 'The result returned.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the specified API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', + ], + ], + [ + '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' => 'RELEASE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94302', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '63be9002440b4778a61122f14c2b2bbb', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd6f679aeb3be4b91b3688e887ca1fe16', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The publishing remarks.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'for_test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'StageName', + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Api', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OperationId\\": \\"f7834d74be4e41aa8e607b0fafae9b33\\",\\n \\"RequestId\\": \\"E7FE7172-AA75-5880-B6F7-C00893E9BC06\\"\\n}","type":"json"}]', + 'title' => 'BatchAbolishApis', + ], + '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', + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + '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', + ], + ], + [ + 'name' => 'Description', + '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', + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The historical version number of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20160705104552292', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ001', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '94422', + 'abilityTreeNodes' => [ + 'FEATUREapigateway9WMX21', + ], + ], + '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 condition.'."\n", + 'type' => 'object', + 'required' => false, + 'docRequired' => true, + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd633cf5524f841b9950e245b191bdabf', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'CreateApp' => [ + 'summary' => 'Creates an app for API Gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + [ + 'name' => 'Description', + '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', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'AppSecret', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nzyNqFkRWB2uLw86', + ], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AppCode of the application.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended information.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '110210264071', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteApp' => [ + 'summary' => 'Deletes a specified app.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94436', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + 'name' => 'Tag', + '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 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', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息', + 'type' => 'string', + 'required' => false, + 'example' => '110461946884', + ], + ], + [ + 'name' => 'Disabled', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + ], + 'description' => '', + ], + ], + ], + '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' => ' ', + ], + 'DescribeApps' => [ + 'summary' => 'Queries the apps of a user. App information is returned only to the app owner.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94337', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the app.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20112314518278', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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', + ], + 'Apps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppItem' => [ + 'description' => 'The returned app information. It is an array consisting of AppItem data.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAppAttributes' => [ + 'summary' => 'Queries apps and their basic information.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94336', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the app.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20112314518278', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the app.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testApp', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AppCode of the app.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23552160', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The app key that is used to make an API call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '203708622', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'EnableTagAuth', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable tag verification.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息', + 'type' => 'string', + 'required' => false, + 'example' => '110243810311', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AppAttribute' => [ + 'description' => 'The returned app information. It is an array that consists of AppAttribute data.'."\n", + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAuthorizedApps' => [ + 'summary' => 'Queries the current apps.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94343', + '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', + ], + ], + [ + 'name' => 'StageName', + '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' => false, + 'enumValueTitles' => [ + 'RELEASE' => 'RELEASE', + ], + 'example' => 'RELEASE', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the app.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20112314518278', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the app.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateApptest', + ], + ], + [ + 'name' => 'AppOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account of the app owner.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1546564', + ], + ], + ], + 'responses' => [ + 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' => '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', + ], + 'AuthorizedApps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AuthorizedApp' => [ + 'description' => 'The authorized applications.'."\n", + '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", + ], + 'Tag' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagInfo' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.', + 'type' => 'string', + 'example' => 'DEV', + ], + 'Value' => [ + 'description' => 'The tag value.', + 'type' => 'string', + 'example' => '240', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AuthorizedApps\\": {\\n \\"AuthorizedApp\\": [\\n {\\n \\"AppName\\": \\"天气\\",\\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":""}]', + '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', + ], + '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 ID of the app. The ID is generated by the system and globally unique.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '110843374', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + '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' => 'Tag', + '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' => true, + 'example' => 'app', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94471', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AppCode of the app.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + ], + ], + [ + 'name' => 'NewAppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new AppCode of the app.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6f0e7ab2aa5f4b8fb18421e6edf4fb6c2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94469', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-uf657qec7lx42paw3qxxx', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an ECS or SLB instance in the VPC.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number that corresponds to the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '80', + ], + ], + [ + 'name' => 'NeedBatchWork', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether batch work is required.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + 'Apis' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94470', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-bp1iw82phcgkvupgfv0o8', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf6iaale3gfef9t9cb41', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '8080', + ], + ], + [ + 'name' => 'NeedBatchWork', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OperationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'f7834d74be4e41aa8e607b0fafae9b33', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ016', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-m5e7jqfppv5wbvmdw5pg2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the new instance.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => ' '."\n" + .'i-uf6bzcg1pr4oh5jjmxxx'."\n", + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new port number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '80', + ], + ], + [ + 'name' => 'Name', + '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', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c20d86c4-1eb3-4d0b-afe9-c586df1e2136', + ], + ], + [ + '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.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'VpcTargetHostName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The hostname of the backend service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'iot.hu***ng.com', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94434', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9b80408147724ddab4c4e2703c6ca019', + ], + ], + [ + 'name' => 'VpcIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp11w979o2s9rcr962w25', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F8B9DC8C-D6E2-5065-BD1F-0401866E7F10', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94487', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the authorization. The name must be unique.', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an ECS or SLB instance in the VPC.', + 'type' => 'string', + 'required' => true, + 'example' => 'i-uf6bzcg1pr4oh5jjmxxx', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The port number that corresponds to the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '80', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the VPC.', + 'type' => 'string', + 'required' => false, + 'example' => 'description of the VPC', + ], + ], + [ + 'name' => 'VpcTargetHostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The host of the backend service.', + 'type' => 'string', + 'required' => false, + 'example' => 'iot.hu***ng.com', + ], + ], + [ + 'name' => 'Tag', + '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' => 'key', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeApiGroupVpcWhitelist' => [ + 'summary' => 'Queries the VPC whitelist that is allowed to access an API group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94314', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f6c64214dc27400196eef954575d60d3', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '94417', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => 'VPC授权名称', + 'description' => 'The name of the authorization. The name must be unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'wuying-edm-svc', + ], + ], + [ + 'name' => 'VpcAccessId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Vpc授权ID', + 'description' => 'The ID of the VPC authorization.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-*****ssds24', + ], + ], + [ + 'name' => 'AccurateQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to conduct precise queries', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + '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' => [ + 'title' => '实例ID', + 'description' => 'The ID of the instance.', + 'type' => 'string', + 'required' => false, + 'example' => '10.199.26.***', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'title' => '端口号', + 'description' => 'The service port.', + 'type' => 'string', + 'required' => false, + 'example' => '8080', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VpcAccessAttribute' => [ + 'description' => 'The information about the VPC access authorization. The information is an array consisting of VpcAccessAttribute data.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"8883AC74-259D-4C0B-99FC-0B7F9A588B2F\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"VpcAccessAttributes\\": {\\n \\"VpcAccessAttribute\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf657qec7lx42paw3qxxx\\",\\n \\"Description\\": \\"测试\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94411', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7d341787517a47afaaef9cc1bdb7acce', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + 'ApiUpdateVpcInfoResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiUpdateVpcInfoResult' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'VpcAccessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the VPC access authorization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5f1b3216f9********e2c1297b6741dc', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API Gateway instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'apigateway-hz-72bc18******', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + 'AclId' => [ + 'description' => 'The ACL ID.'."\n", + 'type' => 'string', + 'example' => 'acl-bp1uqwgwmkbutnzq2r59z', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acl-uf6fpfdg3b5muska7uqem', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AclName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testAcl', + ], + ], + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acl-bp1ohqkonqybecf4llbrc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', + ], + ], + ], + ], + ], + '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', + ], + '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).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acl-bp1ohqkonqybecf4llbrc', + ], + ], + [ + '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" + .'* 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\'}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acl-bp12ag0xxcfhq1ll68wp9', + ], + ], + [ + 'name' => 'AclEntrys', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '[{\\"entry\\":\\"192.168.1.0/24\\",\\"comment\\":\\"WhiteIp\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D1B18FFE-4A81-59D8-AA02-1817098977CD', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '142235', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'AclId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'acl-3nsohdozz0ru8fi5onwz1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AclEntry' => [ + 'description' => 'The information about the access control policy.'."\n", + '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', + ], + ], + ], + ], + ], + ], + 'AddressIPVersion' => [ + 'description' => 'The IP protocol version. Valid values: **ipv4** and **ipv6**.'."\n", + 'type' => 'string', + 'example' => 'ipv4', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '142234', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'AclName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the access control policy.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'testAcl', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AddressIPVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP版本,可以设置为**ipv4**或者**ipv6**。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipv6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Acl' => [ + 'description' => 'The ACLs.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '171235', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API Gateway plugin ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a96926e82f994915a8da40a119374537 ', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0009db9c828549768a200320714b8930', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '3707E6FA-749C-5352-B72A-ABE95D9DEA49', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in to be bound.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', + ], + ], + [ + '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', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RELEASE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '171238', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '08ae4aa0f95e4321849ee57f4e0b3077', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination parameter: current page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API Gateway plugin ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1f3bde29b43d4d53989248327ff737f2', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API group ID', + 'type' => 'string', + 'required' => false, + 'example' => '8cc2a3cbe3394524b6e71be5db9b02a3', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'API group name', + 'type' => 'string', + 'required' => false, + 'example' => 'crm_custom_service', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'API group description', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pagination parameter: current page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'GroupPluginSummary' => [ + 'description' => 'Collection of group information', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94278', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginName', + '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', + ], + ], + [ + 'name' => 'PluginType', + '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', + ], + ], + [ + 'name' => 'PluginData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The plug-in definition. Supported formats: JSON and YAML.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Plugin definition', + ], + ], + [ + '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' => 'createPlugin', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94295', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9a3f1a5279434f2ba74ccd91c295af9f', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + ], + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AttachPlugin' => [ + 'summary' => 'Binds a plug-in to an API.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94249', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in to be bound.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9a3f1a5279434f2ba74ccd91c295af9f ', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '285bb759342649a1b70c2093a772e087', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the API to be bound.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '8afff6c8c4c6447abb035812e4d66b65 ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + ], + ], + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyPlugin' => [ + 'summary' => 'Modifies the information of a plug-in.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94447', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in whose information you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a96926e82f994915a8da40a119374537 ', + ], + ], + [ + 'name' => 'PluginName', + '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' => false, + 'example' => 'modifyCors', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CE5722A6-AE78-4741-A9B0-6C817D360510', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '05df2b52a3644a3a8b1935ab8ab59e9d', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '93b87279e54c4c0baeb7113cdf9c67f5', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RELEASE', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '19a2846d8e8541c788c6be740035eb68', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD00F8C0-311B-54A9-ADE2-2436771012DA\\"\\n}","type":"json"}]', + 'title' => 'DetachPlugin', + ], + 'DescribePluginApis' => [ + 'summary' => 'Queries the APIs to which a specified plug-in is bound.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94378', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the gateway plug-in.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bf6583efcef44c51adb00c4e********', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '231a4bb81ee94da785733c29********', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.', + 'type' => 'string', + 'required' => false, + 'example' => 'c6b0dd188b0e4e408e12f926********', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'API', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request path of the API.', + 'type' => 'string', + 'required' => false, + 'example' => '/sendVerifyCode', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request HTTP method of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the API.', + 'type' => 'string', + 'required' => false, + 'example' => 'API description', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + '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', + ], + 'ApiSummarys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiPluginSummary' => [ + 'description' => 'The information about APIs.'."\n", + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'DescribePluginApis', + ], + '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' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94380', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the group to which the API belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3c7a38392e764718ad7673e7b7f535d4', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '93f4ead4080c4b2da70b7f81f50ae459', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PluginAttribute' => [ + 'description' => 'The plug-in information. The information is an array that consists of PluginAttribute data.'."\n", + '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' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94381', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', + ], + 'PluginSchemas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PluginSchema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'plugin schema title', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'plugin scheme description', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'VPC_C', + ], + 'DocumentId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4107**', + ], + 'SupportClassic' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94382', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the plug-in.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jwtAuth', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + ], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => 'The templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The templates.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribePlugins' => [ + 'summary' => 'Queries API Gateway plug-ins and the details of the plug-ins.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94379', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the plug-in.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a96926e82f994915a8da40a119374537 ', + ], + ], + [ + 'name' => 'PluginType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business type of the plug-in.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cors', + ], + ], + [ + 'name' => 'PluginName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the plug-in.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testPlugin', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tag', + '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" + .'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' => '\' \'', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'Key, Value', + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PluginAttribute' => [ + 'description' => 'The returned information about the plug-in. It is an array consisting of PluginAttribute data.'."\n", + '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', + ], + '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' => 'testkey', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'tetstvalue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":""}]', + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDataset' => [ + 'summary' => 'Creates a custom dataset.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayE6KZ22', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DatasetName', + ], + ], + [ + 'name' => 'DatasetType', + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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********', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '106.43.XXX.XXX', + ], + ], + [ + 'name' => 'ExpiredTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2022-09-22T12:00:00Z', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetItemId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5045****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8A5E2053-4D9F-5280-B7A9-D357********', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '048C8EFB-528F-5E97-8A3D-D17B********', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********'."\n", + ], + ], + [ + 'name' => 'DatasetItemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data entry.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5045****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'FF433E09-663A-5F5D-9DBA-A611********', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayE6KZ22', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********'."\n", + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'NewDatasetName', + ], + ], + [ + 'name' => 'Description', + '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' => '', + ], + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********', + ], + ], + [ + 'name' => 'DatasetItemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data entry.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5045****'."\n", + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2022-09-22T12:00:00Z', + ], + ], + [ + 'name' => 'Description', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F7DE77BC-0F7D-5A18-B494-BD2C********', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155066', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a25a6589b2584ff490e891cc********', + ], + ], + ], + 'responses' => [ + 200 => [ + '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.', + 'type' => 'object', + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155070', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the datasets.', + 'type' => 'string', + 'required' => false, + 'example' => '4add6a61804e47858266883e********', + ], + ], + [ + 'name' => 'DatasetName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IPwhitelist', + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + ], + 'Description' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '155080', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '62b91a790a693238********', + ], + ], + [ + 'name' => 'DatasetItemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data entry.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '5045****', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the data entry.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '106.43.XXX.XXX'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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.', + 'type' => 'object', + '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", + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BAFA85F-38E3-5D9E-9E32-4B09********\\",\\n \\"DatasetItemInfo\\": {\\n \\"DatasetId\\": \\"626238665db4a5140eea3e40********\\",\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"Value\\": \\"106.43.XXX.XXX\\",\\n \\"ExpiredTime\\": \\"2022-09-22T12:00:00Z\\\\n\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\\\n\\",\\n \\"Description\\": \\"描述信息\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDatasetItemInfo', + ], + 'DescribeDatasetItemList' => [ + 'summary' => 'Queries the data entries of a custom dataset.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '155090', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the dataset.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '602e1f6b3543200eaab0a89e********', + ], + ], + [ + 'name' => 'DatasetItemIds', + '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", + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + '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", + ], + ], + 'description' => '', + ], + 'description' => 'The Dataset information.', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"C6E9C6E4-608B-5C0F-9783-E288********\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DatasetItemInfoList\\": [\\n {\\n \\"DatasetId\\": \\"\\\\t\\\\n4add6a61804e47858266883e********\\\\n\\",\\n \\"DatasetItemId\\": \\"5045****\\",\\n \\"Value\\": \\"106.43.XXX.XXX\\",\\n \\"ExpiredTime\\": \\"2022-09-22T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"CreatedTime\\": \\"2022-09-21T12:58:43Z\\",\\n \\"Description\\": \\"描述信息\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDatasetItemList', + ], + 'CreateModel' => [ + 'summary' => 'Creates a model for an API group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94275', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModelName', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Schema', + '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"}}}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the model definition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Model Description', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94294', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the model.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', + ], + ], + 'description' => '', + ], + ], + ], + '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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyModel' => [ + 'summary' => 'Updates the model of an API group.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94446', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayY6W7D1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the model.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the new model definition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Model Description', + ], + ], + [ + '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\\"}}}', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'NewModelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new name of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NewTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '4173F95B-360C-460C-9F6C-4A960B904411', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94377', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '30e792398d6c4569b04c0e53a3494381', + ], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Tag', + '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' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModelDetail' => [ + 'description' => 'The returned information about models. It is an array consisting of ModelDetail data.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagInfo' => [ + 'description' => 'The tags of the model.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetApisAuthorities' => [ + 'summary' => 'Authorizes a specified application to call multiple APIs.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + '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', + ], + ], + [ + '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' => '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94478', + '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' => true, + 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94461', + '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' => true, + 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + 'name' => 'AppId', + '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', + ], + ], + [ + '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' => '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the authorization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Queries weather based on the region name'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94462', + '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' => true, + 'example' => '523e8dc7bbe04613b5b1d726c2a7889d', + ], + ], + [ + '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', + ], + ], + [ + '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,3286798', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'D6E46F10-F26C-4AA0-BB69-FE2743D9AE62', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94472', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new AppKey that you set must be globally unique.', + 'type' => 'string', + 'required' => false, + 'example' => 'testAppKey', + ], + ], + [ + 'name' => 'NewAppSecret', + 'in' => 'query', + '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***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ015', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94429', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + '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', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1d2db86sca4384811e0b5e8707e68181f', + ], + ], + [ + 'name' => 'ResourceId', + '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, + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The resource list.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94494', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + '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', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + [ + 'name' => 'ResourceId', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94496', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ResourceId', + '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, + ], + ], + [ + 'name' => 'TagKey', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + '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', + ], + ], + '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', + ], + 'DescribeRegions' => [ + 'summary' => 'Queries the Alibaba Cloud regions that are supported by API Gateway.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94396', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayX0L6BS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Language', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '36BBBAD4-1CFB-489F-841A-8CA52EEA787E', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The returned region information. It is an array that consists of Region data.'."\n", + 'example' => 'cn-huhehaote', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParamItem' => [ + 'description' => 'The returned information about system parameters. It is an array that consists of SystemParam data.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0CCDF65E-6050-412D-AD68-FA3D9196836C\\",\\n \\"SystemParams\\": {\\n \\"SystemParamItem\\": [\\n {\\n \\"DemoValue\\": \\"192.168.1.1\\",\\n \\"Description\\": \\"客户端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', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Zone' => [ + 'description' => 'The zones available in the current region.'."\n", + 'example' => '{\'Zone\': [{\'ZoneId\': \'cn-hangzhou-i\'}]}', + 'type' => 'array', + 'items' => [ + '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", + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9324B68F-9863-5722-A0FD-0798E2B02A0E\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-MAZ2(j,g)\\",\\n \\"LocalName\\": \\"华东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', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '210981***530495', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2D39D1B3-8548-508A-9CE2-7F4A3F2A7989', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"210981***530495\\",\\n \\"RequestId\\": \\"2D39D1B3-8548-508A-9CE2-7F4A3F2A7989\\"\\n}","type":"json"}]', + 'title' => 'OpenApiGatewayService', + ], + 'CreateLogConfig' => [ + 'summary' => 'Creates a Simple Log Service configuration for an API.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94274', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + 'parameters' => [ + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Log Service project.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rec-lq-sls', + ], + ], + [ + 'name' => 'SlsLogStore', + 'in' => 'query', + 'schema' => [ + 'description' => 'slslogstore', + 'type' => 'string', + 'required' => true, + 'example' => 'api-gateway', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PROVIDER'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PROVIDER', + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + [ + 'name' => 'CreateSlr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies to create a service-linked role.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ016\\"\\n}","type":"json"}]', + 'title' => 'DeleteLogConfig', + ], + 'ModifyLogConfig' => [ + 'summary' => '修改日志配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94445', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Logstore.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'logs-gateway', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type. Valid values:'."\n" + ."\n" + .'* **log**: other logs'."\n" + .'* **survey**: inspection logs'."\n" + ."\n" + .'Enumeration value:'."\n" + ."\n" + .'* PROVIDER'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'RequestLogId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the request log.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '95657ED9-2F6F-426F-BD99-79C8********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94375', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayQEORTA', + ], + ], + 'parameters' => [ + [ + 'name' => 'LogType', + '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'E3BC2706-ABDB-5B64-A12F-08DFD9E3F339', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfo' => [ + 'description' => 'Info of the log config.', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + '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', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The programming language in which the SDK is generated.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'java', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94474', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayY6W7D1', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '110797019', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'java', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD......', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '61A16D46-EC04-5288-8A18-811B0F536CC2', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94475', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayY6W7D1', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1a991a450b9548a1a3df38fd3af117c2', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'java', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://oss-bucket/object', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D0075BDA-8AED-5073-A70A-FE44E86AB20F', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'BackendName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the backend service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testBackendService', + ], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the backend service.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'release data api 411055691504981', + ], + ], + [ + 'name' => 'CreateEventBridgeServiceLinkedRole', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies to create a EventBridge service-linked role.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CreateSlr', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies to create a service-linked role.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + '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' => 'key', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backend service.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '27be0dd9ebbc467b9e86c0d250d0b92e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'AD00F8C0-311B-54A9-ADE2-2436771012DA', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'BackendName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testHttpModify', + ], + ], + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20bcdc9453524b78a8beb1f6de21edb7', + ], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '06DACA61-9359-5EC6-AEDA-C73E620E49A9', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '114857', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'BackendName', + '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', + ], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the backend service.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the current page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '119939', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationUid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4e13c3e0c44c4a4ebb5231264eeb9bc1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '34e94fcd3e2e47a49824a89b8f92cb5e', + ], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + 'docRequired' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'TEST', + ], + ], + [ + 'name' => 'BackendModelData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{\\"ServiceAddress\\":\\"http://apigateway-echo-redux.alicloudapi.com:8080\\"}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'model description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BackendModelId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '64411ECF-FAF7-5E3C-BA7B-E4A1F15A28CA', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'BackendModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backend model.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '4be6b110b7aa40b0bf0c83cc00b3bd86', + ], + ], + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the backend service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20bcdc9453524b78a8beb1f6de21edb7', + ], + ], + [ + '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' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'BackendId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '20bcdc9453524b78a8beb1f6de21edb7', + ], + ], + [ + 'name' => 'BackendType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'TEST', + ], + ], + [ + 'name' => 'BackendModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3bb6375bc71c4e4c95ce05b4e7a55a9d', + ], + ], + [ + 'name' => 'BackendModelData', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{\\"ServiceAddress\\":\\"http://121.40.XX.XX\\"}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'modify plugin first', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '19B89B04-418B-55EE-94A8-6B42CA06002A', + ], + 'OperationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c16a1880f5164d779f6a54f64d997cd9', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94280', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureName', + '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', + ], + ], + [ + 'name' => 'SignatureKey', + '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', + ], + ], + [ + 'name' => 'SignatureSecret', + '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', + ], + ], + ], + '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 back-end signature key.'."\n", + 'type' => 'string', + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + 'SignatureName' => [ + 'description' => 'The name of the back-end signature key.'."\n", + 'type' => 'string', + 'example' => 'backendsignature', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94298', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the key to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94448', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the signature key that you want to manage.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'backendsignature', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'qwertyuiop', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asdfghjkl', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94485', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0009db9c828549768a200320714b8930', + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12', + ], + ], + [ + 'name' => 'StageName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27F9C50D-7EB4-5623-8472-45B3C7602C91\\"\\n}","type":"json"}]', + 'title' => 'SetSignatureApis', + ], + 'DescribeSignatures' => [ + 'summary' => 'Queries backend signature keys.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94399', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the keys to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'SignatureName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The names of the keys to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'backendsignature', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the signature key.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiInfos\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"3b81fd160f5645e097cc8855d75a1cf6\\",\\n \\"Description\\": \\"描述\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94330', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + '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', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94400', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the group to which the API 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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94467', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayXW2LMR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignatureId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the signature key.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'GroupId', + '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', + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + '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" + .'* 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" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tf123456', + ], + ], + [ + 'name' => 'SpecialType', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3382463', + ], + ], + [ + 'name' => 'TrafficValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The special throttling value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTrafficControl' => [ + 'summary' => 'Creates a custom throttling policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94281', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'ApiDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each API.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'UserDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each user.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'AppDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each app.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the throttling policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ThrottlingTestDescription'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + '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", + ], + 'DeleteTrafficControl' => [ + 'summary' => 'Deletes a custom throttling policy and the special throttling rules in the policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94299', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94300', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the throttling policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tf123456', + ], + ], + [ + 'name' => 'SpecialType', + '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', + ], + ], + [ + 'name' => 'SpecialKey', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + ], + ], + ], + '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", + ], + 'ModifyTrafficControl' => [ + 'summary' => 'Modifies the settings of a custom throttling policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94449', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the throttling policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tf123456', + ], + ], + [ + '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", + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ApiDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each API.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'UserDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each user.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'AppDefault', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default throttling value for each app.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the throttling policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ThrottlingTestDescription'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 ', + ], + ], + ], + ], + ], + '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":""}]', + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94486', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the throttling policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'GroupId', + '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', + ], + ], + [ + 'name' => 'ApiIds', + '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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RELEASE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'TrafficControlName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the throttling policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ThrottlingTest'."\n", + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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' => '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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficControl' => [ + 'description' => 'The returned throttling policy information. It is an array consisting of TrafficControl data.'."\n", + 'type' => 'array', + 'items' => [ + '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' => '[email protected]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\"\\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>[email protected]</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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94410', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + '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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The runtime environment of the API. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RELEASE', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94327', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + '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', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94468', + 'abilityTreeNodes' => [ + 'FEATUREapigateway6HGZRN', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94246', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACL. The ID is unique.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '7ea91319a34d48a09b5c9c871d9768b1', + ], + ], + [ + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '113.125.1.101;101.11.1.1', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateIpControl' => [ + 'summary' => 'Creates an access control list (ACL) in a region.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94273', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIDGJ9', + ], + ], + 'parameters' => [ + [ + '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' => true, + 'example' => 'controlNameTest', + ], + ], + [ + 'name' => 'IpControlType', + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description. The description can be up to 200 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpControlPolicys', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteIpControl' => [ + 'summary' => 'Deletes an access control list (ACL).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94292', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyIpControl' => [ + 'summary' => 'Modifies an access control list (ACL).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94443', + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description. The description can be up to 200 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyIpControlPolicyItem' => [ + 'summary' => 'Modifies a policy in an access control list (ACL).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94444', + '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' => 'PolicyItemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'P151617000829241', + ], + ], + [ + 'name' => 'AppId', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '113.125.1.101;101.11.1.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0009db9c828549768a200320714b8930', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + '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", + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94317', + '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', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiIpControlItem' => [ + 'description' => 'The information about the ACLs. The information is an array of ApiIpControlItem data.'."\n", + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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" + ."\n" + .'·'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeIpControlPolicyItems' => [ + 'summary' => 'Queries the rule entries of an IP address-based traffic control policy.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94373', + 'abilityTreeNodes' => [ + 'FEATUREapigatewaySKO2I5', + ], + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACL. The ID is unique.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7ea91319a34d48a09b5c9c871d9768b1', + ], + ], + [ + 'name' => 'PolicyItemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'P151617000829241', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94374', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIDGJ9', + ], + ], + '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', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"IpControlInfos\\": {\\n \\"IpControlInfo\\": [\\n {\\n \\"IpControlId\\": \\"7ea91319a34d48a09b5c9c871d9768b1\\",\\n \\"IpControlType\\": \\"ALLOW\\",\\n \\"ModifiedTime\\": \\"2018-01-17T06:00:38Z\\",\\n \\"IpControlName\\": \\"testControl11\\",\\n \\"Description\\": \\"description\\",\\n \\"CreateTime\\": \\"2018-01-17T05:48:11Z\\",\\n \\"RegionId\\": \\"cn-qingdao\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94324', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIDGJ9', + ], + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 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-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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"ApiInfos\\": {\\n \\"ApiInfo\\": [\\n {\\n \\"BoundTime\\": \\"2016-07-23T08:28:48Z\\",\\n \\"Visibility\\": \\"PUBLIC\\",\\n \\"ApiId\\": \\"3b81fd160f5645e097cc8855d75a1cf6\\",\\n \\"Description\\": \\"描述\\",\\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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveIpControlApis' => [ + 'summary' => 'Unbinds an API from an access control list (ACL).', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94465', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIDGJ9', + ], + ], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ACL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dd05f1c54d6749eda95f9fa6d491449a', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0009db9c828549768a200320714b8930', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the runtime environment. Valid values:'."\n" + ."\n" + .'* **RELEASE**'."\n" + .'* **TEST**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TEST', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + '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' => 'PolicyItemIds', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ004', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004\\"\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '191542', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP的ID', + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '2386789', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => 'The page number of the page to return.'."\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', + 'in' => 'query', + 'schema' => [ + 'title' => 'API的ID', + 'description' => 'The API ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'b19240592b1b4e74961fb8438ed7550c', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'title' => 'API名称', + 'description' => 'The API name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ApiName', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'title' => 'API请求路径', + 'description' => 'The request path of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/tt', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'title' => 'API的请求HTTP Method', + 'description' => 'The request HTTP method of the API.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94358', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + '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', + ], + ], + [ + 'name' => 'EndTime', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd825094fdd114a869f5adb443d9b7ead', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94360', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayWECSVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2023-06-16T02:16:53Z', + ], + ], + [ + '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" + .'* **PRE**: the staging environment'."\n" + .'* **TEST**: the test environment'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'RELEASE ', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '16df9d11caa04900bcafe23b38a81600', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94432', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API group.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '01c97ed08a614118849b00079753d1e2', + ], + ], + [ + 'name' => 'TargetInstanceId', + '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', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'migrate', + ], + ], + [ + 'name' => 'Tag', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E07AEFF0-9FB0-599E-8F12-B418D8AE1F3D', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94433', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayRIX31M', + ], + ], + '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', + ], + ], + [ + 'name' => 'InternetEnable', + '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', + ], + ], + [ + 'name' => 'InternetIPV6Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable IPv6. Valid values: **true** and **false**.'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'VpcIntranetEnable', + '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', + ], + ], + [ + 'name' => 'VpcSlbIntranetEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the self-calling domain name.'."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'InnerDomainEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to disable the public second-level domain name.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4E707B25-5119-5ACF-9D26-7D2A2762F05C', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + [ + 'name' => 'Apis', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '98E4A7DC-1EA6-5E6A-ACFE-91B60CE7D4BB', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '111385984', + ], + ], + [ + 'name' => 'ApiProductIds', + '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, + ], + ], + [ + 'name' => 'AuthValidTime', + 'in' => 'query', + 'schema' => [ + 'description' => '授权有效时间的截止时间,请设置格林尼治标准时间(GMT), 如果为空,即为授权永久有效。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-12T03:07:37Z', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The authorization description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2603F41E-77FC-59A3-840E-296578A9BDE0', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '110962435', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + [ + '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', + ], + ], + [ + '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, + 'example' => '10', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testApp', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC866798-62D3-52F4-8AB5-CA149A53984F\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 4,\\n \\"AuthorizedApps\\": {\\n \\"AuthorizedApp\\": [\\n {\\n \\"AppName\\": \\"APP_02580_DEV\\",\\n \\"Description\\": \\"授权描述\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + [ + 'name' => 'Apis', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The APIs to be attached.'."\n", + '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', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BA20890E-75C7-41BC-9C8B-73276B58F550', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BZ002', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '110982490', + ], + ], + [ + 'name' => 'ApiProductIds', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CEB6EC62-B6C7-5082-A45A-45A204724AC2', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ApiProductId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the API product.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117b7a64a8b3f064eaa4a47ac62aac5e', + ], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The IDs of the applications that you want to authorize.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the application that you want to authorize.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '110966607', + ], + 'required' => true, + ], + ], + [ + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the authorization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EF924FE4-2EDD-4CD3-89EC-34E4708574E7', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94328', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayNPQVBL', + ], + ], + 'parameters' => [ + [ + 'name' => 'VpcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the VPC access authorization.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'lynkco-iov-uat', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207739', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '111265074', + ], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application AppCode.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0d13f021c5cd4997831a9717e75b0663', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '207740', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '110840611', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AppKey of the application. The AppKey is used for calling an API.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '203708622', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '79EF055D-AC00-5161-8F35-6A36AAED7422', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '207738', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '111203109', + ], + ], + [ + 'name' => 'AppCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application AppCode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3aaf905a0a1f4f0eabc6d891dfa08afc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '418DAAE7-A0C2-5E9C-ADFF-4CD14A474F88', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '207737', + 'abilityTreeNodes' => [ + 'FEATUREapigatewayCRDGVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '111053351', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application AppKey.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '204203237', + ], + ], + [ + 'name' => 'AppSecret', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application AppSecret.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '6f0a4ad7918a4b41a57fc087d5b066d0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5D524309-6BED-5BB4-A735-F7D9F98B7B88', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175318', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the dedicated instance cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testvpc', + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'DescribeInstanceClusterList' => [ + 'summary' => 'Queries dedicated instance clusters.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175317', + 'abilityTreeNodes' => [ + 'FEATUREapigateway910B7T', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-cluster', + ], + ], + [ + 'name' => 'InstanceClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'apigateway-cluster-hz-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per 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', + ], + ], + ], + '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' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '110862931', + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DataFormat', + 'in' => 'query', + 'schema' => [ + 'description' => 'The exported format:'."\n" + ."\n" + .'* json'."\n" + .'* yaml'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'yaml', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The API group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '42925e7f5209438186d5560239af5xxx', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'OasVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The OAS version. Valid values:'."\n" + ."\n" + .'* **oas2**'."\n" + .'* **oas3**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oas2', + ], + ], + [ + 'name' => 'WithXExtensions', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to export API Gateway extensions at the same time.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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', + ], + ], + ], + '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' => '', + ], + ], + ], + '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', + ], + ], +]; diff --git a/data/en_us/cloudapi/2018-06-01/api-docs.php b/data/en_us/cloudapi/2018-06-01/api-docs.php new file mode 100644 index 0000000..0c9ac8e --- /dev/null +++ b/data/en_us/cloudapi/2018-06-01/api-docs.php @@ -0,0 +1,5237 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CloudAPI', + 'version' => '2018-06-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeHistoryApis', + 'DescribeHistoryApi', + 'DescribeIpControlPolicyItems', + 'DescribeIpControls', + 'DescribeLogConfig', + 'DescribePurchasedApiGroupDetail', + 'DescribePurchasedApi', + 'DescribePurchasedApiGroups', + 'DescribeRaceWorkForInner', + 'DescribePurchasedApis', + 'DescribeRegions', + 'DescribeRulesByApi', + 'DescribeSecretKeys', + 'DescribeSystemParameters', + 'DescribeSystemParams', + 'DescribeTrafficControls', + 'GetApiMethods', + 'GetCustomizedInfo', + 'ModifyApi', + 'ModifyApp', + 'ModifyApiGroup', + 'ModifyIpControl', + 'ModifyIpControlPolicyItem', + 'ModifyLogConfig', + 'ModifySecretKey', + 'ModifyTrafficControl', + 'ReactivateDomain', + 'RecoverApiFromHistorical', + 'RecoveryApiDefineFromHistorical', + 'RecoveryApiFromHistorical', + 'RefreshDomain', + 'RemoveAccessPermissionByApis', + 'RemoveAccessPermissionByApps', + 'RemoveAllBlackList', + 'RemoveApiRule', + 'RemoveAppsFromApi', + 'RemoveBlackList', + 'RemoveIpControlPolicyItem', + 'RemoveIpControlApis', + 'ResetAppKeySecret', + 'ResetCustomized', + 'SdkGenerate', + 'SdkGenerateByApp', + 'SdkGenerateByGroup', + 'SetAccessPermissionByApis', + 'SetAccessPermissions', + 'SetApiRule', + 'SetDomain', + 'SetDomainCertificate', + 'SetDomainWebSocketStatus', + 'SetIpControlApis', + 'SetMockIntegration', + 'SwitchApi', + 'VpcDescribeAccesses', + 'VpcGrantAccess', + 'VpcModifyAccess', + 'VpcRevokeAccess', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeHistoryApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'minLength' => 1, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'HistoryVersion' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeHistoryApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'HttpMethod' => [ + 'type' => 'string', + ], + 'ResultType' => [ + 'type' => 'string', + ], + 'ResultSample' => [ + 'type' => 'string', + ], + 'ServiceProtocol' => [ + 'type' => 'string', + ], + 'VpcName' => [ + 'type' => 'string', + ], + 'FailResultSample' => [ + 'type' => 'string', + ], + 'AuthType' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'BodyFormat' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'Mock' => [ + 'type' => 'string', + ], + 'PostBodyDescription' => [ + 'type' => 'string', + ], + 'MockResult' => [ + 'type' => 'string', + ], + 'HistoryVersion' => [ + 'type' => 'string', + ], + 'ServiceTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'OriginResultDescription' => [ + 'type' => 'string', + ], + 'HttpProtocol' => [ + 'type' => 'string', + ], + 'AllowSignatureMethod' => [ + 'type' => 'string', + ], + 'ServiceFCEnable' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'Visibility' => [ + 'type' => 'string', + ], + 'PostBodyType' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'RequestMode' => [ + 'type' => 'string', + ], + 'Path' => [ + 'type' => 'string', + ], + 'ServiceAddress' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'ServiceVpcEnable' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'FunctionComputeConfig' => [ + 'type' => 'object', + 'properties' => [ + 'FcRegionId' => [ + 'type' => 'string', + ], + 'RoleArn' => [ + 'type' => 'string', + ], + 'ServiceName' => [ + 'type' => 'string', + ], + 'FunctionName' => [ + 'type' => 'string', + ], + ], + ], + 'OpenIdConnectConfig' => [ + 'type' => 'object', + 'properties' => [ + 'OpenIdApiType' => [ + 'type' => 'string', + ], + 'IdTokenParamName' => [ + 'type' => 'string', + ], + 'PublicKeyId' => [ + 'type' => 'string', + ], + 'PublicKey' => [ + 'type' => 'string', + ], + ], + ], + 'ErrorCodeSamples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ErrorCodeSample' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterName' => [ + 'type' => 'string', + ], + 'Location' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'CustomSystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomSystemParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterName' => [ + 'type' => 'string', + ], + 'Location' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ConstantParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ConstantParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'type' => 'string', + ], + 'Location' => [ + 'type' => 'string', + ], + 'ConstantValue' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'PathParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PathParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestQueries' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestBody' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + 'ServiceParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeIpControlPolicyItems' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PolicyItemId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IpControlPolicyItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IpControlPolicyItem' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'PolicyItemId' => [ + 'type' => 'string', + ], + 'CidrIp' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'AppId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeIpControls' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IpControlName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IpControlType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IpControlInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IpControlInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IpControlId' => [ + 'type' => 'string', + ], + 'IpControlType' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'IpControlName' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeLogConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'LogInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SlsLogStore' => [ + 'type' => 'string', + ], + 'LogType' => [ + 'type' => 'string', + ], + 'SlsProject' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribePurchasedApiGroupDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'DomainItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DomainItem' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribePurchasedApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'type' => 'string', + ], + 'HttpMethod' => [ + 'type' => 'string', + ], + 'ResultType' => [ + 'type' => 'string', + ], + 'ResultSample' => [ + 'type' => 'string', + ], + 'HttpProtocol' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + 'Visibility' => [ + 'type' => 'string', + ], + 'PostBodyType' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'BodyFormat' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'Path' => [ + 'type' => 'string', + ], + 'Mock' => [ + 'type' => 'string', + ], + 'PostBodyDescription' => [ + 'type' => 'string', + ], + 'MockResult' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'PathParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PathParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestHeaders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'MinValue' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestQueries' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'string', + ], + 'MinValue' => [ + 'type' => 'string', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'RequestBody' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RequestParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JsonScheme' => [ + 'type' => 'string', + ], + 'MaxValue' => [ + 'type' => 'string', + ], + 'MinValue' => [ + 'type' => 'string', + ], + 'DocShow' => [ + 'type' => 'string', + ], + 'DefaultValue' => [ + 'type' => 'string', + ], + 'MaxLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ApiParameterName' => [ + 'type' => 'string', + ], + 'EnumValue' => [ + 'type' => 'string', + ], + 'DemoValue' => [ + 'type' => 'string', + ], + 'Required' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParameterType' => [ + 'type' => 'string', + ], + 'RegularExpression' => [ + 'type' => 'string', + ], + 'MinLength' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DocOrder' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribePurchasedApiGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PurchasedApiGroupAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PurchasedApiGroupAttribute' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'ExpireTime' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'InvokeTimesMax' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupDescription' => [ + 'type' => 'string', + ], + 'InvokeTimesNow' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'BillingType' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeRaceWorkForInner' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'CommodityCode' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ShortDescription' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'WorkName' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'Keywords' => [ + 'type' => 'string', + ], + 'LogoUrl' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribePurchasedApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApiInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Visibility' => [ + 'type' => 'string', + ], + 'ApiId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DeployedTime' => [ + 'type' => 'string', + ], + 'StageName' => [ + 'type' => 'string', + ], + 'ApiName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'type' => 'string', + ], + 'LocalName' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeRulesByApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RuleId' => [ + 'type' => 'string', + ], + 'RuleName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSecretKeys' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SecretKeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SecretKeyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SecretKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecretKey' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecretKeyId' => [ + 'type' => 'string', + ], + 'SecretKey' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'SecretKeyName' => [ + 'type' => 'string', + ], + 'SecretKeyValue' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSystemParameters' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SystemParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParameter' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParamName' => [ + 'type' => 'string', + ], + 'ParamType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'DescribeSystemParams' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SystemParams' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemParam' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoValue' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'ParamName' => [ + 'type' => 'string', + ], + 'ParamType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => null, + ], + 'DescribeTrafficControls' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TrafficControlName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TrafficControls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TrafficControl' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ApiDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'TrafficControlUnit' => [ + 'type' => 'string', + ], + 'TrafficControlName' => [ + 'type' => 'string', + ], + 'AppDefault' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TrafficControlId' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'SpecialPolicies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SpecialPolicy' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpecialType' => [ + 'type' => 'string', + ], + 'Specials' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Special' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SpecialKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetApiMethods' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiPath', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Methods' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetCustomizedInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SdkDemos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SdkDemo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallDemo' => [ + 'type' => 'string', + ], + 'IdeKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'RequestConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ServiceConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'RequestParamters', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceParameters', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceParametersMap', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResultType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ResultSample', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'FailResultSample', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ErrorCodeSamples', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ResultDescriptions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OpenIdConnectConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AllowSignatureMethod', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'WebSocketApiType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyApp' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyApiGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SubDomain' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyIpControl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'IpControlName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyIpControlPolicyItem' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PolicyItemId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyLogConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SlsLogStore', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'PROVIDER', + 'enum' => [ + 'PROVIDER', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifySecretKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SecretKeyId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SecretKeyName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SecretKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SecretValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecretKeyId' => [ + 'type' => 'string', + ], + 'SecretKeyName' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ModifyTrafficControl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TrafficControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'TrafficControlName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TrafficControlUnit', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ApiDefault', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'UserDefault', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'AppDefault', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ReactivateDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RecoverApiFromHistorical' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RecoveryApiDefineFromHistorical' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RecoveryApiFromHistorical' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RefreshDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'CertificateName' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'DomainNameResolution' => [ + 'type' => 'string', + ], + 'DomainStatus' => [ + 'type' => 'string', + ], + 'SubDomain' => [ + 'type' => 'string', + ], + 'DomainName' => [ + 'type' => 'string', + ], + 'CertificateId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveAccessPermissionByApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveAccessPermissionByApps' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveAllBlackList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'BlackType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveApiRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveAppsFromApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveBlackList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'BlackType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'BlackContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveIpControlPolicyItem' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PolicyItemIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'RemoveIpControlApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ResetAppKeySecret' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'ResetCustomized' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'SdkDemos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SdkDemo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallDemo' => [ + 'type' => 'string', + ], + 'IdeKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SdkGenerate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SdkGenerateByApp' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SdkGenerateByGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DownloadLink' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetAccessPermissionByApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetAccessPermissions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetApiRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetDomain' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CertificateName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CertificateBody', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'DomainLegalStatus' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'SubDomain' => [ + 'type' => 'string', + ], + 'DomainName' => [ + 'type' => 'string', + ], + 'DomainBindingStatus' => [ + 'type' => 'string', + ], + 'DomainRemark' => [ + 'type' => 'string', + ], + 'DomainWebSocketStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetDomainCertificate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CertificateName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CertificateBody', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PrivateKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetDomainWebSocketStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ActionValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetIpControlApis' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IpControlId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SetMockIntegration' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Mock', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MockResult', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'SwitchApi' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StageName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'HistoryVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'VpcDescribeAccesses' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstancePort', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'VpcAccessAttributes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VpcAccessAttribute' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'VpcId' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Port' => [ + 'type' => 'string', + ], + 'CreatedTime' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'VpcGrantAccess' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstancePort', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'VpcModifyAccess' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstancePort', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'VpcRevokeAccess' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'InstancePort', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + ], + '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', + ], + ], +]; |
