'1.0',
'info' => [
'style' => 'RPC',
'product' => 'MPServerless',
'version' => '2019-06-15',
],
'directories' => [
[
'id' => 77563,
'title' => '服务空间',
'type' => 'directory',
'children' => [
'CreateSpaceWithOrder',
'DescribeSpaces',
'CreateSpace',
'DeleteSpace',
'UpdateSpace',
'ListSpace',
],
],
[
'id' => 77595,
'title' => '云函数',
'type' => 'directory',
'children' => [
'CreateFunction',
'CreateFunctionDeployment',
'DeleteFunction',
'UpdateFunction',
'UpdateHttpTriggerConfig',
'DescribeFunction',
'DescribeHttpTriggerConfig',
'ListFunction',
'ListFunctionDeployment',
'ListFunctionLog',
'DeployFunction',
'RunFunction',
],
],
[
'id' => 77612,
'title' => '云数据库',
'type' => 'directory',
'children' => [
[
'id' => 164600,
'title' => '集合管理与命令',
'type' => 'directory',
'children' => [
'DeleteDBCollection',
'RenameDBCollection',
'RunDBCommand',
],
],
[
'id' => 77541,
'title' => '备份与回档',
'type' => 'directory',
'children' => [
'CreateDBRestoreTask',
'QueryDBBackupCollections',
'QueryDBRestoreTaskStatus',
'QueryDBBackupDumpTimes',
],
],
[
'id' => 164601,
'title' => '数据导入与导出',
'type' => 'directory',
'children' => [
'CreateDBExportTask',
'CreateDBImportTask',
'QueryDBExportTaskStatus',
'QueryDBImportTaskStatus',
],
],
],
],
[
'id' => 164602,
'title' => '云存储',
'type' => 'directory',
'children' => [
'DeleteFile',
'RegisterFile',
'DescribeFileUploadSignedUrl',
'ListFile',
'DescribeCdnDomain',
'SaveCdnDomainConfig',
],
],
[
'id' => 77573,
'title' => '静态网站托管',
'type' => 'directory',
'children' => [
[
'id' => 164603,
'title' => '文件',
'type' => 'directory',
'children' => [
'DeleteWebHostingFile',
'BatchDeleteWebHostingFiles',
'ListWebHostingFiles',
'DescribeWebHostingFile',
'GetWebHostingUploadCredential',
],
],
[
'id' => 164604,
'title' => '域名',
'type' => 'directory',
'children' => [
'BindWebHostingCustomDomain',
'UnbindWebHostingCustomDomain',
'SaveWebHostingCustomDomainConfig',
'VerifyWebHostingDomainOwner',
'GetWebHostingDomainVerificationContent',
'ListWebHostingCustomDomains',
'RefreshWebHostingCustomDomainCache',
],
],
[
'id' => 164605,
'title' => '证书',
'type' => 'directory',
'children' => [
'DeleteWebHostingCertificate',
'AttachWebHostingCertificate',
'GetWebHostingCertificateDetail',
],
],
[
'id' => 164606,
'title' => '配置',
'type' => 'directory',
'children' => [
'SaveWebHostingCustomDomainCorsConfig',
'GetWebHostingConfig',
'ModifyWebHostingConfig',
],
],
],
],
[
'id' => 77544,
'title' => '管理',
'type' => 'directory',
'children' => [
'EnableExtension',
'UpdateServicePolicy',
'OpenService',
'OpenWebHostingService',
'ResetServerSecret',
'SaveAppAuthToken',
'DescribeFCOpenStatus',
'DescribeServicePolicy',
'ListExtensions',
'QueryServiceStatus',
'GetWebHostingStatus',
'CheckMpServerlessRoleExists',
],
],
[
'id' => 77582,
'title' => '开放平台配置',
'type' => 'directory',
'children' => [
'AddDingtalkOpenPlatformConfig',
'SaveAntOpenPlatformConfig',
'SaveWechatOpenPlatformConfig',
'DeleteAntOpenPlatformConfig',
'DeleteDingtalkOpenPlatformConfig',
'DeleteWechatOpenPlatformConfig',
'UpdateDingtalkOpenPlatformConfig',
'DescribeSpaceClientConfig',
'ListOpenPlatformConfig',
'ListDingtalkOpenPlatformConfigs',
],
],
[
'id' => 77619,
'title' => '安全域名',
'type' => 'directory',
'children' => [
'AddCorsDomain',
'DeleteCorsDomain',
'ListCorsDomains',
],
],
[
'id' => 164608,
'title' => '资源用量与阈值',
'type' => 'directory',
'children' => [
'QuerySpaceSpecDetail',
'QuerySpaceUsage',
'QuerySpaceConsumption',
'DescribeResourceQuota',
'DescribeResourceUsage',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateSpaceWithOrder' => [
'summary' => '创建服务空间并下单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '服务空间名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'Desc',
'in' => 'formData',
'schema' => [
'description' => '服务空间描述信息。',
'type' => 'string',
'required' => false,
'example' => '测试服务空间',
'maxLength' => 128,
],
],
[
'name' => 'SubscriptionType',
'in' => 'formData',
'schema' => [
'description' => '付费类型,取值:'."\n"
.'- Subscription:预付费。'."\n"
.'- PayAsYouGo:后付费。',
'type' => 'string',
'required' => true,
'example' => 'Subscription',
'enum' => [
'Subscription',
'PayAsYouGo',
],
],
],
[
'name' => 'Period',
'in' => 'formData',
'schema' => [
'description' => '购买时长,取值: 可选1、2、3、6、12,单位为月。当选择预付费时,该参数必填。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'1',
'2',
'3',
'6',
'12',
],
],
],
[
'name' => 'PackageVersion',
'in' => 'formData',
'schema' => [
'description' => '预付费套餐规格,当选择预付费时,该参数必填。',
'type' => 'string',
'required' => false,
'example' => 'professional',
'enum' => [
'free',
'base',
'standard',
'professional',
'enterprise',
'ultimate',
],
],
],
[
'name' => 'UseCoupon',
'in' => 'formData',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **true**:使用'."\n"
.'- **false**:不使用'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'mp-1140a548-****-44ac-8bfb-a21c073f0d1a',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C71E8AEA-D1C3-****-956F-C261B7A43E92',
],
'OrderId' => [
'description' => '订单ID。',
'type' => 'string',
'example' => '222082414200***',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'emas_EmasServerlessPost_public_cn-n8m2y7l****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SpaceId\\": \\"mp-1140a548-****-44ac-8bfb-a21c073f0d1a\\",\\n \\"RequestId\\": \\"C71E8AEA-D1C3-****-956F-C261B7A43E92\\",\\n \\"OrderId\\": \\"222082414200***\\",\\n \\"InstanceId\\": \\"emas_EmasServerlessPost_public_cn-n8m2y7l****\\"\\n}","type":"json"}]',
'title' => '创建服务空间并支付下单',
],
'DescribeSpaces' => [
'summary' => '根据 spaceId、租户ID、EMAS项目空间或者套餐规格来查询空间实例信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'description' => '页码,从0开始。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '0',
'example' => '0',
'default' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '页大小,默认值为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'SpaceIds',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => '服务空间ID列表。',
'type' => 'array',
'items' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => false,
'example' => 'mp-c2d29d85-44f5-4ede-****-4f803ba06a7c',
],
'required' => false,
],
],
[
'name' => 'TenantId',
'in' => 'formData',
'schema' => [
'description' => '租户 ID。',
'type' => 'string',
'required' => false,
'example' => 'XKHKTPDJ',
],
],
[
'name' => 'EmasWorkspaceId',
'in' => 'formData',
'schema' => [
'description' => 'EMAS项目空间ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3449110',
],
],
[
'name' => 'SpecCode',
'in' => 'formData',
'schema' => [
'description' => '套餐规格',
'type' => 'string',
'required' => false,
'example' => 'ULTIMATE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '68B76E59-CC10-5EEC-BCED-73A6C51179BC',
],
'GmtCreate' => [
'description' => '时间。',
'type' => 'string',
'example' => '2024-03-27T06:43:17Z',
],
'Count' => [
'description' => '服务空间总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Spaces' => [
'description' => '服务空间。',
'type' => 'array',
'items' => [
'description' => '服务空间。',
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'mp-f215973f-db40-4013-92a8-b09690c7****',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'emas_EmasServerlessPre_public_cn-0ju2pax****',
],
'EmasWorkspaceId' => [
'description' => 'EMAS项目空间ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '3818905',
],
'Name' => [
'description' => '服务空间名称。',
'type' => 'string',
'example' => 'myspace',
],
'Description' => [
'description' => '服务空间描述。',
'type' => 'string',
'example' => '线上',
],
'ServiceStatus' => [
'description' => '空间状态。返回值为 UNINITIALIZED、PRODUCING、PRODUCE_FAILED、PAUSED、IN_SERVICE',
'type' => 'string',
'example' => 'IN_SERVICE',
],
'PackageStatus' => [
'description' => '- RENEWING 续费中'."\n"
.'- UPGRADING 升配中',
'type' => 'string',
'example' => 'UPGRADING',
],
'GmtCreate' => [
'description' => '创建时间。'."\n"
."\n",
'type' => 'string',
'example' => '2022-05-19T06:06:05Z',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2022-05-19T06:06:05Z',
],
'SpecCode' => [
'description' => '- FREE 开发者版'."\n"
.'- BASE 基础版'."\n"
.'- STANDARD 标准版'."\n"
.'- PROFESSIONAL 专业版'."\n"
.'- ENTERPRISE 企业版'."\n"
.'- UTIMATE 旗舰版',
'type' => 'string',
'example' => 'ENTERPRISE',
],
'ChargeType' => [
'description' => '- PREPAY 套餐付费'."\n"
.'- POSTPAY 按量计费',
'type' => 'string',
'example' => 'PREPAY',
],
'OrderType' => [
'description' => '- BUY 新购'."\n"
.'- RENEW 续费'."\n"
.'- UPGRADE 升配',
'type' => 'string',
'example' => 'BUY',
],
'AutoRenew' => [
'description' => '付费类型为包年包月时,取值如下:'."\n"
.'- true:自动续费。'."\n"
.'- false:手动续费。',
'type' => 'boolean',
'example' => 'true',
],
'RenewDuration' => [
'description' => '续费时长。',
'type' => 'string',
'example' => '3',
],
'PackageStartDate' => [
'description' => '资源包起始时间。',
'type' => 'string',
'example' => '2022-06-18T16:00:00Z',
],
'PackageEndDate' => [
'description' => '资源包到期时间。',
'type' => 'string',
'example' => '2022-09-18T16:00:00Z',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68B76E59-CC10-5EEC-BCED-73A6C51179BC\\",\\n \\"GmtCreate\\": \\"2024-03-27T06:43:17Z\\",\\n \\"Count\\": 10,\\n \\"Spaces\\": [\\n {\\n \\"SpaceId\\": \\"mp-f215973f-db40-4013-92a8-b09690c7****\\",\\n \\"InstanceId\\": \\"emas_EmasServerlessPre_public_cn-0ju2pax****\\",\\n \\"EmasWorkspaceId\\": 3818905,\\n \\"Name\\": \\"myspace\\",\\n \\"Description\\": \\"线上\\",\\n \\"ServiceStatus\\": \\"IN_SERVICE\\",\\n \\"PackageStatus\\": \\"UPGRADING\\",\\n \\"GmtCreate\\": \\"2022-05-19T06:06:05Z\\",\\n \\"GmtModified\\": \\"2022-05-19T06:06:05Z\\",\\n \\"SpecCode\\": \\"ENTERPRISE\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"AutoRenew\\": true,\\n \\"RenewDuration\\": \\"3\\",\\n \\"PackageStartDate\\": \\"2022-06-18T16:00:00Z\\",\\n \\"PackageEndDate\\": \\"2022-09-18T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询空间列表信息',
'description' => '> 仅商业版支持该功能',
],
'CreateSpace' => [
'summary' => '创建小程序Serverless服务空间。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '服务空间名称,只能以字母开头,且只能包含数字、字符串。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'space1',
],
],
[
'name' => 'Desc',
'in' => 'formData',
'schema' => [
'description' => '服务空间描述信息。',
'type' => 'string',
'required' => false,
'example' => 'description',
'maxLength' => 128,
],
],
[
'name' => 'WorkspaceId',
'in' => 'formData',
'schema' => [
'description' => '工作空间ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '9223372036854775807',
'minimum' => '1',
'example' => '211975XXXX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'fd46b91a-4591-49b6-abcd-59e9733*****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C44BB160-2F2D-5E34-BC08-B8C8B6D7702F',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SpaceId\\": \\"fd46b91a-4591-49b6-abcd-59e9733*****\\",\\n \\"RequestId\\": \\"C44BB160-2F2D-5E34-BC08-B8C8B6D7702F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C44BB160-2F2D-5E34-BC08-B8C8B6D7702F\\n fd46b91a-4591-49b6-abcd-59e9733*****\\n true\\n","errorExample":""}]',
'title' => '创建小程序服务空间',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteSpace' => [
'summary' => '删除服务空间。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '92e26ea9-6450-4b40-9c20-xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t9D653EC3-8F53-4307-9B1C-52F5922384A6\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '删除服务空间',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateSpace' => [
'summary' => '更新服务空间。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '826061c4-5095-4550-8b74-3bcd9af*****',
],
],
[
'name' => 'Desc',
'in' => 'formData',
'schema' => [
'description' => '服务空间描述信息。',
'type' => 'string',
'required' => false,
'example' => '我的第一个服务空间。',
],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '服务状态,可选值为:'."\n"
.'- IN_SERVICE:服务中。'."\n"
.'- PAUSED:服务暂停。',
'type' => 'string',
'required' => false,
'example' => 'IN_SERVICE',
'enum' => [
'IN_SERVICE',
'PAUSED',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'EA770971-A4A0-4555-9E00-C94A2194E150',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA770971-A4A0-4555-9E00-C94A2194E150\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 9D653EC3-8F53-4307-9B1C-52F5922384A6\\r\\n","errorExample":""}]',
'title' => '更新服务空间',
'description' => '您可以更新服务空间的描述信息,您还可以更新服务空间的服务状态。当服务状态设置为PAUSED(服务暂停)时,服务面(包含小程序端访问服务空间和静态网站托管服务)不再提供服务,管控面(使用OpenAPI或者控制台)提供正常服务。'."\n"
."\n"
.'> 更新服务空间状态成功到状态完全生效有一定的延迟,最高不超过10分钟。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSpace' => [
'summary' => '查询服务空间列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'description' => '页码,从0开始。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '0',
'example' => '0',
'default' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '每页显示的行数。默认为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'SpaceIds',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => '服务空间id列表。',
'type' => 'array',
'items' => [
'description' => '服务空间id。',
'type' => 'string',
'required' => false,
'example' => 'b9105f6d-f403-4ad5-8a05-82e4524659c8,aff8cd35-4273-40ce-943e-9ab8cd8d89fc',
],
'required' => false,
],
],
[
'name' => 'EmasWorkspaceId',
'in' => 'formData',
'schema' => [
'description' => 'EMAS项目空间id。',
'type' => 'string',
'required' => false,
'example' => '3821658',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B314EDAD-FFCA-536D-BA9C-08B42F7C2DDE',
],
'GmtCreate' => [
'type' => 'string',
],
'Count' => [
'description' => '项目总数,用于分页',
'type' => 'integer',
'format' => 'int32',
'example' => '23',
],
'Spaces' => [
'description' => '服务空间。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '服务状态,可选值为:'."\n"
.'- IN_SERVICE:服务中。'."\n"
.'- PAUSED:服务暂停。',
'type' => 'string',
'example' => 'IN_SERVICE',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1582018007000',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '368ef42a-763f-0000-acc2-8aa9564c****',
],
'Name' => [
'description' => '服务空间名称。',
'type' => 'string',
'example' => 'myspace',
],
'Desc' => [
'description' => '描述。',
'type' => 'string',
'example' => '我的空间',
],
'GmtLastAccess' => [
'description' => '最后访问时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1582018007000',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B314EDAD-FFCA-536D-BA9C-08B42F7C2DDE\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"Count\\": 23,\\n \\"Spaces\\": [\\n {\\n \\"Status\\": \\"IN_SERVICE\\",\\n \\"GmtCreate\\": 1582018007000,\\n \\"SpaceId\\": \\"368ef42a-763f-0000-acc2-8aa9564c****\\",\\n \\"Name\\": \\"myspace\\",\\n \\"Desc\\": \\"我的空间\\",\\n \\"GmtLastAccess\\": 1582018007000\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询服务空间列表',
],
'CreateFunction' => [
'summary' => '创建云函数。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '函数名称。'."\n"
.'函数名称长度在1-30个字符间,只能包含字母、数字、下划线和中划线,不能以数字、中划线开头。'."\n"
."\n"
.'> 云函数的名称必须和要上传的Node.js代码包名称一致。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'Desc',
'in' => 'formData',
'schema' => [
'description' => '云函数的描述信息。',
'type' => 'string',
'required' => false,
'example' => '测试函数',
'maxLength' => 128,
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '226e5213-697c-4a52-b4ff-xxxxx',
],
],
[
'name' => 'Runtime',
'in' => 'formData',
'schema' => [
'description' => '云函数执行环境,默认值为nodejs14,可选值为nodejs12,nodejs14等,详情参见文档[《运行时支持列表》](https://help.aliyun.com/document_detail/2717618.html)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'nodejs14' => 'nodejs14',
'nodejs12' => 'nodejs12',
'nodejs16' => 'nodejs16',
],
'example' => 'nodejs12',
'default' => 'nodejs14',
'enum' => [
'nodejs8',
'nodejs12',
'nodejs14',
'nodejs16',
'nodejs18',
'nodejs20',
],
],
],
[
'name' => 'Memory',
'in' => 'formData',
'schema' => [
'description' => '函数内存规格,取值为64的倍数,至少128MB,至多2048MB。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2048',
'minimum' => '128',
'example' => '512',
],
],
[
'name' => 'Timeout',
'in' => 'formData',
'schema' => [
'description' => '函数超时时间,单位为秒,默认值为5,取值范围1-7200。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '7200',
'minimum' => '1',
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E63E7F4F-8538-5B0E-8712-78F92B6DCB9C',
],
'CreatedAt' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-11-18T08:02:33.954Z',
],
'Name' => [
'description' => '函数名称。',
'type' => 'string',
'example' => 'demoFunction',
],
'ModifiedAt' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '021-11-18T08:02:33.954Z',
],
'Desc' => [
'description' => '函数描述。',
'type' => 'string',
'example' => '测试函数',
],
'Spec' => [
'description' => '云函数运行参数。',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '超时时间。',
'type' => 'string',
'example' => '5s',
],
'Runtime' => [
'description' => '运行环境。',
'type' => 'string',
'example' => 'Node.js 12',
],
'InstanceConcurrency' => [
'description' => '单实例允许的最大并发度',
'type' => 'string',
'example' => '1',
],
'Memory' => [
'description' => '内存大小。',
'type' => 'string',
'example' => '512 MB',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\",\\n \\"CreatedAt\\": \\"2021-11-18T08:02:33.954Z\\",\\n \\"Name\\": \\"demoFunction\\",\\n \\"ModifiedAt\\": \\"021-11-18T08:02:33.954Z\\",\\n \\"Desc\\": \\"测试函数\\",\\n \\"Spec\\": {\\n \\"Timeout\\": \\"5s\\",\\n \\"Runtime\\": \\"Node.js 12\\",\\n \\"InstanceConcurrency\\": \\"1\\",\\n \\"Memory\\": \\"512 MB\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-11-18T08:02:33.954Z\\n 测试函数\\n E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\n 2021-11-18T08:02:33.954Z\\n \\n Node.js 12\\n 5 s\\n 512 MB\\n 1\\n \\n true\\n demoFunction\\n","errorExample":""}]',
'title' => '创建云函数',
],
'CreateFunctionDeployment' => [
'summary' => '创建云函数部署单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '部署单名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-8514-xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'UploadSignedUrl' => [
'description' => '上传的URL。',
'type' => 'string',
'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/afc0e1c9d446fxxxxx-v2.zip?OSSAccessKeyId=LTAI****************&Expires=1561425220&Signature=xEuiAgUMShQ4v8fYIl3FM8Jp3MA%3D',
],
'DeploymentId' => [
'description' => '部署单ID。',
'type' => 'string',
'example' => 'dep-5e49fd471c9d4451c33bdd06',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9D653EC3-8F53-4307-9B1C-52F5922384A6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UploadSignedUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/afc0e1c9d446fxxxxx-v2.zip?OSSAccessKeyId=LTAI****************&Expires=1561425220&Signature=xEuiAgUMShQ4v8fYIl3FM8Jp3MA%3D\\",\\n \\"DeploymentId\\": \\"dep-5e49fd471c9d4451c33bdd06\\",\\n \\"RequestId\\": \\"9D653EC3-8F53-4307-9B1C-52F5922384A6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9D653EC3-8F53-4307-9B1C-52F5922384A6\\n 5cff17161c9d4401e9208145\\n http://bucket.oss-cn-shanghai.aliyuncs.com/afc0e1c9d44*****2c30a-v2.zip?OSSAccessKeyId=LTAIKCq5xHz1****&Expires=1561425220&Signature=xEuiAgUMShQ4v8fYIl3FM8Jp3MA%3D\\n","errorExample":""}]',
'title' => '创建云函数部署单',
],
'DeleteFunction' => [
'summary' => '删除云函数。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '函数名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-****-8a88d205e2b8',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9D653EC3-8F53-4307-9B1C-52F5922384A6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9D653EC3-8F53-4307-9B1C-52F5922384A6\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t9D653EC3-8F53-4307-9B1C-52F5922384A6\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '删除云函数',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateFunction' => [
'summary' => '更新函数信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Desc',
'in' => 'formData',
'schema' => [
'description' => '云函数描述。',
'type' => 'string',
'required' => false,
'example' => 'description',
'maxLength' => 128,
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '云函数名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-8514-8a88d205e2b8',
],
],
[
'name' => 'Memory',
'in' => 'formData',
'schema' => [
'description' => '函数内存规格,取值为64的倍数,至少128,至多2048。单位:MB。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2048',
'minimum' => '128',
'example' => '256',
],
],
[
'name' => 'Timeout',
'in' => 'formData',
'schema' => [
'description' => '函数超时时间,单位为秒,默认值为5,取值范围1-7200。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '7200',
'minimum' => '1',
'example' => '5',
],
],
[
'name' => 'HttpTriggerPath',
'in' => 'formData',
'schema' => [
'description' => 'HTTP触发的路径,设置为空字符串表示取消该功能。必须以`/http`开头,不能以`/`结尾,同一个Space下不允许重复,只支持(/)、(-)、(_)、(.)、字母和数字组合,最长不超过128个字符。',
'type' => 'string',
'required' => false,
'example' => '/http/hello',
'maxLength' => 128,
],
],
[
'name' => 'TimingTriggerConfig',
'in' => 'formData',
'schema' => [
'description' => '定时触发配置,设置为空字符串表示取消该功能,配置规则请参见[使用云函数定时触发功能](https://help.aliyun.com/document_detail/160666.htm)。'."\n"
.'>公测版:cron:0 0 */2 * * * ;商业版:0 0 */2 * * *。',
'type' => 'string',
'required' => false,
'example' => 'cron:0 0 * * * *',
],
],
[
'name' => 'TimingTriggerUserPayload',
'in' => 'formData',
'schema' => [
'description' => '定时函数任务自定义参数'."\n"
."\n"
.'>仅商业版支持该功能。',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'InstanceConcurrency',
'in' => 'formData',
'schema' => [
'description' => '单实例允许的最大并发度,默认值为1,取值范围1-20。设置单实例多并发可以降低冷启动的频率,适用于函数中有较多时间在等待下游服务响应的场景,不适用于函数中有共享状态且不能并发访问的场景,也不适用于单个请求的执行要消耗大量CPU及内存资源的场景。'."\n"
."\n\n"
."\n"
.'> '."\n"
.'> - 当设置大于1时要求内存不低于512MB',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '20',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'Runtime',
'in' => 'formData',
'schema' => [
'description' => '云函数执行环境,可选值nodejs12,nodejs14等,具体请参见文档[《运行时支持列表》](https://help.aliyun.com/document_detail/2717618.html)',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'nodejs14' => 'nodejs14',
'nodejs12' => 'nodejs12',
'nodejs16' => 'nodejs16',
],
'example' => 'nodejs14',
'enum' => [
'nodejs8',
'nodejs12',
'nodejs14',
'nodejs16',
'nodejs18',
'nodejs20',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'TimingTriggerConfig' => [
'description' => '定时触发配置。',
'type' => 'string',
'example' => 'cron:0 0 * * * *',
],
'TimingTriggerUserPayload' => [
'description' => '用户自定义定时任务入参,用户可以在云函数中通过`ctx.args.userPayload`取出该参数。',
'type' => 'string',
'example' => '24',
],
'HttpTriggerPath' => [
'description' => 'HTTP触发的路径。',
'type' => 'string',
'example' => '/http/hello',
],
'CreatedAt' => [
'description' => '云函数的创建时间。',
'type' => 'string',
'example' => '2019-06-20T03:22:54.854Z',
],
'Name' => [
'description' => '云函数的名称。',
'type' => 'string',
'example' => 'demoFunction',
],
'ModifiedAt' => [
'description' => '云函数的修改时间。',
'type' => 'string',
'example' => '2019-06-20T03:22:54.854Z',
],
'Desc' => [
'description' => '云函数的描述信息。',
'type' => 'string',
'example' => 'description',
],
'Spec' => [
'description' => '云函数运行参数。',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '超时时间。',
'type' => 'string',
'example' => '5s',
],
'Runtime' => [
'description' => '运行环境。',
'type' => 'string',
'example' => 'Node.js 8',
],
'InstanceConcurrency' => [
'description' => '单实例允许的最大并发度'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Memory' => [
'description' => '内存大小。',
'type' => 'string',
'example' => '128 MB',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"TimingTriggerConfig\\": \\"cron:0 0 * * * *\\",\\n \\"TimingTriggerUserPayload\\": \\"24\\",\\n \\"HttpTriggerPath\\": \\"/http/hello\\",\\n \\"CreatedAt\\": \\"2019-06-20T03:22:54.854Z\\",\\n \\"Name\\": \\"demoFunction\\",\\n \\"ModifiedAt\\": \\"2019-06-20T03:22:54.854Z\\",\\n \\"Desc\\": \\"description\\",\\n \\"Spec\\": {\\n \\"Timeout\\": \\"5s\\",\\n \\"Runtime\\": \\"Node.js 8\\",\\n \\"InstanceConcurrency\\": 1,\\n \\"Memory\\": \\"128 MB\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"2019-06-20T03:22:54.854Z\\nxxx\\n/http/hello\\n319DADF8-0BE9-4AAB-B3C1-4EA07ACE35CE\\n2019-06-20T03:22:54.854Z\\ncron:0 0 * * * *\\n\\n 1\\n Node.js 8\\n 5s\\n 128 MB\\n\\nsayHello","errorExample":""}]',
'title' => '更新函数信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateHttpTriggerConfig' => [
'summary' => '更新云函数的HTTP触发配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'EnableService',
'in' => 'formData',
'schema' => [
'description' => '设置是否开启HTTP触发功能。取值:'."\n"
."\n"
.'- **true**:表示开启HTTP触发功能。'."\n"
.'- **false**:表示关闭HTTP触发功能。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '34C45988-2B24-****-A4DC-4D6C952890D8',
],
],
[
'name' => 'CustomDomain',
'in' => 'formData',
'schema' => [
'description' => '自定义域名。不传该字段表示不更新自定义域名,设置为空字符串表示删除自定义域名。'."\n"
."\n"
.'在绑定自定义域名前,要求您的域名已经接入阿里云备案,并且已配置解析CNAME到CustomDomainCname。',
'type' => 'string',
'required' => false,
'example' => 'abc.xxx.com',
'maxLength' => 253,
],
],
[
'name' => 'CustomDomainCertificate',
'in' => 'formData',
'schema' => [
'description' => '自定义域名的HTTPS证书。必须和CustomDomainPrivateKey一起使用,不传这两个字段表示不更新证书,都传空字符串表示删除证书。',
'type' => 'string',
'required' => false,
'example' => '-----BEGIN CERTIFICATE----- MIIFK****GCSqGSIb3DQEBCwUA= -----END CERTIFICATE-----',
],
],
[
'name' => 'CustomDomainPrivateKey',
'in' => 'formData',
'schema' => [
'description' => '自定义域名的HTTPS证书的私钥。必须和CustomDomainCertificate一起使用,不传这两个字段表示不更新证书,都传空字符串表示删除证书。',
'type' => 'string',
'required' => false,
'example' => '-----BEGIN PRIVATE KEY----- MIIEwA******DmUwVD0M74ECwZw= -----END PRIVATE KEY-----',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EnableService' => [
'description' => '是否开启了HTTP触发功能。',
'type' => 'boolean',
'example' => 'true',
],
'CustomDomainCname' => [
'description' => 'HTTP触发绑定的自定义域名的CNAME地址。',
'type' => 'string',
'example' => '724d************795a2.custom.bspapp.com',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '34C45988-2B24-****-A4DC-4D6C952890D8',
],
'DefaultEndpoint' => [
'description' => 'HTTP触发的默认域名。',
'type' => 'string',
'example' => '724dade5-492f-426b-a5df-ff****0795a2.bspapp.com',
],
'CustomDomainCertificateInfo' => [
'description' => 'HTTP触发绑定的自定义域名的证书信息。',
'type' => 'string',
'example' => '{"notAfter":"2021-09-28T08:21:42Z","notBefore":"2021-06-30T08:21:43Z","subject":"CN=*.example.com"}',
],
'CustomDomain' => [
'description' => 'HTTP触发绑定的自定义域名。',
'type' => 'string',
'example' => 'abc.example.com',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableService\\": true,\\n \\"CustomDomainCname\\": \\"724d************795a2.custom.bspapp.com\\",\\n \\"RequestId\\": \\"34C45988-2B24-****-A4DC-4D6C952890D8\\",\\n \\"DefaultEndpoint\\": \\"724dade5-492f-426b-a5df-ff****0795a2.bspapp.com\\",\\n \\"CustomDomainCertificateInfo\\": \\"{\\\\\\"notAfter\\\\\\":\\\\\\"2021-09-28T08:21:42Z\\\\\\",\\\\\\"notBefore\\\\\\":\\\\\\"2021-06-30T08:21:43Z\\\\\\",\\\\\\"subject\\\\\\":\\\\\\"CN=*.example.com\\\\\\"}\\",\\n \\"CustomDomain\\": \\"abc.example.com\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t226e5213-****-4a52-b4ff-35a09f8a52de.bspapp.com\\n\\t34C45988-2B24-495D-A4DC-4D6C952890D8\\n\\ttrue\\n\\ttrue\\n\\t226e5213-****-4a52-b4ff-35a09f8a52de.custom.bspapp.com\\n \\n\\t\\n","errorExample":""}]',
'title' => '更新云函数的HTTP触发配置',
'description' => '开启HTTP触发功能,系统会为开启HTTP触发功能的Space分配一个默认域名,然后再结合UpdateFunction接口给云函数设置一个触发路径,之后就可以通过HTTP请求来触发云函数调用。您可以绑定自己的域名来使用HTTP触发的功能,要求您的域名必须接入阿里云备案。您还可以给您的自定义域名绑定HTTPS证书,之后可以使用HTTPS协议加自定义域名来访问。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeFunction' => [
'summary' => '查询已创建的云函数详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '云函数名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-8514-xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '75CE67BE-48E9-52AF-B965-4690270CD53A',
],
'Function' => [
'description' => '云函数信息。',
'type' => 'object',
'properties' => [
'TimingTriggerConfig' => [
'description' => '定时触发配置。',
'type' => 'string',
'example' => '公测版:cron:0 0 */2 * * *'."\n"
."\n"
.'商业版:0 0 */2 * * *',
],
'TimingTriggerUserPayload' => [
'description' => '定时触发任务自定义参数'."\n"
.'>仅商业版支持该功能',
'type' => 'string',
'example' => 'hello',
],
'HttpTriggerPath' => [
'description' => 'HTTP触发的路径,设置为空字符串表示取消该功能。必须以`/`开头,不能以`/`结尾,同一个Space下不允许重复,只支持(/)、(-)、(_)、(.)、字母和数字组合,最长不超过128个字符。',
'type' => 'string',
'example' => '/http/getWxToken',
],
'CreatedAt' => [
'description' => '云函数的创建时间。',
'type' => 'string',
'example' => '2021-12-02T02:40:37Z',
],
'Name' => [
'description' => '云函数名称。',
'type' => 'string',
'example' => 'demoFunction',
],
'ModifiedAt' => [
'description' => '云函数的修改时间。',
'type' => 'string',
'example' => '2019-06-21T02:22:53Z',
],
'Desc' => [
'description' => '云函数描述。',
'type' => 'string',
'example' => '获取微信绑定手机号',
],
'Spec' => [
'description' => '运行环境。',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '函数超时时间,单位为秒,默认值为5,取值范围1-10。',
'type' => 'string',
'example' => '5',
],
'Runtime' => [
'description' => '云函数执行环境,默认值为nodejs12,可选值为nodejs8,nodejs12。',
'type' => 'string',
'example' => 'nodejs12',
],
'InstanceConcurrency' => [
'description' => '单实例允许的最大并发度,默认值为1,取值范围1-100。设置单实例多并发可以降低冷启动的频率,适用于函数中有较多时间在等待下游服务响应的场景,不适用于函数中有共享状态且不能并发访问的场景,也不适用于单个请求的执行要消耗大量CPU及内存资源的场景。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Memory' => [
'description' => '函数内存规格,取值为64的倍数,至少128MB,至多2048MB。',
'type' => 'string',
'example' => '512',
],
],
],
],
],
'Deployment' => [
'description' => '部署单详情。',
'type' => 'object',
'properties' => [
'CreatedAt' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-06-11T10:51:19Z',
],
'DeploymentId' => [
'description' => '部署单ID。',
'type' => 'string',
'example' => 'dep-62020d3bea44fd4608118233',
],
'DownloadSignedUrl' => [
'description' => '下载URL。',
'type' => 'string',
'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/xxxx-v2.zip?OSSAccessKeyId=LT*********1DkK6&Expires=1561425220&Signature=xEuiAgUMShQ4v8fYIl3FM8Jp3MA%3D',
],
'VersionNo' => [
'description' => '版本号。版本号是部署单上传的时间。',
'type' => 'string',
'example' => '2019061110511905080',
],
'ModifiedAt' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2019-06-11T10:51:19Z',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75CE67BE-48E9-52AF-B965-4690270CD53A\\",\\n \\"Function\\": {\\n \\"TimingTriggerConfig\\": \\"公测版:cron:0 0 */2 * * *\\\\n\\\\n商业版:0 0 */2 * * *\\",\\n \\"TimingTriggerUserPayload\\": \\"hello\\",\\n \\"HttpTriggerPath\\": \\"/http/getWxToken\\",\\n \\"CreatedAt\\": \\"2021-12-02T02:40:37Z\\",\\n \\"Name\\": \\"demoFunction\\",\\n \\"ModifiedAt\\": \\"2019-06-21T02:22:53Z\\",\\n \\"Desc\\": \\"获取微信绑定手机号\\",\\n \\"Spec\\": {\\n \\"Timeout\\": \\"5\\",\\n \\"Runtime\\": \\"nodejs12\\",\\n \\"InstanceConcurrency\\": 1,\\n \\"Memory\\": \\"512\\"\\n }\\n },\\n \\"Deployment\\": {\\n \\"CreatedAt\\": \\"2019-06-11T10:51:19Z\\",\\n \\"DeploymentId\\": \\"dep-62020d3bea44fd4608118233\\",\\n \\"DownloadSignedUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/xxxx-v2.zip?OSSAccessKeyId=LT*********1DkK6&Expires=1561425220&Signature=xEuiAgUMShQ4v8fYIl3FM8Jp3MA%3D\\",\\n \\"VersionNo\\": \\"2019061110511905080\\",\\n \\"ModifiedAt\\": \\"2019-06-11T10:51:19Z\\"\\n }\\n}","type":"json"}]',
'title' => '查询已创建的云函数详情',
],
'DescribeHttpTriggerConfig' => [
'summary' => '查询云函数的HTTP触发配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '34C45988-2B24-****-A4DC-4D6C952890D8',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EnableService' => [
'description' => '是否开启HTTP触发功能。',
'type' => 'boolean',
'example' => 'true',
],
'CustomDomainCname' => [
'description' => 'Http触发绑定的自定义域名的CNAME地址。',
'type' => 'string',
'example' => '724d************795a2.custom.bspapp.com',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4555773F-769B-4960-87E6-16009E5A4844',
],
'DefaultEndpoint' => [
'description' => '默认域名。',
'type' => 'string',
'example' => '724dade5-492f-426b-a5df-ff****0795a2.bspapp.com',
],
'CustomDomainCertificateInfo' => [
'description' => 'Http触发绑定的自定义域名的证书信息。',
'type' => 'string',
'example' => '{"notAfter":"2021-09-28T08:21:42Z","notBefore":"2021-06-30T08:21:43Z","subject":"CN=*.example.com"}',
],
'CustomDomain' => [
'description' => 'Http触发绑定的自定义域名。',
'type' => 'string',
'example' => 'abc.example.com',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableService\\": true,\\n \\"CustomDomainCname\\": \\"724d************795a2.custom.bspapp.com\\",\\n \\"RequestId\\": \\"4555773F-769B-4960-87E6-16009E5A4844\\",\\n \\"DefaultEndpoint\\": \\"724dade5-492f-426b-a5df-ff****0795a2.bspapp.com\\",\\n \\"CustomDomainCertificateInfo\\": \\"{\\\\\\"notAfter\\\\\\":\\\\\\"2021-09-28T08:21:42Z\\\\\\",\\\\\\"notBefore\\\\\\":\\\\\\"2021-06-30T08:21:43Z\\\\\\",\\\\\\"subject\\\\\\":\\\\\\"CN=*.example.com\\\\\\"}\\",\\n \\"CustomDomain\\": \\"abc.example.com\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t226e5213-697c-****-b4ff-35a09f8a52de.bspapp.com\\r\\n\\t63D32428-3AF4-459F-8FB0-FE7B8A9D9003\\r\\n\\ttrue\\r\\n\\ttrue\\r\\n\\t226e5213-697c-4a52-b4ff-35a09f8a52de.custom.bspapp.com\\r\\n","errorExample":""}]',
'title' => '查询云函数的HTTP触发配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFunction' => [
'summary' => '查询已创建的云函数列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'description' => '页码。从第1页开始。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '每页显示的行数。默认为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'FilterBy',
'in' => 'formData',
'schema' => [
'description' => '查询条件。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'demo',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-****-8a88d205e2b8',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D388FE2B-61D5-4A76-A8F0-xxxx',
],
'Paginator' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '列表的页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '查询的云函数总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '查询的页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'DataList' => [
'description' => '云函数详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TimingTriggerConfig' => [
'description' => '定时触发配置。',
'type' => 'string',
'example' => 'cron:0 0 * * * *',
],
'HttpTriggerPath' => [
'description' => 'HTTP触发的路径。',
'type' => 'string',
'example' => '/http/hello',
],
'CreatedAt' => [
'description' => '云函数创建时间。',
'type' => 'string',
'example' => '2019-06-21T02:22:55.996Z',
],
'ModifiedAt' => [
'description' => '云函数修改时间。',
'type' => 'string',
'example' => '2019-06-21T02:22:55.996Z',
],
'Name' => [
'description' => '云函数名称。',
'type' => 'string',
'example' => 'demoFunction',
],
'Desc' => [
'description' => '云函数描述。',
'type' => 'string',
'example' => 'test',
],
'Spec' => [
'description' => '云函数运行参数。',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '超时时间。',
'type' => 'string',
'example' => '5s',
],
'Runtime' => [
'description' => '运行环境。',
'type' => 'string',
'example' => 'Node.js 8',
],
'InstanceConcurrency' => [
'description' => '单实例允许的最大并发度'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Memory' => [
'description' => '内存大小。',
'type' => 'string',
'example' => '128 MB',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D388FE2B-61D5-4A76-A8F0-xxxx\\",\\n \\"Paginator\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1\\n },\\n \\"DataList\\": [\\n {\\n \\"TimingTriggerConfig\\": \\"cron:0 0 * * * *\\",\\n \\"HttpTriggerPath\\": \\"/http/hello\\",\\n \\"CreatedAt\\": \\"2019-06-21T02:22:55.996Z\\",\\n \\"ModifiedAt\\": \\"2019-06-21T02:22:55.996Z\\",\\n \\"Name\\": \\"demoFunction\\",\\n \\"Desc\\": \\"test\\",\\n \\"Spec\\": {\\n \\"Timeout\\": \\"5s\\",\\n \\"Runtime\\": \\"Node.js 8\\",\\n \\"InstanceConcurrency\\": 1,\\n \\"Memory\\": \\"128 MB\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"319DADF8-0BE9-4AAB-B3C1-4EA07ACE35CE\\n\\n 1\\n 1\\n 10\\n 1\\n\\n","errorExample":""}]',
'title' => '查询已创建的云函数列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFunctionDeployment' => [
'summary' => '查询云函数部署单列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'description' => '列表的页码。起始值:1 默认值:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '9223372036854775807',
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '每页行数。最大值:100 默认值:10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '部署单名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-****-8a88d205e2b8',
],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '部署单元状态,取值:'."\n"
."\n"
.'- DEPLOY_SUCCESS:查询部署成功的部署单。'."\n"
.'- DEPLOY_FAILED:查询部署失败的部署单。'."\n"
."\n"
.'> 如果不指定状态,则查询全部部署单。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'DEPLOY_SUCCESS',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'Paginator' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页行数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '当前页面总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'DataList' => [
'description' => '函数数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreatedAt' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-06-21T02:22:53.309Z',
],
'DeploymentId' => [
'description' => '部署ID。',
'type' => 'string',
'example' => 'dep-5e49fd471c9d4451c33bdd06',
],
'DownloadSignedUrl' => [
'description' => '下载地址。',
'type' => 'string',
'example' => 'http://function-apiserver-test.oss-cn-shanghai.aliyuncs.com/5d0afc0e1c9d44*****32c30a-v5.zip?OSSAccessKeyId=LTA************&Expires=1561425220&Signature=SAgUkZFK54eAbU6TLT9zMZ7S8eg%3D',
],
'VersionNo' => [
'description' => '版本号。',
'type' => 'string',
'example' => '2019061110511930090',
],
'ModifiedAt' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2019-06-21T02:22:55.996Z',
],
'Status' => [
'description' => '状态。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'string',
'example' => 'DEPLOY_SUCCESS',
],
'Label' => [
'description' => '状态描述。',
'type' => 'string',
'example' => '部署成功',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"Paginator\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1\\n },\\n \\"DataList\\": [\\n {\\n \\"CreatedAt\\": \\"2019-06-21T02:22:53.309Z\\",\\n \\"DeploymentId\\": \\"dep-5e49fd471c9d4451c33bdd06\\",\\n \\"DownloadSignedUrl\\": \\"http://function-apiserver-test.oss-cn-shanghai.aliyuncs.com/5d0afc0e1c9d44*****32c30a-v5.zip?OSSAccessKeyId=LTA************&Expires=1561425220&Signature=SAgUkZFK54eAbU6TLT9zMZ7S8eg%3D\\",\\n \\"VersionNo\\": \\"2019061110511930090\\",\\n \\"ModifiedAt\\": \\"2019-06-21T02:22:55.996Z\\",\\n \\"Status\\": {\\n \\"Status\\": \\"DEPLOY_SUCCESS\\",\\n \\"Label\\": \\"部署成功\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"200\\n71F897B5-7078-487E-8029-EE2FD071D203\\n\\n 1\\n 10\\n 1\\n 2\\n\\n\\n\\ntrue\\nOK","errorExample":""}]',
'title' => '查询云函数部署单列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFunctionLog' => [
'summary' => '查询函数执行日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'formData',
'schema' => [
'description' => '页码,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '页大小,默认值为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '函数名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'demoFunction',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间的SpaceID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-****-4cfa-8514-8a88d205e2b8',
],
],
[
'name' => 'LogRequestId',
'in' => 'formData',
'schema' => [
'description' => '函数运行时请求ID。',
'type' => 'string',
'required' => false,
'example' => '0a206a521561344642018387523432',
],
],
[
'name' => 'FromDate',
'in' => 'formData',
'schema' => [
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1560134212326',
],
],
[
'name' => 'ToDate',
'in' => 'formData',
'schema' => [
'description' => '结束时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1560134212326',
],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '状态。可选值:'."\n"
."\n"
.'- SUCCESS :成功'."\n"
.'- FAIL :失败'."\n"
.'- 为空时返回全部',
'type' => 'string',
'required' => false,
'example' => 'SUCCESS',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'Paginator' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageNum' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '当前页面总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'DataList' => [
'description' => '函数数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '函数运行状态。',
'type' => 'string',
'example' => 'SUCCESS',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'dece4ea0-d432-4cfa-8514-8a88d205e2b8',
],
'RequestId' => [
'description' => '函数运行时请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'FunctionName' => [
'description' => '函数名称。',
'type' => 'string',
'example' => 'demoFunction',
],
'Timestamps' => [
'description' => '时间。',
'type' => 'array',
'items' => [
'description' => '日志记录时间。',
'type' => 'string',
'example' => '1545403746724',
],
],
'Contents' => [
'description' => '内容。',
'type' => 'array',
'items' => [
'description' => '日志内容。',
'type' => 'string',
'example' => '2018-12-21 14:49:06.724 INFO Start `hello2` at Fri Dec 21 2018 14:49:06 GMT+0000 (UTC) 2018-12-21 14:49:06.724 INFO Successin 0ms',
],
],
'Levels' => [
'description' => '等级。',
'type' => 'array',
'items' => [
'description' => '日志级别。',
'type' => 'string',
'example' => 'INFO',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"Paginator\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1\\n },\\n \\"DataList\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SpaceId\\": \\"dece4ea0-d432-4cfa-8514-8a88d205e2b8\\",\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"FunctionName\\": \\"demoFunction\\",\\n \\"Timestamps\\": [\\n \\"1545403746724\\"\\n ],\\n \\"Contents\\": [\\n \\"2018-12-21 14:49:06.724 INFO Start `hello2` at Fri Dec 21 2018 14:49:06 GMT+0000 (UTC) 2018-12-21 14:49:06.724 INFO Successin 0ms\\"\\n ],\\n \\"Levels\\": [\\n \\"INFO\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"C293BB03-B6AD-46C2-80D1-19C8FB573916\\n\\n 1\\n 1\\n 10\\n 1\\n\\n","errorExample":""}]',
'title' => '查询函数执行日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeployFunction' => [
'summary' => '触发函数部署。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'DeploymentId',
'in' => 'formData',
'schema' => [
'description' => '部署单ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dep-5e49fd471c9d4451c33bdd06',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dece4ea0-d432-4cfa-****-8a88d205e2b8xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9D653EC3-8F53-4307-9B1C-52F5922384A6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9D653EC3-8F53-4307-9B1C-52F5922384A6\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t9D653EC3-8F53-4307-9B1C-52F5922384A6\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '触发函数部署',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RunFunction' => [
'summary' => '执行函数,同步执行最多支持60秒。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ach41172-adba-4af1-b2e5-63fc5f56a649',
],
],
[
'name' => 'Body',
'in' => 'formData',
'schema' => [
'description' => '格式为 JSON String,functionTarget 为函数名,functionArgs 为传递给函数的参数,格式为 JSON String。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"functionTarget":"test-function","functionArgs":{"a":"aaaa","b":"bbbb","num":100}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F75E60FA-7583-4E2E-AC14-6C608F89804',
],
'Result' => [
'description' => '函数中返回的数据,格式为 JSON String。',
'type' => 'string',
'example' => '{"name":"tom"}',
],
'RuntimeMeta' => [
'description' => '函数运行元数据。',
'type' => 'object',
'properties' => [
'InvocationDuration' => [
'description' => '执行时间,单位毫秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '523',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '980879201561364765437209427735',
],
'BillingDuration' => [
'description' => '计费时间,单位毫秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '600',
],
'MaxMemoryUsage' => [
'description' => '占用内存,单位 MB。',
'type' => 'integer',
'format' => 'int32',
'example' => '27',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F75E60FA-7583-4E2E-AC14-6C608F89804\\",\\n \\"Result\\": \\"{\\\\\\"name\\\\\\":\\\\\\"tom\\\\\\"}\\",\\n \\"RuntimeMeta\\": {\\n \\"InvocationDuration\\": 523,\\n \\"RequestId\\": \\"980879201561364765437209427735\\",\\n \\"BillingDuration\\": 600,\\n \\"MaxMemoryUsage\\": 27\\n }\\n}","errorExample":""},{"type":"xml","example":"{\\"name\\":\\"tom\\"}\\n200\\n780A14D7-D478-4090-AF53-A324A60C0222\\n1\\ntrue\\nOK","errorExample":""}]',
'title' => '执行函数',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDBCollection' => [
'summary' => '接口删除数据库集合。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '92e26ea9-6450-4b40-9c20-xxxx',
],
],
[
'name' => 'Body',
'in' => 'formData',
'schema' => [
'description' => '要删除的数据集。格式为JSON字符串,其中command固定值为drop,collection值为要删除的集合名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"command": "drop", "collection": "table1"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '20C1EDFE-6355-4344-B20A-A7A5A1581026',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20C1EDFE-6355-4344-B20A-A7A5A1581026\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t0\\r\\n\\t20C1EDFE-6355-4344-B20A-A7A5A1581026\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => '删除数据库集合',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RenameDBCollection' => [
'summary' => '重命名集合。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9*****',
],
],
[
'name' => 'OriginCollection',
'in' => 'formData',
'schema' => [
'description' => '原集合名称,需要指定存在的集合名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'coll1',
],
],
[
'name' => 'NewCollection',
'in' => 'formData',
'schema' => [
'description' => '新集合名称,新集合名称不能和现有集合名称相同。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'newColl1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '20C1EDFE-6355-4344-B20A-A7A5A1581026',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20C1EDFE-6355-4344-B20A-A7A5A1581026\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 20C1EDFE-6355-4344-B20A-A7A5A1581026\\n","errorExample":""}]',
'title' => '重命名集合',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RunDBCommand' => [
'summary' => '执行数据库命令。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ach41172-adba-4af1-b2e5-63fc5f56a649',
],
],
[
'name' => 'Body',
'in' => 'formData',
'schema' => [
'description' => '请求数据库时的命令,格式为 JSON String。'."\n"
."\n"
.'包含两个必须字段:'."\n"
."\n"
.'- command: 包含集合操作、索引操作、数据操作命令。'."\n"
."\n"
.'集合操作命令:'."\n"
.'- collections: 获取集合列表;'."\n"
.'- createCollection: 创建集合,需要字段 name,待创建集合的名称;'."\n"
."\n"
.'索引操作命令:'."\n"
.'- listIndexes: 获取索引列表,需要字段 collection;'."\n"
.'- createIndex: 创建索引,需要字段 collection,field,options;'."\n"
.'- dropIndex: 删除索引,需要 dropIndex 字段;'."\n"
."\n"
.'数据操作命令:'."\n"
.'- 支持 find,insertOne,replaceOne等,需要collection字段、options字段,每个命令有不同的 options,具体内容参考开发指南;'."\n"
."\n"
.'例如:'."\n"
.'- command 参数为 find 时,需要 query 字段'."\n"
.'- command 参数为 replaceOne 时,需要 filter 和 doc 字段',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"command":"findOne","collection":"test_collection","query":{"name":"tome"}}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F75E60FA-7583-4E2E-AC14-6C608F89804',
],
'Result' => [
'description' => '数据库返回结果,格式为 JSON String。',
'type' => 'string',
'example' => '{"_id":"5d107e5af957c439d505b95b","age":1,"name":"aaaaa","time":1561362071732}',
],
'AffectedDocs' => [
'description' => '此次操作影响的数据库文档数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F75E60FA-7583-4E2E-AC14-6C608F89804\\",\\n \\"Result\\": \\"{\\\\\\"_id\\\\\\":\\\\\\"5d107e5af957c439d505b95b\\\\\\",\\\\\\"age\\\\\\":1,\\\\\\"name\\\\\\":\\\\\\"aaaaa\\\\\\",\\\\\\"time\\\\\\":1561362071732}\\",\\n \\"AffectedDocs\\": 1\\n}","errorExample":""},{"type":"xml","example":"{\\"_id\\":\\"5d107e5af957c439d505b95b\\",\\"age\\":1,\\"name\\":\\"aaaaa\\",\\"text\\":\\"Mon Jun 24 2019 15:41:11 GMT+0800 (CST)\\",\\"time\\":1561362071732}\\n200\\n780A14D7-D478-4090-AF53-A324A60C0222\\n1\\ntrue\\nOK","errorExample":""}]',
'title' => '执行数据库命令',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '该接口功能较复杂,以下举例说明部分使用方法,供参考:'."\n"
."\n"
.'### 获取集合列表'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"collections\\"}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs":5,'."\n"
.' "RequestId":"4CFE11BE-536C-58DD-****",'."\n"
.' "Success":true,'."\n"
.' "Result":"[\\"album\\",\\"photo\\",\\"test\\",\\"users\\",\\"wallpaper\\"]"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 创建集合'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"createCollection\\", \\"name\\":\\"mytable\\"}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs":1,'."\n"
.' "RequestId":"042ED29A-3148-5133-ABEA-****",'."\n"
.' "Success":true,'."\n"
.' "Result":"[\\"mytable\\"]"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 创建索引'."\n"
."\n"
.'给集合mytable创建非唯一组合索引,按照userId升序、userName降序。'."\n"
."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"createIndex\\", \\"collection\\":\\"mytable\\", \\"field\\":{\\"userId\\":1,\\"userName\\":-1}, \\"options\\":{\\"name\\":\\"idx-userid-username\\", \\"unique\\":false} }"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs":0,'."\n"
.' "RequestId":"C67E7C63-EB30-506E-BF28-****",'."\n"
.' "Success":true,'."\n"
.' "Result":"idx-userid-username"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 获取索引列表'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"listIndexes\\", \\"collection\\":\\"mytable\\"}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs": 2,'."\n"
.' "RequestId": "8B8F315A-FBCA-560E-8C85-****",'."\n"
.' "Success": true,'."\n"
.' "Result": "[{\\"v\\":2,\\"key\\":{\\"_id\\":1},\\"name\\":\\"_id_\\",\\"ns\\":\\"db_ALYEZT****_mp-c68e6766-2bda-4263-916d-****.mytable\\"},{\\"v\\":2,\\"key\\":{\\"userId\\":1,\\"userName\\":-1},\\"name\\":\\"idx-userid-username\\",\\"ns\\":\\"db_ALYEZT****_mp-c68e6766-2bda-4263-916d-****.mytable\\"}]"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 删除索引'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"dropIndex\\", \\"collection\\":\\"mytable\\", \\"indexName\\":\\"idx-userid-username\\"}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs": 0,'."\n"
.' "RequestId": "1EE343F7-9DE8-534C-AE12-****",'."\n"
.' "Success": true'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 插入一条数据'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"insertOne\\", \\"collection\\":\\"mytable\\", \\"doc\\":{\\"userId\\":1, \\"userName\\":\\"张三\\"}}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs": 1,'."\n"
.' "RequestId": "B1032DBA-51CF-5E47-91C5-****",'."\n"
.' "Success": true,'."\n"
.' "Result": "{\\"insertedId\\":\\"636496e2f43e60aba4939f5f\\",\\"ok\\":1,\\"n\\":1}"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 查询前十条数据'."\n"
.'params入参:'."\n"
.'```'."\n"
.'{'."\n"
.' "SpaceId": "mp-c68e6766-2bda-4263-916d-****",'."\n"
.' "Body": "{\\"command\\":\\"find\\", \\"collection\\":\\"mytable\\", \\"query\\":{}, \\"options\\":{\\"skip\\":0, \\"limit\\":10}}"'."\n"
.'}'."\n"
.'```'."\n"
.'data结果:'."\n"
.'```'."\n"
.'{'."\n"
.' "AffectedDocs": 2,'."\n"
.' "RequestId": "AB1F4B1C-F6E6-5E49-AB4B-****",'."\n"
.' "Success": true,'."\n"
.' "Result": "[{\\"_id\\":\\"636496e2f43e60aba4939f5f\\",\\"userName\\":\\"张三\\",\\"userId\\":1},{\\"_id\\":\\"636496ef819ce88b66f34b6d\\",\\"userName\\":\\"李四\\",\\"userId\\":2}]"'."\n"
.'}'."\n"
.'```',
],
'CreateDBRestoreTask' => [
'summary' => '创建集合回档任务。创建回档任务成功后,会返回任务ID。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'BackupId',
'in' => 'formData',
'schema' => [
'description' => '备份文件ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '20201118114602_6bd7c996-f620-4026-ae24-418eddf78671',
],
],
[
'name' => 'OriginCollections',
'in' => 'formData',
'schema' => [
'description' => '待回档集合名称,多个集合用英文逗号分隔,例如`coll1,coll2`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'coll1,coll2',
],
],
[
'name' => 'NewCollections',
'in' => 'formData',
'schema' => [
'description' => '回档后的集合名称,不能和数据库中现有的文档名称相同,与originCollections一一对应,多个集合用英文逗号分隔,例如`newColl1,newColl2`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'newColl1,newColl2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '0150006d-ab93-4920-a63e-c011dea1e089',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"0150006d-ab93-4920-a63e-c011dea1e089\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 58881468-E779-4203-B933-BD53FDC60D6F\\r\\n 0150006d-ab93-4920-a63e-c011dea1e089\\r\\n","errorExample":""}]',
'title' => '创建集合回档任务',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDBBackupCollections' => [
'summary' => '根据备份ID来查询备份的集合。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
],
[
'name' => 'BackupId',
'in' => 'formData',
'schema' => [
'description' => '备份文件ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '20201118114602_6bd7c996-f620-4026-ae24-418eddf78671',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'Collections' => [
'description' => '已备份的集合列表。',
'type' => 'array',
'items' => [
'description' => '已备份的集合列表。',
'type' => 'string',
'example' => 'coll1',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Collections\\": [\\n \\"coll1\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 58881468-E779-4203-B933-BD53FDC60D6F\\n coll1\\n coll2\\n","errorExample":""}]',
'title' => '根据备份ID来查询备份的集合',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDBRestoreTaskStatus' => [
'summary' => '查询集合回档任务状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0150006d-ab93-4920-a63e-c011dea1e089',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '回档任务状态。可选值如下:'."\n"
.'- NEW:新创建,导出任务不可能出现此状态。'."\n"
.'- WAITING:排队中,任务较多时可能会出现。'."\n"
.'- RUNNING:执行中。'."\n"
.'- SUCCESS:成功。'."\n"
.'- FAILED:失败。'."\n"
."\n"
.'> 注意任务状态变成**SUCCESS**或者**FAILED**都应该中止轮询。',
'type' => 'string',
'example' => 'SUCCESS',
],
'FailedCount' => [
'description' => '回档失败的数据库记录数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'DetailMessage' => [
'description' => '任务失败时的错误信息。',
'type' => 'string',
'example' => 'SERVER_BUSY',
],
'SuccessCount' => [
'description' => '成功回档的数据库记录数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TaskId.NotFound',
'errorMessage' => 'The specified TaskId does not exist.',
],
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"SUCCESS\\",\\n \\"FailedCount\\": 1,\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"DetailMessage\\": \\"SERVER_BUSY\\",\\n \\"SuccessCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 58881468-E779-4203-B933-BD53FDC60D6F\\n SUCCESS\\n 1\\n 0\\n","errorExample":""}]',
'title' => '查询集合回档任务状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDBBackupDumpTimes' => [
'summary' => '查询备份时间和备份ID,默认保存最近7天的备份记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'BackupDumpTimes' => [
'description' => '备份记录集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BackupId' => [
'description' => '备份记录ID。',
'type' => 'string',
'example' => '20201118114602_6bd7c996-f620-4026-ae24-418eddf78671',
],
'DumpTime' => [
'description' => '备份时间。',
'type' => 'string',
'example' => '2020-11-18T03:46:02Z',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"BackupDumpTimes\\": [\\n {\\n \\"BackupId\\": \\"20201118114602_6bd7c996-f620-4026-ae24-418eddf78671\\",\\n \\"DumpTime\\": \\"2020-11-18T03:46:02Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 58881468-E779-4203-B933-BD53FDC60D6F\\n \\n 2020-11-18T03:46:02Z\\n 20201118114602_6bd7c996-f620-4026-ae24-418eddf78671\\n \\n \\n 2020-11-18T04:05:28Z\\n 20201118120527_6bd7c996-f620-4026-ae24-418eddf78671\\n \\n","errorExample":""}]',
'title' => '查询备份时间和备份ID',
'description' => '> 该接口返回的备份时间是开始执行备份任务的时间,因备份任务执行需要一定的时间,并不代表备份内容正好是备份时间的快照。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateDBExportTask' => [
'summary' => '创建数据库导出任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'Collection',
'in' => 'formData',
'schema' => [
'description' => '集合名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'article',
],
],
[
'name' => 'FileType',
'in' => 'formData',
'schema' => [
'description' => '导出文件类型。可选值为:'."\n"
.'- JSON'."\n"
.'- CSV',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CSV',
'enum' => [
'JSON',
'CSV',
],
],
],
[
'name' => 'Fields',
'in' => 'formData',
'schema' => [
'description' => '导出的字段列表,以逗号(,)分隔。当文件类型为CSV时该字段必选。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'name,content',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '0150006d-ab93-4920-a63e-c011dea1e089',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"TaskId\\": \\"0150006d-ab93-4920-a63e-c011dea1e089\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0150006d-ab93-4920-a63e-c011dea1e089\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
'title' => '创建数据库导出任务',
'description' => '> 创建导出任务成功后,您可以调用QueryDBExportTaskStatus接口来查询导出任务状态,数据导出成功后,会返回一个地址供您下载导出后的文件。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateDBImportTask' => [
'summary' => '创建数据库导入任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'Collection',
'in' => 'formData',
'schema' => [
'description' => '集合名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'FileType',
'in' => 'formData',
'schema' => [
'description' => '导入文件类型,可选值为:'."\n"
.'- JSON'."\n"
.'- CSV',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CSV',
'enum' => [
'JSON',
'CSV',
],
],
],
[
'name' => 'Mode',
'in' => 'formData',
'schema' => [
'description' => '冲突处理模式,可选值为:'."\n"
.'- INSERT(默认) :导入出现冲突则忽略。'."\n"
.'- UPSERT:导入出现冲突则使用文件中的内容更新。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'UPSERT',
'enum' => [
'INSERT',
'UPSERT',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Host' => [
'description' => '上传文件使用的Host。'."\n"
.'>该接口返回的文件上传Host站点配有跨域限制规则,仅允许官方console.aliyun.com网站直传文件。不可用于三方网站文件直传。不影响非网页端文件上传。>',
'type' => 'string',
'example' => 'https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com',
],
'ExpireTime' => [
'description' => '上传文件的过期时间。',
'type' => 'string',
'example' => '2020-07-20T05:32:03Z',
],
'FileKey' => [
'description' => '上传文件使用的FileKey。',
'type' => 'string',
'example' => 'mongo/import/0e16bb12-14af-4635-b24c-5ac1a9*****/20200720130203_973820af-966d-42ec-9fab-17dfe4a******.csv',
],
'AccessKeyId' => [
'description' => '上传文件使用的AccessKeyId。',
'type' => 'string',
'example' => 'LTAI****************',
],
'Signature' => [
'description' => '上传文件使用的Signature。',
'type' => 'string',
'example' => '*****luWDvbmhqwwy9pm/Mso++pk=',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '692DCFEF-46DD-4EBB-B1DB-338E687DC260',
],
'Policy' => [
'description' => '上传文件使用的Policy。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjjoiMjAyMC0wNy0yMFQwNTozMjowMy40NDVaIiwiY29uZGl0aW9ucyI*****Y29udGVudC1sZW5ndoiMjAyMC==',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '973820af-966d-42ec-9fab-17dfe4a*****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Host\\": \\"https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"2020-07-20T05:32:03Z\\",\\n \\"FileKey\\": \\"mongo/import/0e16bb12-14af-4635-b24c-5ac1a9*****/20200720130203_973820af-966d-42ec-9fab-17dfe4a******.csv\\",\\n \\"AccessKeyId\\": \\"LTAI****************\\",\\n \\"Signature\\": \\"*****luWDvbmhqwwy9pm/Mso++pk=\\",\\n \\"RequestId\\": \\"692DCFEF-46DD-4EBB-B1DB-338E687DC260\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjjoiMjAyMC0wNy0yMFQwNTozMjowMy40NDVaIiwiY29uZGl0aW9ucyI*****Y29udGVudC1sZW5ndoiMjAyMC==\\",\\n \\"TaskId\\": \\"973820af-966d-42ec-9fab-17dfe4a*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n eyJleHBpcmF0aW9uIjjoiMjAyMC0wNy0yMFQwNTozMjowMy40NDVaIiwiY29uZGl0aW9ucyI*****Y29udGVudC1sZW5ndoiMjAyMC==\\n mongo/import/0e16bb12-14af-4635-b24c-5ac1a9*****/20200720130203_973820af-966d-42ec-9fab-17dfe4a******.csv\\n 973820af-966d-42ec-9fab-17dfe4a*****\\n 692DCFEF-46DD-4EBB-B1DB-338E687DC260\\n LTAIupaslTlU*****\\n *****luWDvbmhqwwy9pm/Mso++pk=\\n https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com\\n 2020-07-20T05:32:03Z\\n","errorExample":""}]',
'title' => '创建数据库导入任务',
'description' => '创建导入任务成功后,将会返回任务ID、上传文件的地址和鉴权信息。您需要在要求的时间内向给定的地址上传需要导入的文件。上传文件成功之后,您需要调用QueryDBImportTaskStatus接口来触发运行导入任务,并查询数据导入状态。 '."\n"
.'上传文件时,请求方法请使用POST方法,Content-Type指定为`multipart/form-data`。下面是使用curl命令上传文件的一个示例。'."\n"
.'```'."\n"
.'curl -X POST \\'."\n"
.'-H \'Content-Type: multipart/form-data\' \\'."\n"
.'-F \'key=${FileKey}\' \\'."\n"
.'-F \'policy=${Policy}\' \\'."\n"
.'-F \'OSSAccessKeyId=${AccessKeyId}\' \\'."\n"
.'-F \'Signature=${Signature}\' \\'."\n"
.'-F \'file=@${FilePath}\' \\'."\n"
.'\'${Host}\''."\n"
.'```'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDBExportTaskStatus' => [
'summary' => '查询数据库导出任务状态,若任务执行成功会同时返回文件下载链接,若失败会返回失败原因。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9*****',
],
],
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0150006d-ab93-4920-a63e-c011dea*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ExportedCount' => [
'description' => '导出记录数,仅当任务状态为SUCCESS时返回。',
'type' => 'string',
'example' => '2',
],
'Status' => [
'description' => '任务状态,有以下几种类型:'."\n"
.'- WAITING:排队中,当前任务还未开始执行。'."\n"
.'- RUNNING:执行中。'."\n"
.'- SUCCESS:成功。'."\n"
.'- FAILED:失败。',
'type' => 'string',
'example' => 'SUCCESS',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '58881468-E779-4203-B933-BD53FDC60D6F',
],
'DownloadUrl' => [
'description' => '下载链接,仅当任务状态为SUCCESS时返回。',
'type' => 'string',
'example' => 'https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com/mongo/export/0e16bb12-14af-4635-b24c-5ac1a9a7bb9f/20200720104406_0150006d-ab93-4920-a63e-c011dea1e089.csv?Expires=1595215206&OSSAccessKeyId=LTAI****************&Signature=CKxpKX3Wj%2BLVtZ****%2FTbe%2BX9sc%3D',
],
'DetailMessage' => [
'description' => '任务失败时的错误信息。',
'type' => 'string',
'example' => ' SERVER_BUSY',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TaskId.NotFound',
'errorMessage' => 'The specified TaskId does not exist.',
],
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ExportedCount\\": \\"2\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"58881468-E779-4203-B933-BD53FDC60D6F\\",\\n \\"DownloadUrl\\": \\"https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com/mongo/export/0e16bb12-14af-4635-b24c-5ac1a9a7bb9f/20200720104406_0150006d-ab93-4920-a63e-c011dea1e089.csv?Expires=1595215206&OSSAccessKeyId=LTAI****************&Signature=CKxpKX3Wj%2BLVtZ****%2FTbe%2BX9sc%3D\\",\\n \\"DetailMessage\\": \\" SERVER_BUSY\\"\\n}","errorExample":""},{"type":"xml","example":"\\n SUCCESS\\n 2\\n 58881468-E779-4203-B933-BD53FDC60D6F\\n https://mps-zjk-share.oss-cn-zhangjiakou.aliyuncs.com/mongo/export/0e16bb12-14af-4635-b24c-5ac1a9a7bb9f/20200720104406_0150006d-ab93-4920-a63e-c011dea1e089.csv?Expires=1595215206&OSSAccessKeyId=LTAIupaslTlU****&Signature=CKxpKX3Wj%2BLVtZ****%2FTbe%2BX9sc%3D\\n","errorExample":""}]',
'title' => '查询数据库导出任务状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDBImportTaskStatus' => [
'summary' => '查询数据库导入状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasA7J3YO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '973820af-966d-42ec-9fab-17dfe4a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务执行状态。可选值为:'."\n"
.'- NEW: 新创建,创建了任务但是未上传文件,或者文件未上传完成。'."\n"
.'- WAITING:排队中,当前任务还未开始执行。'."\n"
.'- RUNNING:执行中。'."\n"
.'- SUCCESS:成功。'."\n"
.'- FAILED:失败。',
'type' => 'string',
'example' => 'SUCCESS',
],
'FailedCount' => [
'description' => '失败记录数。',
'type' => 'string',
'example' => '0',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '692DCFEF-46DD-4EBB-B1DB-338E687DC260',
],
'DetailMessage' => [
'description' => '任务失败时的错误信息。',
'type' => 'string',
'example' => 'SERVER_BUSY',
],
'SuccessCount' => [
'description' => '成功记录数。',
'type' => 'string',
'example' => '6',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'TaskId.NotFound',
'errorMessage' => 'The specified TaskId does not exist.',
],
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"SUCCESS\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"RequestId\\": \\"692DCFEF-46DD-4EBB-B1DB-338E687DC260\\",\\n \\"DetailMessage\\": \\"SERVER_BUSY\\",\\n \\"SuccessCount\\": \\"6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n SUCCESS\\n 692DCFEF-46DD-4EBB-B1DB-338E687DC260\\n 0\\n 2\\n","errorExample":""}]',
'title' => '查询数据库导入状态',
'description' => '> 上传文件后第一次调用会触发导入任务执行,建议您在上传导入文件成功之后调用该接口,若任务执行成功会同时返回导入成功和失败的记录数,若任务失败会返回失败原因。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFile' => [
'summary' => '删除文件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => [
'description' => '- 按照文件ID删除单个文件,文件唯一标识,例如: ef69b85f-****-4942-8a0f-211a82b48ec7'."\n"
.'- 按照目录结构删除文件,传入目录前缀并以 "/" 结尾,当目录文件过多时请耐心等待,例如:images/'."\n"
.'- 支持同时删除多个文件和多个目录,文件ID以及目录前缀使用半角逗号(,)分隔。最多同时删除50个项目,例如: ef69b85f-****-4942-8a0f-211a82b48ec7,images/,docs/',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c568f23d-a46f-4866-****-142e5eb3e174',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F655A8D5-B967-440B-8683-DAD6FF8DE990\\n","errorExample":""}]',
'title' => '删除文件',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RegisterFile' => [
'summary' => 'RegisterFile注册文件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => [
'description' => '唯一标识。取值为DescribeFileUploadSignedUrl接口返回的ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2fada31e-8fa5-****-b595-9698cd6b5f06',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-****-4635-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CEF72CEB-54B6-4AE8-B225-F876FF7BA984',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CEF72CEB-54B6-4AE8-B225-F876FF7BA984\\"\\n}","errorExample":""},{"type":"xml","example":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984","errorExample":""}]',
'title' => '注册文件',
'description' => '>最新版本上传文件采用 OSS CallBack 机制,不再需要调用该接口注册文件。>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeFileUploadSignedUrl' => [
'summary' => '获取上传文件需要的签名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Filename',
'in' => 'formData',
'schema' => [
'description' => '- 原始的文件名称。'."\n"
.'- 当以"/"结尾时,创建一个空文件夹,支持多级子文件夹。创建文件夹时,不返回文件签名,自动完成创建。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'wlop29.jpg',
],
],
[
'name' => 'Size',
'in' => 'formData',
'schema' => [
'description' => '文件大小,单位字节。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '41836',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'mp-0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'ContentType',
'in' => 'formData',
'schema' => [
'description' => '文件类型:.pdf .xls .xlsx .doc .docx .ppt .pptx .txt',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'png',
],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => [
'description' => '自定义上传文件路径,支持多级目录,路径支持字母、数字、中文、横线、下横线、点符号,总长度不超过1024,必须以"/"开头,例如:'."\n"
.'`/abc/edf/hello.jpg`'."\n"
."\n"
.'> - 当该文件路径已存在文件时会直接覆盖 '."\n"
.'> - 另外也支持传入fileId或者文件URL覆盖已有文件',
'type' => 'string',
'required' => false,
'example' => '/abc/edf/hello.jpg',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SignUrl' => [
'description' => '上传文件地址。',
'type' => 'string',
'example' => 'https://bsppub.oss-cn-shanghai.aliyuncs.com/FBPSBVMO-myspace/41552d60-52de-xxx-a713-43e879b0717a.JPG?OSSAccessKeyId=LTAI****************&Expires=1582152512&Signature=sek1B0Xm2r***tNvfX9tX%2BBJxA%3D',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E9A50E1B-5ECE-42D4-B261-C07D1BBE68DE',
],
'Id' => [
'description' => '文件唯一标识。',
'type' => 'string',
'example' => '2fada31e-8fa5-****-b595-9698cd6b5f06',
],
'OssCallbackUrl' => [
'description' => '上传结果回调地址。',
'type' => 'string',
'example' => 'https://api.next.bspapp.com/oss_upload_callback',
],
'Overwrite' => [
'description' => '含义是该上传请求是否会覆盖文件。'."\n"
.'- true:覆盖。'."\n"
.'- false:不覆盖。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SignUrl\\": \\"https://bsppub.oss-cn-shanghai.aliyuncs.com/FBPSBVMO-myspace/41552d60-52de-xxx-a713-43e879b0717a.JPG?OSSAccessKeyId=LTAI****************&Expires=1582152512&Signature=sek1B0Xm2r***tNvfX9tX%2BBJxA%3D\\",\\n \\"RequestId\\": \\"E9A50E1B-5ECE-42D4-B261-C07D1BBE68DE\\",\\n \\"Id\\": \\"2fada31e-8fa5-****-b595-9698cd6b5f06\\",\\n \\"OssCallbackUrl\\": \\"https://api.next.bspapp.com/oss_upload_callback\\",\\n \\"Overwrite\\": true\\n}","type":"json"}]',
'title' => '获取上传文件需要的签名',
'responseParamsDescription' => '在获取到上传文件地址 SignUrl 之后,需要使用 PUT 对该地址上传文件。 PUT请求必须在headers携带回调地址参数,该参数构造方法如下: '."\n"
.'- 第一步:构造字符串 ` {"callbackUrl":"....","callbackBody":"{\\"fileId\\":\\"....\\",\\"spaceId\\":\\"....\\"}","callbackBodyType":"application/json"}` 分别将参数 OssCallbackUrl、Id以及SpaceId替换到上面的空缺部分。'."\n"
.'- 第二步:对上述字符串进行 base64编码。'."\n"
.'- 第三步:在上传文件时添加header `x-oss-callback`,值为第二步计算得到的字符串。'."\n"
."\n"
.'>请求参数ContentType也是签名计算的一部分,因此在上传文件时您需要添加header **Content-Type**,并确保值和入参一致。>',
],
'ListFile' => [
'summary' => '查询文件列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-xxxx-5ac1a9a7bb9f',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '每页行数,默认值为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => [
'description' => '关键字。',
'type' => 'string',
'required' => false,
'example' => '关键字1',
],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => [
'description' => '要查询的文件的ID/URL。'."\n"
.'支持同时查询多个文件,多个文件ID使用半角逗号(,)分隔。最多可以设置50个文件ID/文件URL。',
'type' => 'string',
'required' => false,
'example' => 'id1',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '用来标记当前开始读取的位置。置空表示从头开始。'."\n"
.'>仅商业版支持该功能',
'type' => 'string',
'required' => false,
'example' => 'CAESBgoEIgIIABgAIrQBCrEBA6wAAAAxTDdmZmZmZmZmZjg5OWJlMzguUzZkNzAyZDY2Mz***',
],
],
[
'name' => 'Mode',
'in' => 'formData',
'schema' => [
'description' => '文件列表模式,可选值为:'."\n"
.'- DEFAULT(默认) :默认模式,所有文件按照上传时间倒序展示。'."\n"
.'- DIRECTORY:文件夹模式。',
'type' => 'string',
'required' => false,
'example' => 'DIRECTORY',
'enum' => [
'DEFAULT',
'DIRECTORY',
],
],
],
[
'name' => 'Prefix',
'in' => 'formData',
'schema' => [
'description' => '路径前缀。默认查询根目录。',
'type' => 'string',
'required' => false,
'example' => '/images',
],
],
[
'name' => 'AuthDelta',
'in' => 'formData',
'schema' => [
'description' => '鉴权有效时间,单位秒。只有在您开启了CDN配置中的鉴权功能时有效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1800',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FE88BEC8-8F83-408A-9ED3-771C510C705F',
],
'Paginator' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '用来标记当前开始读取的位置。置空表示从头开始。'."\n"
.'> 仅商业版支持该功能',
'type' => 'string',
'example' => 'eyJhY2NvdW50IjoiMTE2MTQwNTMxMDE0OTY2OCIsImV2ZW50SWQiOiIzMkI3QTE1Mi05NUJFLTUyNkMtQjEyNC00RUYxRDk2RDM4QkEiLCJsb2dJZCI6IjE0LTExNjE0MDUzMTAxNDk2NjgiLCJ0aW1lIjoxNjM1MjEzMzk0MDAwfQ',
],
],
],
'DataList' => [
'description' => '数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '文件类型。包含两个保留类型:'."\n"
."\n"
.'- directory: 文件夹,此时只有Name字段值有效,为文件夹名称。'."\n"
.'- only\\_in\\_oss: 数据不一致的文件,出现的原因是用户上传该文件之后没有完成注册导致的数据不一致现象,一般处理方式是删除重新上传。',
'type' => 'string',
'example' => 'JPG',
],
'Size' => [
'description' => '文件大小。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-01-16T05:45:33.000Z',
],
'Url' => [
'description' => '文件下载链接。',
'type' => 'string',
'example' => 'https://fbpxxx.cdn.bspapp.com/FBPSBVMO-myspace/68dbd670-3823-11ea-bfb9-xxxx.JPG',
],
'GmtModified' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-01-16T05:45:33.000Z',
],
'Name' => [
'description' => '文件名称。',
'type' => 'string',
'example' => '1579153532001.JPG',
],
'Id' => [
'description' => '唯一标识。',
'type' => 'string',
'example' => 'c568f23d-a46f-4866-xxxx-142e5eb3e174',
],
'AuthDelta' => [
'description' => '鉴权有效时间,单位秒。只有在您开启了CDN配置中的鉴权功能时有效。',
'type' => 'integer',
'format' => 'int32',
'example' => '1800',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FE88BEC8-8F83-408A-9ED3-771C510C705F\\",\\n \\"Paginator\\": {\\n \\"PageSize\\": 10,\\n \\"NextToken\\": \\"eyJhY2NvdW50IjoiMTE2MTQwNTMxMDE0OTY2OCIsImV2ZW50SWQiOiIzMkI3QTE1Mi05NUJFLTUyNkMtQjEyNC00RUYxRDk2RDM4QkEiLCJsb2dJZCI6IjE0LTExNjE0MDUzMTAxNDk2NjgiLCJ0aW1lIjoxNjM1MjEzMzk0MDAwfQ\\"\\n },\\n \\"DataList\\": [\\n {\\n \\"Type\\": \\"JPG\\",\\n \\"Size\\": 1000,\\n \\"GmtCreate\\": \\"2020-01-16T05:45:33.000Z\\",\\n \\"Url\\": \\"https://fbpxxx.cdn.bspapp.com/FBPSBVMO-myspace/68dbd670-3823-11ea-bfb9-xxxx.JPG\\",\\n \\"GmtModified\\": \\"2020-01-16T05:45:33.000Z\\",\\n \\"Name\\": \\"1579153532001.JPG\\",\\n \\"Id\\": \\"c568f23d-a46f-4866-xxxx-142e5eb3e174\\",\\n \\"AuthDelta\\": 1800\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n FE88BEC8-8F83-408A-9ED3-771C510C705F\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n","errorExample":""}]',
'title' => '查询文件列表',
],
'DescribeCdnDomain' => [
'summary' => '查询CDN域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'TenantId',
'in' => 'formData',
'schema' => [
'description' => '租户 ID。',
'type' => 'string',
'required' => false,
'example' => 'UNIGTXQTAO',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间 ID。',
'type' => 'string',
'required' => true,
'example' => 'mp-05c3aa1c-****-43ae-a03d-61eff91c592e',
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '支持对云存储和静态网站自定义域名进行管理:'."\n"
.'- FILE 云存储CDN'."\n"
.'- WEB 静态网站托管CDN(前提是已经绑定自定义CDN)',
'type' => 'string',
'required' => true,
'example' => 'FILE',
'enum' => [
'FILE',
'WEB',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间 ID。',
'type' => 'string',
'example' => 'mp-65e6491b-****-4c2e-b202-7f0036eb2713',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E8A2FA95-6F70-****-971C-34C27485441D',
],
'ServiceStatus' => [
'description' => '- IN_SERVICE:CDN服务中。'."\n"
.'- PAUSED:CDN已停止服务,请检查您的账户余额、套餐到期日或者资源用量是否超额。',
'type' => 'string',
'example' => 'IN_SERVICE',
],
'DomainName' => [
'description' => 'CDN域名。',
'type' => 'string',
'example' => 'mp-65e6491b-****-4c2e-b202-7f0036eb2713.cdn.bspapp.com',
],
'CorsConfig' => [
'description' => '跨域配置。',
'type' => 'object',
'properties' => [
'AllowOrigin' => [
'description' => '设置跨域校验规则,默认为“*”,跨域校验规则为:'."\n"
.'- 设置为“\\*”,不论用户请求里面是否携带“Origin”参数,也不论携带的“Origin”参数为何值,都固定返回“Access-Control-Allow-Origin:*”。'."\n"
.'- 跨域资源共享的响应头值设置了单个或者多个值(多个值之间用“,”分隔)。'."\n"
.' - 如果用户请求头里携带的“Origin”参数值与被设置的任意一个值精确匹配,就会响应对应的跨域头。'."\n"
.' - 如果都没有精确匹配上,则不响应跨域头。'."\n"
.'- 设置为通配符域名,则会校验请求头中Origin值是否能匹配上。',
'type' => 'string',
'example' => 'https://www.baidu.com',
],
'ConfigId' => [
'description' => '配置ID。',
'type' => 'string',
'example' => '274436853071****',
],
'AccessOriginControl' => [
'description' => '- true:开启跨域验证,每次请求都会检查是否符合跨域规则。'."\n"
.'- false:不开启跨域校验,固定返回已配置的跨域头。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'RefererConfig' => [
'description' => '防盗链配置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '- white: 白名单'."\n"
.'- black: 黑名单'."\n"
.'> 黑名单和白名单互斥,同一时间您只能选择其中一种方式。',
'type' => 'string',
'example' => 'white',
],
'ReferList' => [
'description' => '名单列表,多个用半角逗号(,)分隔。'."\n"
.'> Referer防盗链规则的总长度最长不超过60 KB。',
'type' => 'string',
'example' => 'a*b.example.com',
],
'AllowEmpty' => [
'description' => '是否允许空referer字段访问CDN资源。取值:'."\n"
.'- on:允许。'."\n"
.'- off(默认值):禁止。',
'type' => 'string',
'example' => 'on',
],
'DisableAst' => [
'description' => '是否使用精确匹配模式,控制“名单列表”项中填写的域名是否为精确匹配。如果勾选(on)则精确匹配域名。'."\n"
.'- 取值为on时:'."\n"
.' - 支持精确匹配。'."\n"
.' - 名单列表填写example.com,匹配example.com。'."\n"
.' - 名单列表填写a*b.example.com,匹配a<任意字符>b.example.com。'."\n"
.' - 不支持后缀匹配。'."\n"
.'- 取值为off(默认值)时:'."\n"
.' - 不支持精确匹配。'."\n"
.' - 支持后缀匹配。'."\n"
.' - 名单列表填写example.com,匹配example.com和<任意字符>.example.com。'."\n"
.' - 名单列表填写a*b.example.com,匹配a<任意字符>b.example.com和<任意字符>.a<任意字符>b.example.com。',
'type' => 'string',
'example' => 'a*b.example.com',
],
'ConfigId' => [
'description' => '配置ID。',
'type' => 'string',
'example' => '28048528682****',
],
],
],
'IpConfig' => [
'description' => 'IP黑白名单配置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '- white: 白名单'."\n"
.'- black: 黑名单'."\n"
."\n"
.'> 黑名单和白名单互斥,同一时间您只能选择其中一种方式。',
'type' => 'string',
'example' => 'black',
],
'IpList' => [
'description' => '- IP列表,多个用半角逗号(,)分隔。支持设置网段。'."\n"
.'- 最多可配置约700个IPv6地址,2000个IPv4地址。'."\n"
."\n"
.'更多参考:[IP地址校验模式](https://help.aliyun.com/document_detail/27138.htm#section-6dp-9h1-ty3)。',
'type' => 'string',
'example' => '183.157.108.82,140.205.147.26',
],
'ConfigId' => [
'description' => '配置ID。',
'type' => 'string',
'example' => '25623800702****',
],
],
],
'UaConfig' => [
'description' => 'UA客户端标识黑白名单配置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '- white: 白名单'."\n"
.'- black: 黑名单'."\n"
."\n"
.'> 黑名单和白名单互斥,同一时间您只能选择其中一种方式。',
'type' => 'string',
'example' => 'white',
],
'UaList' => [
'description' => '填写User-Agent,支持通配符号*(匹配任意字符串)和多个值(多个值用|分割。例如:\\*curl\\*|\\*IE\\*|\\*chrome\\*|\\*firefox\\*)。'."\n"
.'> 如果您需要对用户请求中携带了User-Agent请求头,但是值为空的情况做访问控制,您可以使用参数this-is-empty-ua来表示User-Agent值为空。',
'type' => 'string',
'example' => '*curl*|*IE*|*chrome*|*firefox*',
],
'ConfigId' => [
'description' => '配置ID。',
'type' => 'string',
'example' => '25950108534****',
],
],
],
'AuthConfig' => [
'description' => 'CDN鉴权配置,仅“FILE”模式下有效。',
'type' => 'object',
'properties' => [
'AuthType' => [
'description' => '鉴权类型,枚举值:'."\n"
.'- no_auth 当前未开启鉴权。'."\n"
.'- type_a A方式鉴权。'."\n"
.'- type_b B方式鉴权。'."\n"
.'- ype_c C方式鉴权。'."\n"
."\n"
.'更多参考:[鉴权方式及原理说明](https://help.aliyun.com/document_detail/85113.htm)。',
'type' => 'string',
'example' => 'no_auth',
],
'AuthKey' => [
'description' => '鉴权密钥,6~128位,用于计算鉴权签名。',
'type' => 'string',
'example' => 'SL4ZB****',
],
'AuthDelta' => [
'description' => '鉴权默认有效时长(秒)。',
'type' => 'integer',
'format' => 'int32',
'example' => '3600',
],
'configId' => [
'description' => '配置ID。',
'type' => 'string',
'example' => '25950108534****'."\n",
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SpaceId\\": \\"mp-65e6491b-****-4c2e-b202-7f0036eb2713\\",\\n \\"RequestId\\": \\"E8A2FA95-6F70-****-971C-34C27485441D\\",\\n \\"ServiceStatus\\": \\"IN_SERVICE\\",\\n \\"DomainName\\": \\"mp-65e6491b-****-4c2e-b202-7f0036eb2713.cdn.bspapp.com\\",\\n \\"CorsConfig\\": {\\n \\"AllowOrigin\\": \\"https://www.baidu.com\\",\\n \\"ConfigId\\": \\"274436853071****\\",\\n \\"AccessOriginControl\\": true\\n },\\n \\"RefererConfig\\": {\\n \\"Type\\": \\"white\\",\\n \\"ReferList\\": \\"a*b.example.com\\",\\n \\"AllowEmpty\\": \\"on\\",\\n \\"DisableAst\\": \\"a*b.example.com\\",\\n \\"ConfigId\\": \\"28048528682****\\"\\n },\\n \\"IpConfig\\": {\\n \\"Type\\": \\"black\\",\\n \\"IpList\\": \\"183.157.108.82,140.205.147.26\\",\\n \\"ConfigId\\": \\"25623800702****\\"\\n },\\n \\"UaConfig\\": {\\n \\"Type\\": \\"white\\",\\n \\"UaList\\": \\"*curl*|*IE*|*chrome*|*firefox*\\",\\n \\"ConfigId\\": \\"25950108534****\\"\\n },\\n \\"AuthConfig\\": {\\n \\"AuthType\\": \\"no_auth\\",\\n \\"AuthKey\\": \\"SL4ZB****\\",\\n \\"AuthDelta\\": 3600,\\n \\"configId\\": \\"25950108534****\\\\n\\"\\n }\\n}","type":"json"}]',
'title' => '获取CDN配置',
'description' => '获取CDN域名配置信息。',
],
'SaveCdnDomainConfig' => [
'summary' => '配置CDN。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasXYAKDO',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'TenantId',
'in' => 'formData',
'schema' => [
'description' => '租户 ID。',
'type' => 'string',
'required' => false,
'example' => 'UNIULEH***',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'example' => 'mp-03c11beb-****-4d02-bb40-65a7ad224f4d',
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '- FILE 配置云存储CDN。'."\n"
.'- WEB 配置静态网站托管CDN。',
'type' => 'string',
'required' => true,
'example' => 'FILE',
'enum' => [
'FILE',
'WEB',
],
],
],
[
'name' => 'CorsConfig',
'in' => 'formData',
'schema' => [
'description' => '- 设置跨域: {"allowOrigin":"https://*.example.com", "accessOriginControl": true} 。'."\n"
.'- 删除跨域'."\n"
.' - 方式1:{"type":"remove", "configId": "268021436***"}。'."\n"
.' - 方式2:{"allowOrigin":"", "configId": "268021436***"}。',
'type' => 'string',
'required' => false,
'example' => ' {"allowOrigin":"https://*.example.com", "accessOriginControl": true} ',
],
],
[
'name' => 'RefererConfig',
'in' => 'formData',
'schema' => [
'description' => '- 设置白名单'."\n"
.' {"type":"white", "referList":"example.com", "allowEmpty":"off", "disableAst":"off"}'."\n"
.'- 设置黑名单'."\n"
.' {"type":"black", "referList":"example.com", "allowEmpty":"off", "disableAst":"off"}'."\n"
.'- 删除配置'."\n"
.' {"type":"remove", "configId": "268021436***"}',
'type' => 'string',
'required' => false,
'example' => ' {"type":"white", "referList":"example.com", "allowEmpty":"off", "disableAst":"off"}',
],
],
[
'name' => 'IpConfig',
'in' => 'formData',
'schema' => [
'description' => '- 设置白名单'."\n"
.' {"type":"white", "ipList":"192.168.2.0/24"}'."\n"
.'- 设置黑名单'."\n"
.' {"type":"black", "ipList":"192.168.2.0/24"}'."\n"
.'- 删除配置'."\n"
.' {"type":"remove", "configId": "268021436***"}',
'type' => 'string',
'required' => false,
'example' => ' {"type":"white", "ipList":"192.168.2.0/24"}',
],
],
[
'name' => 'UaConfig',
'in' => 'formData',
'schema' => [
'description' => '- 设置白名单'."\n"
.' {"type":"white", "uaList":"\\*IE\\*|\\*firefox\\*"}'."\n"
.'- 设置黑名单'."\n"
.' {"type":"black", "uaList":"\\*IE\\*|\\*firefox\\*"}'."\n"
.'- 删除配置'."\n"
.' {"type":"remove", "configId": "268021436***"}',
'type' => 'string',
'required' => false,
'example' => ' {"type":"white", "uaList":"*IE*|*firefox*"}',
],
],
[
'name' => 'AuthConfig',
'in' => 'formData',
'schema' => [
'description' => '配置鉴权模式,仅“FILE”模式下有效。当开启鉴权模式后,您必须按照鉴权加签算法完成URL签名计算后才能访问文件。您可以通过服务面接口 file.info 或者管控面接口 ListFile 接口快捷获取加签后的URL。'."\n"
.'- 开启鉴权模式,设置URL默认有效时长1800秒,方式A鉴权'."\n"
.' {"authType":"type_a", "authKey":"hkpyytgrnf", "authDelta":1800}'."\n"
.'- 关闭鉴权模式'."\n"
.' {"authType":"no_auth"}',
'type' => 'string',
'required' => false,
'example' => '{"authType":"type_a", "authKey":"hkpyytgrnf", "authDelta":1800}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '9B1D280D-F8C8-****-B30F-BDE5A981FDA9',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B1D280D-F8C8-****-B30F-BDE5A981FDA9\\"\\n}","type":"json"}]',
'title' => '保存CDN配置',
'requestParamsDescription' => 'Refer和IP在配置白名单时,如果存在黑名单配置需要手动删掉。同理配置黑名单时如果存在白名单也需要手动删掉。 UA黑白名单支持覆盖,无需手动删。',
],
'DeleteWebHostingFile' => [
'summary' => '删除静态网站托管下的文件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'FilePath',
'in' => 'formData',
'schema' => [
'description' => '文件路径。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '/error.jpg',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0e16bb12-14af-4635-b24c-5ac1a9a*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n DB14BED4-ABB5-4033-920F-E22E52580911\\r\\n 200\\r\\n true\\r\\n success\\r\\n true\\r\\n","errorExample":""}]',
'title' => '删除静态网站托管下的文件',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BatchDeleteWebHostingFiles' => [
'summary' => '批量删除静态网站托管下的文件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'FilePaths',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '需要删除的文件路径。',
'type' => 'array',
'items' => [
'description' => '需要删除的文件路径。',
'type' => 'string',
'required' => false,
'example' => 'static/index.870cf761.js',
],
'required' => true,
'example' => '/static/test.png',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0e16bb12-14af-4635-b24c-5ac1a9a*****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n true\\r\\n 0e16bb12-14af-4635-b24c-5ac1a9a*****\\r\\n","errorExample":""}]',
'title' => '批量删除静态网站托管下的文件',
'requestParamsDescription' => '例如您需要批量删除两个文件a和b,参数FilePaths的传参格式如下:'."\n"
.'`{"FilePaths.1": "a", "FilePaths.2": "b" }`',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListWebHostingFiles' => [
'summary' => '分页获取网站静态文件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'Prefix',
'in' => 'formData',
'schema' => [
'description' => '路径前缀。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '/',
],
],
[
'name' => 'Marker',
'in' => 'formData',
'schema' => [
'description' => '分页游标。取值为上一页返回的NextMarker的值,当获取第一页时,取空字符串。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****/test/error1.png',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '分页大小,默认50,最大500。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '500',
'minimum' => '1',
'example' => '100',
'default' => '50',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '93FC5921-2A54-408B-B360-2E5C93488CF4',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'NextMarker' => [
'description' => '分页标记,标记当前分页请求到的最后一条数据。',
'type' => 'string',
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****/test/error1.png',
],
'Count' => [
'description' => '返回数据总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'WebHostingFiles' => [
'description' => '静态网站文件信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FilePath' => [
'description' => '文件路径。',
'type' => 'string',
'example' => 'error/error.jpg',
],
'ContentType' => [
'description' => '文件类型。',
'type' => 'string',
'example' => 'image/png',
],
'ETag' => [
'description' => '标记。',
'type' => 'string',
'example' => 'test',
],
'Size' => [
'description' => '文件大小,单位字节。',
'type' => 'integer',
'format' => 'int64',
'example' => '235628',
],
'LastModifiedTime' => [
'description' => '上一次修改文件时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1590398956000',
],
'SignedUrl' => [
'description' => '文件下载URL,有效时间30分钟。',
'type' => 'string',
'example' => 'http://fbpsbvmo-15415903938*****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/test/error.jpg?Expires=1590462873&OSSAccessKeyId=STS.NT9oaFvbRzj8vSViJL2y*****&Signature=pSMbsZUZGwfZEcvT9R7VZPMp%2BVA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5eMJNvym71zzajTdHXnjUoZPvYVjIHgpjz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOgBG3HPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAZ6L6gVhZYEK78ZBsQq1hP9nvtEGENelJYiTPWAHmB1mDutOaEzgSpwVMaP3FWpMTy6KgBKMox1NJLUZJK23NlJIlMIJ8lVyCQOG4Ig7oTXTbFc0PQMShK%2FeQIQ2WvZ2x%2F%2FZdgaZIeQR4WnawsWF%2BYC4ScTig0wYTuaLx7pH2WHJ',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93FC5921-2A54-408B-B360-2E5C93488CF4\\",\\n \\"Data\\": {\\n \\"NextMarker\\": \\"0e16bb12-14af-4635-b24c-5ac1a9a*****/test/error1.png\\",\\n \\"Count\\": 50,\\n \\"WebHostingFiles\\": [\\n {\\n \\"FilePath\\": \\"error/error.jpg\\",\\n \\"ContentType\\": \\"image/png\\",\\n \\"ETag\\": \\"test\\",\\n \\"Size\\": 235628,\\n \\"LastModifiedTime\\": 1590398956000,\\n \\"SignedUrl\\": \\"http://fbpsbvmo-15415903938*****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/test/error.jpg?Expires=1590462873&OSSAccessKeyId=STS.NT9oaFvbRzj8vSViJL2y*****&Signature=pSMbsZUZGwfZEcvT9R7VZPMp%2BVA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5eMJNvym71zzajTdHXnjUoZPvYVjIHgpjz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOgBG3HPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAZ6L6gVhZYEK78ZBsQq1hP9nvtEGENelJYiTPWAHmB1mDutOaEzgSpwVMaP3FWpMTy6KgBKMox1NJLUZJK23NlJIlMIJ8lVyCQOG4Ig7oTXTbFc0PQMShK%2FeQIQ2WvZ2x%2F%2FZdgaZIeQR4WnawsWF%2BYC4ScTig0wYTuaLx7pH2WHJ\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 077C43E6-95E9-40FC-A796-B2CFBD63C2D6\\n 200\\n \\n \\n error.html\\n http://fbpsbvmo-154159039388****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/error.html?Expires=1590460358&OSSAccessKeyId=STS.NUcPHyHQr2xQ6zAe5ybi*****&Signature=b2L4kBEFrA2EZvZbm3B%2FyNSxVeA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\n text/html\\n 172\\n 1590399001000\\n \\n \\n index.html\\n http://fbpsbvmo-154159039388****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a7*****/index.html?Expires=1590460358&OSSAccessKeyId=STS.NUcPHyHQr2xQ6zAe5ybi*****&Signature=w7ke9GsiFjb2bR7bQNOOTk4nlbA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\n text/html\\n 166\\n 1590398956000\\n \\n 2\\n \\n success\\n true\\n","errorExample":""}]',
'title' => '分页获取网站静态文件',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeWebHostingFile' => [
'summary' => '查询静态网站托管下的一个文件详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'FilePath',
'in' => 'formData',
'schema' => [
'description' => '文件路径,必传参数。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '/error.png',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '93FC5921-2A54-408B-B360-2E5C93488CF4',
],
'Data' => [
'description' => '返回的文件详情。',
'type' => 'object',
'properties' => [
'FilePath' => [
'description' => '文件路径。',
'type' => 'string',
'example' => '/error.png',
],
'ContentType' => [
'description' => '文件类型。',
'type' => 'string',
'example' => 'image/png',
],
'ETag' => [
'description' => '标记。',
'type' => 'string',
'example' => 'test',
],
'Size' => [
'description' => '文件大小,单位字节。',
'type' => 'integer',
'format' => 'int64',
'example' => '235628',
],
'Exists' => [
'description' => '文件路径是否存在。如果查询一个不存在的文件路径,该字段将返回为false,其他字段为空。',
'type' => 'boolean',
'example' => 'true',
],
'LastModifiedTime' => [
'description' => '上一次修改文件时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1590398956000',
],
'SignedUrl' => [
'description' => '文件签名URL,有效时间30分钟。',
'type' => 'string',
'example' => 'http://fbpsbvmo-154159039388****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/error.png?Expires=1590460358&OSSAccessKeyId=STS.NUcPHyHQr2xQ6zAe5ybi*****&Signature=b2L4kBEFrA2EZvZbm3B%2FyNSxVeA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93FC5921-2A54-408B-B360-2E5C93488CF4\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"/error.png\\",\\n \\"ContentType\\": \\"image/png\\",\\n \\"ETag\\": \\"test\\",\\n \\"Size\\": 235628,\\n \\"Exists\\": true,\\n \\"LastModifiedTime\\": 1590398956000,\\n \\"SignedUrl\\": \\"http://fbpsbvmo-154159039388****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/error.png?Expires=1590460358&OSSAccessKeyId=STS.NUcPHyHQr2xQ6zAe5ybi*****&Signature=b2L4kBEFrA2EZvZbm3B%2FyNSxVeA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 077C43E6-95E9-40FC-A796-B2CFBD63C2D6\\n \\n true\\n test\\n /error.png\\n 1590398956000\\n http://fbpsbvmo-154159039388****-static.oss-cn-zhangjiakou.aliyuncs.com/0e16bb12-14af-4635-b24c-5ac1a9a*****/error.png?Expires=1590460358&OSSAccessKeyId=STS.NUcPHyHQr2xQ6zAe5ybi*****&Signature=b2L4kBEFrA2EZvZbm3B%2FyNSxVeA%3D&security-token=CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\n image/png\\n 235628\\n \\n","errorExample":""}]',
'title' => '查询静态网站托管下的文件详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetWebHostingUploadCredential' => [
'summary' => '获取静态网站托管的上传文件凭证。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'FilePath',
'in' => 'formData',
'schema' => [
'description' => '文件路径。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '/',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '93FC5921-2A54-408B-B360-2E5C93488CF4',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'FilePath' => [
'description' => '文件路径。',
'type' => 'string',
'example' => '/',
],
'Signature' => [
'description' => '文件上传临时凭证的签名信息,用于上传时验证合法性。',
'type' => 'string',
'example' => 'w7ke9GsiFjb2bR7bQNOOTk4nlbA',
],
'Policy' => [
'description' => '请求表单域的合法性校验策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMC0wNS0yNlQwNjozMjoxOC43NTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLHsia2V5IjoiMGUxNmJiMTItMTRhZi00NjM1LWIyNGMtNWFjMWE5YTdiYjlmL2Zvcm1hdC5qc29uIn1dfQ==',
],
'SecurityToken' => [
'description' => '文件上传临时凭证的安全令牌。',
'type' => 'string',
'example' => 'CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv',
],
'ExpiredTime' => [
'description' => '过期时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1590460358',
],
'Endpoint' => [
'description' => '上传文件的目标地址。',
'type' => 'string',
'example' => 'fbpsbvmo-154159039388***-static.oss-cn-zhangjiakou.aliyuncs.com',
],
'AccessKeyId' => [
'description' => '文件上传临时凭证的AccessKeyId。',
'type' => 'string',
'example' => 'STS.NUcPHyHQr2xQ6zAe5ybi*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93FC5921-2A54-408B-B360-2E5C93488CF4\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"/\\",\\n \\"Signature\\": \\"w7ke9GsiFjb2bR7bQNOOTk4nlbA\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMC0wNS0yNlQwNjozMjoxOC43NTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLHsia2V5IjoiMGUxNmJiMTItMTRhZi00NjM1LWIyNGMtNWFjMWE5YTdiYjlmL2Zvcm1hdC5qc29uIn1dfQ==\\",\\n \\"SecurityToken\\": \\"CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\",\\n \\"ExpiredTime\\": 1590460358,\\n \\"Endpoint\\": \\"fbpsbvmo-154159039388***-static.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"AccessKeyId\\": \\"STS.NUcPHyHQr2xQ6zAe5ybi*****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 93FC5921-2A54-408B-B360-2E5C93488CF4\\n 200\\n \\n /\\n eyJleHBpcmF0aW9uIjoiMjAyMC0wNS0yNlQwNjozMjoxOC43NTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLHsia2V5IjoiMGUxNmJiMTItMTRhZi00NjM1LWIyNGMtNWFjMWE5YTdiYjlmL2Zvcm1hdC5qc29uIn1dfQ==\\n CAISgQJ1q6Ft5B2yfSjIr5bWG%2FLNpY5Thbq6NFzwgTUsbuZ4grfe0Tz2IHBEeXRuA%2B0WsvQ%2Bnm9X6vgelqFZYqRoYGHiUZOjKEbIPUXzDbDasumZsJYm6vT8a0XxZjf%2F2MjNGZabKPrWZvaqbX3diyZ32sGUXD6%2BXlujQ%2Fbr4NwdGbZxZASjaidcD9p7PxZrrNRgVUHcLvGwKBXn8AGyZQhKwlMh1ToiuPzkk5bMukuE1gXAp7VL99irEP%2BNdNJxOZpzadCx0dFte7DJuCwqsEgaqfoo1vEUpWeW5I7CXwcN%2BWePN%2BvF79tuIEpwae0gEqsBtv%2F4mLhxtunSkZQQTrutnEPAOhqAAU49tl4awl%2F0fID3wRpPDCKqg%2BfXifeRRPI2Tr%2Bm4PmK4qPffsI%2F5JXB4JA71uN5TkvMC6LxxTuQnJaTateDrfEDnzyyIVISjvQ7rzt8sxZCnDDfjzx6Lc5TAELuapDjeXK6w%2BWkbhwBTWcjrGAJvdaOA4IodaPZyDlyhO4jt1nv\\n fbpsbvmo-154159039388***-static\\n fbpsbvmo-154159039388***-static.oss-cn-zhangjiakou.aliyuncs.com\\n STS.NUcPHyHQr2xQ6zAe5ybi*****\\n w7ke9GsiFjb2bR7bQNOOTk4nlbA\\n 1590460358\\n \\n success\\n true\\n","errorExample":""}]',
'title' => '获取静态网站托管的上传文件凭证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '文件上传方法示例:'."\n"
.'```nodejs'."\n"
.'async function uploadFile(file) {'."\n"
.' try {'."\n"
.' // 1. 获取上传凭证'."\n"
.' const credentials = await getUploadCredentials();'."\n"
.' '."\n"
.' // 2. 构建上传表单'."\n"
.' const formData = new FormData();'."\n"
.' formData.append(\'policy\', credentials.Policy);'."\n"
.' formData.append(\'OSSAccessKeyId\', credentials.AccessKeyId);'."\n"
.' formData.append(\'success_action_status\', \'200\');'."\n"
.' formData.append(\'signature\', credentials.Signature);'."\n"
.' formData.append(\'x-oss-security-token\', credentials.SecurityToken);'."\n"
.' formData.append(\'key\', credentials.FilePath + file.name);'."\n"
.' // 注意:file字段必须位于最后'."\n"
.' formData.append(\'file\', file);'."\n"
.' '."\n"
.' // 3. 执行上传'."\n"
.' const uploadResponse = await fetch(`https://${credentials.Endpoint}`, {'."\n"
.' method: \'POST\','."\n"
.' body: formData'."\n"
.' });'."\n"
.' '."\n"
.' if (uploadResponse.status === 200) {'."\n"
.' const fileUrl = `https://${credentials.Endpoint}/${credentials.FilePath}${file.name}`;'."\n"
.' console.log(\'文件上传成功:\', fileUrl);'."\n"
.' return {'."\n"
.' success: true,'."\n"
.' url: fileUrl,'."\n"
.' filename: file.name'."\n"
.' };'."\n"
.' } else {'."\n"
.' throw new Error(`上传失败,状态码: ${uploadResponse.status}`);'."\n"
.' }'."\n"
.' '."\n"
.' } catch (error) {'."\n"
.' console.error(\'文件上传失败:\', error);'."\n"
.' return {'."\n"
.' success: false,'."\n"
.' error: error.message'."\n"
.' };'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'extraInfo' => ' ',
],
'BindWebHostingCustomDomain' => [
'summary' => '添加自定义域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'CustomDomain',
'in' => 'formData',
'schema' => [
'description' => '自定义域名(已备案的)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\r\\n 200\\r\\n true\\r\\n success\\r\\n true\\r\\n","errorExample":""}]',
'title' => '添加自定义域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindWebHostingCustomDomain' => [
'summary' => '删除一个自定义域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'CustomDomain',
'in' => 'formData',
'schema' => [
'description' => '自定义域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\r\\n 200\\r\\n true\\r\\n success\\r\\n true\\r\\n","errorExample":""}]',
'title' => '删除一个自定义域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveWebHostingCustomDomainConfig' => [
'summary' => '保存域名配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'ForceRedirectType',
'in' => 'formData',
'schema' => [
'description' => '强制跳转选项。'."\n"
.'- HTTPS_FORCE:强制跳转。'."\n"
.'- OFF:不跳转(默认)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HTTPS_FORCE',
'enum' => [
'HTTPS_FORCE',
'OFF',
],
],
],
[
'name' => 'DomainName',
'in' => 'formData',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '828A8808-3FC9-418C-893A-5A708CFABB8E',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"828A8808-3FC9-418C-893A-5A708CFABB8E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 0e16bb12-14af-4635-b24c-5ac1a9a*****\\r\\n","errorExample":""}]',
'title' => '保存域名配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'VerifyWebHostingDomainOwner' => [
'summary' => '验证Web主机域名所有者。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '226e5213-697c-****-b4ff-35a09f8a52de',
],
],
[
'name' => 'Domain',
'in' => 'formData',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'VerifyType',
'in' => 'formData',
'schema' => [
'description' => 'DNS校验方式。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dnsCheck',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '74374923-6536-46EB-8639-409384EAE980',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74374923-6536-46EB-8639-409384EAE980\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 74374923-6536-46EB-8639-409384EAE980\\n","errorExample":""}]',
'title' => '验证 Web 主机域名所有者',
],
'GetWebHostingDomainVerificationContent' => [
'summary' => '获取域名归属校验内容。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'Domain',
'in' => 'formData',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '74374923-6536-46EB-8639-409384EAE980',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Content' => [
'description' => '域名归属校验记录值。',
'type' => 'string',
'example' => 'verify_c28a8e24b4bc9fab22d949cebdb1d7ae',
],
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74374923-6536-46EB-8639-409384EAE980\\",\\n \\"Data\\": {\\n \\"Content\\": \\"verify_c28a8e24b4bc9fab22d949cebdb1d7ae\\",\\n \\"Domain\\": \\"example.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 74374923-6536-46EB-8639-409384EAE980\\n \\n verify_c28a8e24b4bc9fab22d949cebdb1d7ae\\n example.com\\n \\n","errorExample":""}]',
'title' => '获取主机域名验证内容',
],
'ListWebHostingCustomDomains' => [
'summary' => '查询当前静态网站绑定的自定义域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '93FC5921-2A54-408B-B360-2E5C93488CF4',
],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '域名状态。'."\n"
.'- online:正常运行。'."\n"
.'- offline:已停用。'."\n"
.'- configuring:配置中。'."\n"
.'- configure_failed:配置失败。'."\n"
.'- disabling:停用中。'."\n"
.'- checking:审核中。'."\n"
.'- check_failed:审核失败。',
'type' => 'string',
'example' => 'online',
],
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'www.test.com',
],
'UpdateTime' => [
'description' => '修改时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1590470646143',
],
'SslProtocol' => [
'description' => 'HTTPS开启状态。'."\n"
.'- on:开启。'."\n"
.'- off:关闭。',
'type' => 'string',
'example' => 'off',
],
'ForceRedirectType' => [
'description' => '可选参数为:'."\n"
.'- HTTPS_FORCE: 强制跳转HTTPS。'."\n"
.'- OFF:不跳转。',
'type' => 'string',
'example' => 'HTTPS_FORCE',
],
'Description' => [
'description' => '域名描述。',
'type' => 'string',
'example' => '测试域名',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1590470646000',
],
'Cname' => [
'description' => '别名记录值。',
'type' => 'string',
'example' => 'www.test.com.w.kunlungr.com',
],
'EnableCors' => [
'description' => '当前是否开启跨域',
'type' => 'boolean',
'example' => 'true',
],
'AccessControlAllowOrigin' => [
'description' => '跨域规则',
'type' => 'string',
'example' => 'https://*.example.com, https://*.example.org',
],
'AccessOriginControl' => [
'description' => '当开启跨域检查后,是否检查Origin字段。'."\n"
."\n"
.'- true: 只有在校验通过后才会返回跨域头;'."\n"
.'- false: 不检查Origin字段,固定返回配置的跨域头;',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"93FC5921-2A54-408B-B360-2E5C93488CF4\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"online\\",\\n \\"Domain\\": \\"www.test.com\\",\\n \\"UpdateTime\\": 1590470646143,\\n \\"SslProtocol\\": \\"off\\",\\n \\"ForceRedirectType\\": \\"HTTPS_FORCE\\",\\n \\"Description\\": \\"测试域名\\",\\n \\"CreateTime\\": 1590470646000,\\n \\"Cname\\": \\"www.test.com.w.kunlungr.com\\",\\n \\"EnableCors\\": true,\\n \\"AccessControlAllowOrigin\\": \\"https://*.example.com, https://*.example.org\\",\\n \\"AccessOriginControl\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 93FC5921-2A54-408B-B360-2E5C93488CF4\\n 200\\n \\n online\\n true\\n off\\n OFF\\n 测试域名\\n 1590470646000\\n 1590470646143\\n https://*.example.com, https://*.example.org\\n www.test.com\\n www.test.com.w.kunlungr.com\\n \\n success\\n true\\n","errorExample":""}]',
'title' => '查询当前静态网站自定义域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RefreshWebHostingCustomDomainCache' => [
'summary' => '用于刷新静态网站托管自定义加速域名 CDN 缓存,让您最新上传的文件立即生效。每小时限制调用三次。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'DomainName',
'in' => 'formData',
'schema' => [
'description' => '静态网站托管自定义域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'E63E7F4F-8538-5B0E-8712-78F92B6DCB9C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\"\\n}","type":"json"}]',
'title' => '刷新静态网站CDN缓存',
'description' => '> 仅商业版支持该功能',
],
'DeleteWebHostingCertificate' => [
'summary' => '解绑证书,关闭HTTPS访问。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'Domain',
'in' => 'formData',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'D85CAE0D-5B1F-4A56-B776-DEEA2B232E9F',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"D85CAE0D-5B1F-4A56-B776-DEEA2B232E9F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\r\\n 200\\r\\n true\\r\\n success\\r\\n true\\r\\n","errorExample":""}]',
'title' => '解绑证书',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AttachWebHostingCertificate' => [
'summary' => '调用AttachWebHostingCertificate绑定证书。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'Domain',
'in' => 'formData',
'schema' => [
'description' => '自定义域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
[
'name' => 'CertType',
'in' => 'formData',
'schema' => [
'description' => '证书类型,可取值为:'."\n"
.'- upload:上传证书。'."\n"
.'- cas:已有证书。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'upload',
'enum' => [
'upload',
],
],
],
[
'name' => 'CertName',
'in' => 'formData',
'schema' => [
'description' => '证书名称。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'testCert',
],
],
[
'name' => 'ServerCertificate',
'in' => 'formData',
'schema' => [
'description' => '证书内容。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----',
],
],
[
'name' => 'PrivateKey',
'in' => 'formData',
'schema' => [
'description' => '证书私钥。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '-----BEGIN RSA PRIVATE KEY----- ...... -----END RSA PRIVATE KEY-----',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'CEF9831B-A6D2-4485-9CAD-1B8FBC8B****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"CEF9831B-A6D2-4485-9CAD-1B8FBC8B****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n CEF9831B-A6D2-4485-9CAD-1B8FBC8B****\\n","errorExample":""}]',
'title' => 'AttachWebHostingCertificate',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetWebHostingCertificateDetail' => [
'summary' => '查询自定义域名关联的证书详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'CustomDomain',
'in' => 'formData',
'schema' => [
'description' => '自定义域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'D85CAE0D-5B1F-4A56-B776-DEEA2B232E9F',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'CertLife' => [
'description' => '证书有效期。',
'type' => 'string',
'example' => '1 years',
],
'CertType' => [
'description' => '证书类型。'."\n"
.'- upload:上传证书。'."\n"
.'- cas:云盾证书。',
'type' => 'string',
'example' => 'upload',
],
'CertDomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'www.example.com',
],
'ServerCertificateStatus' => [
'description' => '域名的证书绑定状态。'."\n"
.'- off:无证书。'."\n"
.'- on:已绑定证书。',
'type' => 'string',
'example' => 'on',
],
'CertName' => [
'description' => '证书名称。',
'type' => 'string',
'example' => 'test',
],
'CertExpiredTime' => [
'description' => '证书过期时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1621252800000',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D85CAE0D-5B1F-4A56-B776-DEEA2B232E9F\\",\\n \\"Data\\": {\\n \\"CertLife\\": \\"1 years\\",\\n \\"CertType\\": \\"upload\\",\\n \\"CertDomainName\\": \\"www.example.com\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"CertName\\": \\"test\\",\\n \\"CertExpiredTime\\": 1621252800000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D85CAE0D-5B1F-4A56-B776-DEEA2B232E9F\\n 200\\n \\n 1 years\\n 1621252800000\\n www.example.com\\n upload\\n test\\n on\\n \\n success\\n true\\n","errorExample":""}]',
'title' => '查询自定义域名关联的证书详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveWebHostingCustomDomainCorsConfig' => [
'summary' => '设置静态网站的跨域配置。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID',
'type' => 'string',
'required' => true,
'example' => '226e5213-697c-4a52-b4ff-35a09f8*****',
],
],
[
'name' => 'DomainName',
'in' => 'formData',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'www.example.com',
],
],
[
'name' => 'EnableCors',
'in' => 'formData',
'schema' => [
'description' => '设置是否开启跨域功能,取值为:'."\n"
."\n"
.'- true:开启跨域功能。'."\n"
.'- false:不开启跨域功能。',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'AccessControlAllowOrigin',
'in' => 'formData',
'schema' => [
'description' => '设置跨域校验规则,默认为“*”,跨域校验规则为:'."\n"
.'- 设置为“*”,不论用户请求里面是否携带“Origin”参数,也不论携带的“Origin”参数为何值,都固定返回“Access-Control-Allow-Origin:\\*”。'."\n"
.'- 跨域资源共享的响应头值设置了单个或者多个值(多个值之间用“,”分隔)。'."\n"
.' - 如果用户请求头里携带的“Origin”参数值与被设置的任意一个值精确匹配,就会响应对应的跨域头。'."\n"
.' - 如果都没有精确匹配上,则不响应跨域头。 '."\n"
.'- 设置为通配符域名,则会校验请求头中Origin值是否能匹配上',
'type' => 'string',
'required' => false,
'example' => 'https://*.example.com, https://*.example.org',
],
],
[
'name' => 'AccessOriginControl',
'in' => 'formData',
'schema' => [
'description' => '当开启跨域检查后,是否检查Origin字段。'."\n"
.'- true: 只有在校验通过后才会返回跨域头;'."\n"
.'- false: 不检查Origin字段,固定返回配置的跨域头;'."\n"
."\n"
.'可选值,默认为true。只有在开启跨域功能后该字段才有作用。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => [
'title' => 'Id of the request',
'description' => '请求返回状态。'."\n"
.'- success:成功。'."\n"
.'- failed:失败。',
'type' => 'string',
'example' => 'success',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'SpaceNotExist',
],
'HttpStatusCode' => [
'description' => 'HTTP请求返回的响应状态码,200表示请求成功。',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '6E2E1770-E9C7-52E9-BF2C-94A0BACFADBE"',
],
'Success' => [
'description' => '请求返回状态。'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"SpaceNotExist\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"RequestId\\": \\"6E2E1770-E9C7-52E9-BF2C-94A0BACFADBE\\\\\\"\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6E2E1770-E9C7-52E9-BF2C-94A0BACFADBE\\r\\n\\ttrue\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => '设置静态网站的跨域配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetWebHostingConfig' => [
'summary' => '查询静态网站配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '828A8808-3FC9-418C-893A-5A708CFABB8E',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
'AllowedIps' => [
'description' => '静态网站托管测试域名允许访问IP的白名单,不在白名单中的访问可能会被限制。',
'type' => 'string',
'example' => '42.120.72.0/24',
],
'ErrorPath' => [
'description' => '404错误路径',
'type' => 'string',
'example' => 'error.html',
],
'DefaultDomain' => [
'description' => '默认域名,仅供测试使用,请求速度会受到限制。如果您需要对外正式提供网站服务,请绑定您已备案的自定义域名。',
'type' => 'string',
'example' => 'static-0e16bb12-14af-4635-b24c-5ac1a9a*****.bspapp.com',
],
'IndexPath' => [
'description' => '首页路径。',
'type' => 'string',
'example' => 'index.html',
],
'ErrorHttpStatus' => [
'description' => '当配置了ErrorPath之后,该页面对应的HTTP状态码,可选值404和200。当该字段不存在时,实际值为404。',
'type' => 'string',
'example' => '200',
'enum' => [],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"828A8808-3FC9-418C-893A-5A708CFABB8E\\",\\n \\"Data\\": {\\n \\"SpaceId\\": \\"0e16bb12-14af-4635-b24c-5ac1a9a*****\\",\\n \\"AllowedIps\\": \\"42.120.72.0/24\\",\\n \\"ErrorPath\\": \\"error.html\\",\\n \\"DefaultDomain\\": \\"static-0e16bb12-14af-4635-b24c-5ac1a9a*****.bspapp.com\\",\\n \\"IndexPath\\": \\"index.html\\",\\n \\"ErrorHttpStatus\\": \\"200\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n 200\\n SpaceNotExist\\n 828A8808-3FC9-418C-893A-5A708CFABB8E\\n true\\n \\n 0e16bb12-14af-4635-b24c-5ac1a9a*****\\n 42.120.72.0/24\\n error.html\\n static-0e16bb12-14af-4635-b24c-5ac1a9a*****.bspapp.com\\n index.html\\n /\\n \\n","errorExample":""}]',
'title' => '查询静态网站配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyWebHostingConfig' => [
'summary' => '更新静态网站配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
[
'name' => 'IndexPath',
'in' => 'formData',
'schema' => [
'description' => '首页路径。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'index.html',
],
],
[
'name' => 'ErrorPath',
'in' => 'formData',
'schema' => [
'description' => '404错误路径。',
'type' => 'string',
'required' => false,
'example' => 'error.html',
],
],
[
'name' => 'AllowedIps',
'in' => 'formData',
'schema' => [
'description' => '静态网站托管测试域名允许访问IP的白名单,不在白名单中的访问可能会被限制,仅支持配置ipv4,可以配置IP或者IP网段,掩码位数取值范围24-31,最多可同时配置三个,多个之间用逗号隔开。',
'type' => 'string',
'required' => false,
'example' => '42.120.72.0/24',
],
],
[
'name' => 'ErrorHttpStatus',
'in' => 'formData',
'schema' => [
'description' => '当配置了ErrorPath之后,该页面对应的HTTP状态码,可选值404和200,默认为404。',
'type' => 'string',
'required' => false,
'example' => '200',
'enum' => [
'200',
'404',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '操作执行结果。'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '074C8CF9-E7F8-436D-A546-4E5876D0F800',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"074C8CF9-E7F8-436D-A546-4E5876D0F800\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n CEF9831B-A6D2-4485-9CAD-1B8FBC8BC6F7\\r\\n 200\\r\\n true\\r\\n success\\r\\n true\\r\\n","errorExample":""}]',
'title' => '更新静态网站配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'EnableExtension' => [
'summary' => '开通扩展能力。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemas25T2EG',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'ExtensionId',
'in' => 'formData',
'schema' => [
'description' => '扩展能力唯一标识。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ext-5d53a4fb1c9d446e2075a2cc',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"F655A8D5-B967-440B-8683-DAD6FF8DE990","errorExample":""}]',
'title' => '开通扩展能力',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateServicePolicy' => [
'summary' => '更新权限。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => [
'description' => '服务名称。可选值:'."\n"
.' - db'."\n"
.' - file',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'db',
'enum' => [
'db',
'file',
],
],
],
[
'name' => 'Policy',
'in' => 'formData',
'schema' => [
'description' => '权限规则,当**PolicyName**为**EXTENDED**时必填。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '{\\".write\\":false,\\".read\\":true}',
],
],
[
'name' => 'CollectionName',
'in' => 'formData',
'schema' => [
'description' => '集合名称,当**ServerName**为**db**时该参数必填。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'test',
],
],
[
'name' => 'PolicyName',
'in' => 'formData',
'schema' => [
'description' => '策略名称,当**ServerName**为**db**时该参数必填。可选值:'."\n"
.'- PUBLICREAD: 所有用户可读,仅创建者及管理员可写。适用场景:如用户评论、公开信息等。'."\n"
.'- PRIVATE: 仅创建者及管理员可读写。适用场景:商品信息等。'."\n"
.'- ADMINWRITEONLY: 所有用户可读,仅管理员可写。适用场景:商品信息等。'."\n"
.'- ADMINREADWRITEONLY: 仅管理员可读写。适用场景:后台数据流水、日志等。'."\n"
.'- EXTENDED: 自定义安全规则。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'EXTENDED',
'enum' => [
'PUBLICREAD',
'PRIVATE',
'ADMINWRITEONLY',
'ADMINREADWRITEONLY',
'EXTENDED',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8932780D-9AF2-4E50-844C-13A1250918EE',
],
'Policy' => [
'description' => '策略。',
'type' => 'string',
'example' => '{\\".write\\":false,\\".read\\":true}',
],
'PolicyName' => [
'description' => '策略名称。',
'type' => 'string',
'example' => 'EXTENDED',
],
'ServiceName' => [
'description' => '服务名称。',
'type' => 'string',
'example' => 'db',
],
'CollectionName' => [
'description' => '集合名称。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SpaceId\\": \\"0e16bb12-14af-****-b24c-5ac1a9a7bb9f\\",\\n \\"RequestId\\": \\"8932780D-9AF2-4E50-844C-13A1250918EE\\",\\n \\"Policy\\": \\"{\\\\\\\\\\\\\\".write\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\".read\\\\\\\\\\\\\\":true}\\",\\n \\"PolicyName\\": \\"EXTENDED\\",\\n \\"ServiceName\\": \\"db\\",\\n \\"CollectionName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"\\n {\\".write\\":false,\\".read\\":true}\\n 3E1EB9A8-28F8-4820-8ABE-2E592010533E\\n db\\n test\\n EXTENDED\\n 826061c4-5095-4550-8b74-3bcd9af*****\\n","errorExample":""}]',
'title' => '更新权限',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OpenService' => [
'summary' => '开通Serverless产品。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '云函数所属的服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '226e5213-697c-4a52-b4ff-xxxxx',
],
],
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => [
'description' => 'Serverless产品。产品种类为云函数、云存储、静态网站托管。可选值为CLOUD\\_FUNCTION、CLOUD\\_STORAGE、WEB\\_HOSTING',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CLOUD_FUNCTION',
'enum' => [
'CLOUD_STORAGE',
'WEB_HOSTING',
'CLOUD_FUNCTION',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E63E7F4F-8538-5B0E-8712-78F92B6DCB9C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\n","errorExample":""}]',
'title' => '开通服务',
],
'OpenWebHostingService' => [
'summary' => '开通静态网站托管功能。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据。'."\n"
.'- true:操作成功。'."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '1819B1E4-3540-47ED-8E5A-A252C926D81D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1819B1E4-3540-47ED-8E5A-A252C926D81D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1819B1E4-3540-47ED-8E5A-A252C926D81D\\n 200\\n true\\n success\\n true\\n","errorExample":""}]',
'title' => '开通静态网站托管功能',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResetServerSecret' => [
'summary' => '接口重置服务端密钥。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '826061c4-5095-4550-8b74-3bcd9af*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'EA770971-A4A0-4555-9E00-C94A2194E150',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EA770971-A4A0-4555-9E00-C94A2194E150\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t C293BB03-B6AD-46C2-80D1-19C8FB573916\\r\\n","errorExample":""}]',
'title' => '重置服务端密钥',
'description' => '重置成功后,您可以调用[DescribeSpaceClientConfig](https://help.aliyun.com/document_detail/173420.html)接口来查询新生成的服务端私钥。新的密钥对会立即生效,旧的密钥对将会在10分钟内失效。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveAppAuthToken' => [
'summary' => '授权isv模式访问。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '368ef42a-763f-0000-acc2-8aa9564c****',
],
],
[
'name' => 'IsvAppId',
'in' => 'formData',
'schema' => [
'description' => 'isv的appId。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021002110693xxx',
],
],
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '小程序appId。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021002198669xxx',
],
],
[
'name' => 'AppAuthToken',
'in' => 'formData',
'schema' => [
'description' => '小程序授权Token。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '202111BB576ef688a3564875a75a9babd6XXXXXX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F340DF8D-7125-49B7-AC48-7F5C8DB382CB',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F340DF8D-7125-49B7-AC48-7F5C8DB382CB\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '保存应用验证令牌',
],
'DescribeFCOpenStatus' => [
'summary' => '查看是否已开通阿里云函数计算服务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '开通状态。',
'type' => 'string',
'example' => 'Opened',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-xxxx',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Opened\\",\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-xxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Opened\\n C293BB03-B6AD-46C2-80D1-xxxx\\n","errorExample":""}]',
'title' => '获取 FC 开启状态',
],
'DescribeServicePolicy' => [
'summary' => '查询权限规则。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => [
'description' => '服务名称。可选值:'."\n"
.' - db'."\n"
.' - file',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'db',
'enum' => [
'db',
'file',
],
],
],
[
'name' => 'CollectionName',
'in' => 'formData',
'schema' => [
'description' => '集合名称。该参数非必填,且仅在**serviceName**为**db**时有意义。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '15F08A3A-DDBC-4199-93CA-343419E81235',
],
'Policy' => [
'description' => '权限规则。',
'type' => 'string',
'example' => '{\\".write\\":false,\\".read\\":true}',
],
'PolicyName' => [
'description' => '权限模式,可能取值为。'."\n"
.'- PUBLICREAD: 所有用户可读,仅创建者及管理员可写。'."\n"
.'- PRIVATE: 仅创建者及管理员可读写。'."\n"
.'- ADMINWRITEONLY: 所有用户可读,仅管理员可写。'."\n"
.'- ADMINREADWRITEONLY: 仅管理员可读写。'."\n"
.'- EXTENDED: 自定义安全规则。',
'type' => 'string',
'example' => 'ADMINWRITEONLY',
],
'ServiceName' => [
'description' => '服务名称。',
'type' => 'string',
'example' => 'db',
],
'CollectionName' => [
'description' => '集合名称。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SpaceId\\": \\"0e16bb12-14af-****-b24c-5ac1a9a7bb9f\\",\\n \\"RequestId\\": \\"15F08A3A-DDBC-4199-93CA-343419E81235\\",\\n \\"Policy\\": \\"{\\\\\\\\\\\\\\".write\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\".read\\\\\\\\\\\\\\":true}\\",\\n \\"PolicyName\\": \\"ADMINWRITEONLY\\",\\n \\"ServiceName\\": \\"db\\",\\n \\"CollectionName\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"\\n {\\".write\\":false,\\".read\\":true}\\n 42B1D550-53CA-4DFC-A081-94D8DF00B81B\\n db\\n test\\n ADMINWRITEONLY\\n 200\\n 826061c4-5095-4550-8b74-3bcd9af*****\\n true\\n","errorExample":""}]',
'title' => '查询权限规则',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListExtensions' => [
'summary' => '查询扩展能力。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemas25T2EG',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
'description' => '页码,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '1',
'minimum' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '页大小,默认值为10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DD0F8BC9-516F-4AEF-8D95-D290C2296D78',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Extensions' => [
'description' => '扩展能力信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExtensionDocumentationLink' => [
'description' => '扩展能力文档链接。',
'type' => 'string',
'example' => 'https://help.aliyun.com/document_detail/137586.html',
],
'ExtensionId' => [
'description' => '扩展能力唯一标识。',
'type' => 'string',
'example' => 'ext-5d53a4fb1c9d446e2075a2cc',
],
'ExtensionDesc' => [
'description' => '扩展能力描述。',
'type' => 'string',
'example' => '支持开发者在云函数中快速调用小程序生态的业务API。已支持支付宝特色能力,高德、钉钉相关能力敬请期待。',
],
'ExtensionName' => [
'description' => '扩展能力名称。',
'type' => 'string',
'example' => '云调用',
],
'Enabled' => [
'description' => '是否开启。',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DD0F8BC9-516F-4AEF-8D95-D290C2296D78\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Extensions\\": [\\n {\\n \\"ExtensionDocumentationLink\\": \\"https://help.aliyun.com/document_detail/137586.html\\",\\n \\"ExtensionId\\": \\"ext-5d53a4fb1c9d446e2075a2cc\\",\\n \\"ExtensionDesc\\": \\"支持开发者在云函数中快速调用小程序生态的业务API。已支持支付宝特色能力,高德、钉钉相关能力敬请期待。\\",\\n \\"Enabled\\": \\"true\\",\\n \\"ExtensionName\\": \\"云调用\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 支持开发者在云函数中快速调用小程序生态的业务API。已支持支付宝特色能力,高德、钉钉相关能力敬请期待。\\n https://help.aliyun.com/document_detail/137586.html\\n 云调用\\n ext-5d53a4fb1c9d446e2075a2cc\\n\\n1\\n200\\n1\\n10\\nDD0F8BC9-516F-4AEF-8D95-D290C2296D78\\ntrue\\nOK","errorExample":""}]',
'title' => '查询扩展能力',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryServiceStatus' => [
'summary' => '查询Serverless产品服务状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '226e5213-697c-4a52-b4ff-xxxxx',
],
],
[
'name' => 'ServiceName',
'in' => 'formData',
'schema' => [
'description' => 'Serverless产品。产品种类为云函数、云存储、静态网站托管。可选值为CLOUD_FUNCTION、CLOUD_STORAGE、WEB_HOSTING',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CLOUD_FUNCTION',
'enum' => [
'CLOUD_FUNCTION',
'CLOUD_STORAGE',
'WEB_HOSTING',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E63E7F4F-8538-5B0E-8712-78F92B6DCB9C',
],
'ServiceStatus' => [
'description' => 'Serverless产品服务状态。返回值为UNUSED、OPENING、IN_SERVICE。',
'type' => 'string',
'enumValueTitles' => [
'IN_SERVICE' => 'IN_SERVICE',
'UNUSED' => 'UNUSED',
'OPENING' => 'OPENING',
],
'example' => 'OPENING',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccessDenied',
'errorMessage' => 'You are not authorized to access this space.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E63E7F4F-8538-5B0E-8712-78F92B6DCB9C\\",\\n \\"ServiceStatus\\": \\"OPENING\\"\\n}","type":"json"}]',
'title' => '查询服务状态',
],
'GetWebHostingStatus' => [
'summary' => '查询静态网站托管功能开通状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasU3GTV3',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'D8F7FDDC-4EF3-44B9-9452-CFD7A081FB85',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '功能开通状态,可能取值如下:'."\n"
.'- UNUSED:未开通。'."\n"
.'- OPENING:开通中。'."\n"
.'- IN_SERVICE:已开通。',
'type' => 'string',
'example' => 'OPENING',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '0e16bb12-14af-4635-b24c-5ac1a9a*****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8F7FDDC-4EF3-44B9-9452-CFD7A081FB85\\",\\n \\"Data\\": {\\n \\"Status\\": \\"OPENING\\",\\n \\"SpaceId\\": \\"0e16bb12-14af-4635-b24c-5ac1a9a*****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n D8F7FDDC-4EF3-44B9-9452-CFD7A081FB85\\n 200\\n \\n OPENING\\n 0e16bb12-14af-4635-b24c-5ac1a9a*****\\n \\n success\\n true\\n","errorExample":""}]',
'title' => '查询静态网站托管功能开通状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckMpServerlessRoleExists' => [
'summary' => '检查阿里云用户是否具有权限。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => '系统规定参数。取值:**AliyunServiceRoleForMPServerless**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AliyunServiceRoleForMPServerless',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F340DF8D-7125-49B7-AC48-7F5C8DB382CB',
],
'Exists' => [
'description' => '是否有相应权限。'."\n"
.'- true:有权限。'."\n"
.'- false:无权限。'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F340DF8D-7125-49B7-AC48-7F5C8DB382CB\\",\\n \\"Exists\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n F340DF8D-7125-49B7-AC48-7F5C8DB382CB\\n true\\n","errorExample":""}]',
'title' => '检查 Mp 角色是否存在',
],
'AddDingtalkOpenPlatformConfig' => [
'summary' => '添加钉钉开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '钉钉小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dingoa7pqicyk3x9t*****',
'maxLength' => 64,
],
],
[
'name' => 'AppSecret',
'in' => 'formData',
'schema' => [
'description' => '钉钉小程序密钥。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO',
'maxLength' => 200,
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '44DF7A95-603F-4651-9298-BE1850BEB53F',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"44DF7A95-603F-4651-9298-BE1850BEB53F\\"\\n}","errorExample":""},{"type":"xml","example":"44DF7A95-603F-4651-9298-BE1850BEB53F","errorExample":""}]',
'title' => '添加钉钉开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveAntOpenPlatformConfig' => [
'summary' => '保存支付宝开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '201909116717****',
'maxLength' => 64,
],
],
[
'name' => 'PublicKey',
'in' => 'formData',
'schema' => [
'description' => '公钥。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCA',
],
],
[
'name' => 'PrivateKey',
'in' => 'formData',
'schema' => [
'description' => '私钥。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSk',
],
],
[
'name' => 'SignMode',
'in' => 'formData',
'schema' => [
'description' => '加签方式,可选值如下:'."\n"
.'- PUBLIC_KEY:公钥。'."\n"
.'- CERT:公钥证书。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'CERT',
'enum' => [
'PUBLIC_KEY',
'CERT',
],
],
],
[
'name' => 'AppCert',
'in' => 'formData',
'schema' => [
'description' => '应用公钥证书。',
'type' => 'string',
'required' => false,
'example' => '-----BEGIN CERTIFICATE----- MIIEwTCCA6mgAwIBAgIQICAJGbUNoqdPr25qpPU7+ -----END CERTIFICATE-----',
],
],
[
'name' => 'PublicCert',
'in' => 'formData',
'schema' => [
'description' => '支付宝公钥证书。',
'type' => 'string',
'required' => false,
'example' => '-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----',
],
],
[
'name' => 'RootCert',
'in' => 'formData',
'schema' => [
'description' => '支付宝根证书。',
'type' => 'string',
'required' => false,
'example' => '-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2540E86F-2CD4-44AC-A7AB-59CAF40C225D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2540E86F-2CD4-44AC-A7AB-59CAF40C225D\\"\\n}","errorExample":""},{"type":"xml","example":"2540E86F-2CD4-44AC-A7AB-59CAF40C225D","errorExample":""}]',
'title' => '保存支付宝开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveWechatOpenPlatformConfig' => [
'summary' => '保存微信开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '微信小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
'maxLength' => 64,
],
],
[
'name' => 'AppSecret',
'in' => 'formData',
'schema' => [
'description' => '微信小程序密钥。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9w0BAQEFAASCBKgwggSkAgEAAoI',
'maxLength' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '44DF7A95-603F-4651-9298-BE1850BEB53F',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"44DF7A95-603F-4651-9298-BE1850BEB53F\\"\\n}","errorExample":""},{"type":"xml","example":"44DF7A95-603F-4651-9298-BE1850BEB53F","errorExample":""}]',
'title' => '保存微信开放平台配置',
],
'DeleteAntOpenPlatformConfig' => [
'summary' => '删除支付宝开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '201909116717****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2540E86F-2CD4-44AC-A7AB-59CAF40C225D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2540E86F-2CD4-44AC-A7AB-59CAF40C225D\\"\\n}","errorExample":""},{"type":"xml","example":"2540E86F-2CD4-44AC-A7AB-59CAF40C225D","errorExample":""}]',
'title' => '删除支付宝开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDingtalkOpenPlatformConfig' => [
'summary' => '删除钉钉开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '钉钉小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dingoa7pqicyk3x9t*****',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"F655A8D5-B967-440B-8683-DAD6FF8DE990","errorExample":""}]',
'title' => '删除钉钉开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteWechatOpenPlatformConfig' => [
'summary' => '删除微信开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '微信小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\"\\n}","errorExample":""},{"type":"xml","example":"819BE656-D2E0-4858-8B21-B2E477085AAF","errorExample":""}]',
'title' => '删除微信开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDingtalkOpenPlatformConfig' => [
'summary' => '更新钉钉开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'formData',
'schema' => [
'description' => '钉钉小程序ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dingoa7pqicyk3x9t*****',
'maxLength' => 128,
],
],
[
'name' => 'AppSecret',
'in' => 'formData',
'schema' => [
'description' => '钉钉小程序密钥。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO',
'maxLength' => 400,
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"F655A8D5-B967-440B-8683-DAD6FF8DE990","errorExample":""}]',
'title' => '更新钉钉开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSpaceClientConfig' => [
'summary' => '查询服务空间详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '226e5213-697c-4a52-b4ff-35a09f8*****',
],
],
[
'name' => 'Detail',
'in' => 'formData',
'schema' => [
'description' => '是否返回详细信息,默认为false。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'true',
],
],
[
'name' => 'WorkspaceId',
'in' => 'formData',
'schema' => [
'description' => '工作空间ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '9223372036854775807',
'minimum' => '1',
'example' => '211975XXXX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApiKey' => [
'description' => '客户端密钥。',
'type' => 'string',
'example' => '0a4gJT0faV*****D4lgQmw==',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '226e5213-697c-4a52-b4ff-35a09f8*****',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'EA770971-A4A0-4555-9E00-C94A2194E150',
],
'PrivateKey' => [
'description' => '服务端私钥,仅当Detail为True时才返回该信息。',
'type' => 'string',
'example' => '-----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhki******G9w0BAQE7V0sQaj\\n-----END PRIVATE KEY-----',
],
'Endpoint' => [
'description' => '服务网关Endpoint。',
'type' => 'string',
'example' => '226e5213-697c-4a52-b4ff-35a09f8*****',
],
'FileUploadEndpoint' => [
'description' => '文件上传Endpoint。',
'type' => 'string',
'example' => 'cocdsfmb-12266946259*****-file.oss-cn-zhangjiakou.aliyuncs.com',
],
'Name' => [
'description' => '服务空间名称。',
'type' => 'string',
'example' => 'myspace',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ApiKey\\": \\"0a4gJT0faV*****D4lgQmw==\\",\\n \\"SpaceId\\": \\"226e5213-697c-4a52-b4ff-35a09f8*****\\",\\n \\"RequestId\\": \\"EA770971-A4A0-4555-9E00-C94A2194E150\\",\\n \\"PrivateKey\\": \\"-----BEGIN PRIVATE KEY-----\\\\\\\\nMIIEvgIBADANBgkqhki******G9w0BAQE7V0sQaj\\\\\\\\n-----END PRIVATE KEY-----\\",\\n \\"Endpoint\\": \\"226e5213-697c-4a52-b4ff-35a09f8*****\\",\\n \\"FileUploadEndpoint\\": \\"cocdsfmb-12266946259*****-file.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"Name\\": \\"myspace\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0a4gJT0faV*****D4lgQmw==\\n -----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhki******G9w0BAQE7V0sQaj\\n-----END PRIVATE KEY-----\\n EA770971-A4A0-4555-9E00-C94A2194E150\\n 226e5213-697c-4a52-b4ff-35a09f8*****\\n myspace\\n https://api.bspapp.com\\n cocdsfmb-12266946259*****-file.oss-cn-zhangjiakou.aliyuncs.com\\n","errorExample":""}]',
'title' => '查询服务空间配置详情',
],
'ListOpenPlatformConfig' => [
'summary' => '查询支付宝、微信开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
[
'name' => 'Platform',
'in' => 'formData',
'schema' => [
'description' => '平台。可选值:'."\n"
.' - Alipay'."\n"
.' - Wechat',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Alipay',
'enum' => [
'wechat',
'Wechat',
'alipay',
'Alipay',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2540E86F-2CD4-44AC-A7AB-59CAF40C225D',
],
'SecretList' => [
'description' => '密钥列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
'AppSecret' => [
'description' => '应用密钥。',
'type' => 'string',
'example' => '1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO',
],
'PublicCert' => [
'description' => '支付宝公钥证书。',
'type' => 'string',
'example' => '-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----',
],
'AppCert' => [
'description' => '应用公钥证书。',
'type' => 'string',
'example' => '-----BEGIN CERTIFICATE----- MIIEwTCCA6mgAwIBAgIQICAJGbUNoqdPr25qpPU7+ -----END CERTIFICATE-----',
],
'PrivateKey' => [
'description' => '私钥。',
'type' => 'string',
'example' => 'MIIEvgIBADANBgkqhkiG9w0BAQEFAAS',
],
'AppId' => [
'description' => '小程序ID。',
'type' => 'string',
'example' => '201909116717****',
],
'RootCert' => [
'description' => '支付宝根证书。',
'type' => 'string',
'example' => '-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----',
],
'PublicKey' => [
'description' => '公钥。',
'type' => 'string',
'example' => 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ',
],
'Platform' => [
'description' => '平台。',
'type' => 'string',
'example' => 'Alipay',
],
'SignMode' => [
'description' => '加签方式,可选值如下:'."\n"
.'- PUBLIC_KEY:公钥。'."\n"
.'- CERT:公钥证书。',
'type' => 'string',
'example' => 'CERT',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2540E86F-2CD4-44AC-A7AB-59CAF40C225D\\",\\n \\"SecretList\\": [\\n {\\n \\"SpaceId\\": \\"0e16bb12-14af-****-b24c-5ac1a9a7bb9f\\",\\n \\"AppSecret\\": \\"1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO\\",\\n \\"PublicCert\\": \\"-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----\\",\\n \\"AppCert\\": \\"-----BEGIN CERTIFICATE----- MIIEwTCCA6mgAwIBAgIQICAJGbUNoqdPr25qpPU7+ -----END CERTIFICATE-----\\",\\n \\"PrivateKey\\": \\"MIIEvgIBADANBgkqhkiG9w0BAQEFAAS\\",\\n \\"AppId\\": \\"201909116717****\\",\\n \\"RootCert\\": \\"-----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ -----END CERTIFICATE-----\\",\\n \\"PublicKey\\": \\"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ\\",\\n \\"Platform\\": \\"Alipay\\",\\n \\"SignMode\\": \\"CERT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 2540E86F-2CD4-44AC-A7AB-59CAF40C225D\\n true\\n \\n PUBLIC_KEY\\n MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ\\n 201909116717****\\n MIIEvgIBADANBgkqhkiG9w0BAQEFAAS\\n Alipay\\n 0e16bb12-14af-****-b24c-5ac1a9a7bb9f\\n \\n OK\\n","errorExample":""}]',
'title' => '查询支付宝、微信开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDingtalkOpenPlatformConfigs' => [
'summary' => '查询钉钉开放平台配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D8A5FF68-2C8A-46D0-A11C-FA034F4F475F',
],
'Configs' => [
'description' => '钉钉小程序相关配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2020-01-17T03:04:46Z',
],
'AppSecret' => [
'description' => '钉钉小程序密钥。',
'type' => 'string',
'example' => '1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO',
],
'AppId' => [
'description' => '钉钉小程序ID。',
'type' => 'string',
'example' => 'dingoa7pqicyk3x9******',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-01-17T03:04:46Z',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D8A5FF68-2C8A-46D0-A11C-FA034F4F475F\\",\\n \\"Configs\\": [\\n {\\n \\"UpdateTime\\": \\"2020-01-17T03:04:46Z\\",\\n \\"AppSecret\\": \\"1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO\\",\\n \\"AppId\\": \\"dingoa7pqicyk3x9******\\",\\n \\"CreateTime\\": \\"2020-01-17T03:04:46Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"D8A5FF68-2C8A-46D0-A11C-FA034F4F475F\\n200\\n\\n dingoa7pqicyk3x9******\\n 2020-01-17T03:04:46Z\\n 2020-01-17T03:04:46Z\\n 1r0ElNPFqLI6qgY08*******************************9TIK3RN_5fk9SEMO\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '查询钉钉开放平台配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddCorsDomain' => [
'summary' => '为服务空间添加CORS域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'Domain',
'in' => 'formData',
'schema' => [
'description' => '域名。支持前缀和端口通配。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '*.example.com:*',
'maxLength' => 253,
'minLength' => 1,
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'mp-0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '74374923-6536-46EB-8639-409384EAE980',
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => '97e3ff58-01e4-****-b975-1805fec34d77',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74374923-6536-46EB-8639-409384EAE980\\",\\n \\"DomainId\\": \\"97e3ff58-01e4-****-b975-1805fec34d77\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 74374923-6536-46EB-8639-409384EAE980\\n 97e3ff58-01e4-****-b975-1805fec34d77\\n true\\n OK\\n","errorExample":""}]',
'title' => '添加CORS域名',
'description' => '>最多允许添加 10 个安全跨域域名。>',
],
'DeleteCorsDomain' => [
'summary' => '删除CORS域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'DomainId',
'in' => 'formData',
'schema' => [
'description' => '域名ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '97e3ff58-01e4-****-b975-1805fec34d77',
],
],
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '091A8BC0-8A73-4035-9441-922BF969631D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"091A8BC0-8A73-4035-9441-922BF969631D\\"\\n}","errorExample":""},{"type":"xml","example":"200\\n091A8BC0-8A73-4035-9441-922BF969631D\\ntrue\\nOK","errorExample":""}]',
'title' => '删除CORS域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCorsDomains' => [
'summary' => '查询CORS域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasWGZWPL',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0e16bb12-14af-****-b24c-5ac1a9a7bb9f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'ED81670E-570A-481C-A50D-6B0EAA823BB1',
],
'Domains' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => '97e3ff58-01e4-****-b975-1805fec34d77',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED81670E-570A-481C-A50D-6B0EAA823BB1\\",\\n \\"Domains\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"DomainId\\": \\"97e3ff58-01e4-****-b975-1805fec34d77\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n ED81670E-570A-481C-A50D-6B0EAA823BB1\\n \\n test.example.com\\n 97e3ff58-01e4-****-b975-1805fec34d77\\n \\n true\\n OK\\n","errorExample":""}]',
'title' => '查询CORS域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QuerySpaceSpecDetail' => [
'summary' => '根据套餐规格查询套餐详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpecCode',
'in' => 'formData',
'schema' => [
'description' => '- FREE 开发者版'."\n"
.'- BASE 基础版'."\n"
.'- STANDARD 标准版'."\n"
.'- PROFESSIONAL 专业版'."\n"
.'- ENTERPRISE 企业版'."\n"
.'- UTIMATE 旗舰版',
'type' => 'string',
'required' => true,
'example' => 'BASE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => '20C1EDFE-6355-4344-B20A-A7A5A1581026',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
],
'SpecCode' => [
'description' => '- FREE 开发者版'."\n"
.'- BASE 基础版'."\n"
.'- STANDARD 标准版'."\n"
.'- PROFESSIONAL 专业版'."\n"
.'- ENTERPRISE 企业版'."\n"
.'- UTIMATE 旗舰版',
'type' => 'string',
'example' => 'BASE',
],
'CsCdnTraffic' => [
'description' => '云存储流量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '2147483648',
],
'CsDownloadCount' => [
'description' => '云存储文件访问或者下载次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100000',
],
'CsStorageSize' => [
'description' => '云存储磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '8589934592',
],
'CsUploadCount' => [
'description' => '云存储文件上传次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '50000',
],
'DbReadCount' => [
'description' => '云数据库读请求次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '50000',
],
'DbStorageSize' => [
'description' => '云数据库磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '2147483648',
],
'DbWriteCount' => [
'description' => '云数据库写请求次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '30000',
],
'FcCost' => [
'description' => '云函数计算量(MB百毫秒)',
'type' => 'integer',
'format' => 'int64',
'example' => '102400000',
],
'FcRequestCount' => [
'description' => '云函数调用次数',
'type' => 'integer',
'format' => 'int64',
'example' => '150000',
],
'FcTxTraffic' => [
'description' => '云函数出网流量',
'type' => 'integer',
'format' => 'int64',
'example' => '1073741824',
],
'WhCdnTraffic' => [
'description' => '静态网站托管 CDN 流量,单位 byte',
'type' => 'integer',
'format' => 'int64',
'example' => '2147483648',
],
'WhStorageSize' => [
'description' => '静态网站托管磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '8589934592',
],
'SpecDetailText' => [
'description' => '套餐规格文案详情',
'type' => 'string',
'example' => '云函数:\\\\n 资源使用量 1万 GBs/月\\\\n调用次数 15 万次/月\\\\n出网流量 1 GB/月\\\\n\\\\br云数据库:\\\\n容量 2 GB\\\\n读操作 5 万次/天\\\\n写操作 3 万次/天\\\\n\\\\br云存储:\\\\n容量 8 GB\\\\n下载操作次数 10 万次/月\\\\n上传操作次数 5 万次/月\\\\nCDN流量 2 GB/月\\\\n\\\\br静态网站托管:\\\\n 容量 8 GB\\\\nCDN流量 2 GB/月"',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20C1EDFE-6355-4344-B20A-A7A5A1581026\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"SpecCode\\": \\"BASE\\",\\n \\"CsCdnTraffic\\": 2147483648,\\n \\"CsDownloadCount\\": 100000,\\n \\"CsStorageSize\\": 8589934592,\\n \\"CsUploadCount\\": 50000,\\n \\"DbReadCount\\": 50000,\\n \\"DbStorageSize\\": 2147483648,\\n \\"DbWriteCount\\": 30000,\\n \\"FcCost\\": 102400000,\\n \\"FcRequestCount\\": 150000,\\n \\"FcTxTraffic\\": 1073741824,\\n \\"WhCdnTraffic\\": 2147483648,\\n \\"WhStorageSize\\": 8589934592,\\n \\"SpecDetailText\\": \\"云函数:\\\\\\\\\\\\\\\\n 资源使用量 1万 GBs/月\\\\\\\\\\\\\\\\n调用次数 15 万次/月\\\\\\\\\\\\\\\\n出网流量 1 GB/月\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\br云数据库:\\\\\\\\\\\\\\\\n容量 2 GB\\\\\\\\\\\\\\\\n读操作 5 万次/天\\\\\\\\\\\\\\\\n写操作 3 万次/天\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\br云存储:\\\\\\\\\\\\\\\\n容量 8 GB\\\\\\\\\\\\\\\\n下载操作次数 10 万次/月\\\\\\\\\\\\\\\\n上传操作次数 5 万次/月\\\\\\\\\\\\\\\\nCDN流量 2 GB/月\\\\\\\\\\\\\\\\n\\\\\\\\\\\\\\\\br静态网站托管:\\\\\\\\\\\\\\\\n 容量 8 GB\\\\\\\\\\\\\\\\nCDN流量 2 GB/月\\\\\\"\\"\\n}","type":"json"}]',
'title' => '查询套餐规格详情',
'description' => '> 仅商业版支持该功能',
],
'QuerySpaceUsage' => [
'summary' => '查询服务空间资源用量详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'example' => 'mp-fd37e37e-b436-4a7a-****-58c89ce3586d',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => [
'description' => '起始时间,UTC。',
'type' => 'string',
'required' => true,
'example' => '2022-06-17T16:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => [
'description' => '结束时间,UTC。'."\n"
.'- 结束时间必须晚于开始时间。'."\n"
.'- 当时间范围不超过一天时,自动返回小时级别计量数据。',
'type' => 'string',
'required' => true,
'example' => '2022-06-18T16:00:00Z',
],
],
[
'name' => 'Interval',
'in' => 'formData',
'schema' => [
'description' => '可选字段。当缺少该字段时根据查询时间跨度返回不同粒度数据。大于一天按天返回,小于等于一天按小时返回。'."\n"
."\n"
.'查询数据的时间粒度。单位:分钟。取值:'."\n"
."\n"
.'- 1440(按天返回,跨度不超过31天)。'."\n"
."\n"
.'- 60(按小时返回,跨度不超过7天)。'."\n"
."\n"
.'- 5(按五分钟返回,跨度不超过1天)。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'A9FB71D5-2C06-5810-A5FA-B88E45FE****',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'mp-23c7c857-****-4512-bab0-3dbf986e7576',
],
'StartTime' => [
'description' => '起始时间。',
'type' => 'string',
'example' => '2022-06-17T16:00:00Z',
],
'EndTime' => [
'description' => '查询范围的终止时间戳。',
'type' => 'string',
'example' => '2022-06-18T16:00:00Z',
],
'SpaceUsageDataList' => [
'description' => '数据列表。',
'type' => 'array',
'items' => [
'description' => '数据列表。',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '统计时间戳。',
'type' => 'string',
'example' => '2022-06-17T16:00:00Z',
],
'FcUsage' => [
'description' => '云函数用量。',
'type' => 'object',
'properties' => [
'Cost' => [
'description' => '计算量(MB百毫秒)。',
'type' => 'integer',
'format' => 'int64',
'example' => '35645000',
],
'RequestCount' => [
'description' => '函数调用次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '12451',
],
'TxTraffic' => [
'description' => '函数出网总流量,单位为byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '124521635',
],
],
],
'DbUsage' => [
'description' => '云数据库用量。',
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '2542108',
],
'ReadCount' => [
'description' => '云数据库读操作数(每4KB向上取整)。',
'type' => 'integer',
'format' => 'int64',
'example' => '5685123',
],
'WriteCount' => [
'description' => '云数据库写操作数(每1KB向上取整)。',
'type' => 'integer',
'format' => 'int64',
'example' => '241500',
],
],
],
'CsUsage' => [
'description' => '云存储用量。',
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '4024575081',
],
'DownloadCount' => [
'description' => '文件访问或者下载次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '45668113',
],
'UploadCount' => [
'description' => '文件上传次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2352',
],
'CdnTraffic' => [
'description' => 'CDN 流量。',
'type' => 'integer',
'format' => 'int64',
'example' => '94134230',
],
],
],
'WhUsage' => [
'description' => '静态网站托管用量。',
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '226230160',
],
'CdnTraffic' => [
'description' => 'CDN 流量。',
'type' => 'integer',
'format' => 'int64',
'example' => '5644311',
],
],
],
'EffectiveBillFlag' => [
'description' => '标记该数据是否出账。'."\n"
.'- true:正常出账。'."\n"
.'- false:不出账,例如在空间停服的情况下,用量数据不用于出账。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9FB71D5-2C06-5810-A5FA-B88E45FE****\\",\\n \\"SpaceId\\": \\"mp-23c7c857-****-4512-bab0-3dbf986e7576\\",\\n \\"StartTime\\": \\"2022-06-17T16:00:00Z\\",\\n \\"EndTime\\": \\"2022-06-18T16:00:00Z\\",\\n \\"SpaceUsageDataList\\": [\\n {\\n \\"Timestamp\\": \\"2022-06-17T16:00:00Z\\",\\n \\"FcUsage\\": {\\n \\"Cost\\": 35645000,\\n \\"RequestCount\\": 12451,\\n \\"TxTraffic\\": 124521635\\n },\\n \\"DbUsage\\": {\\n \\"StorageSize\\": 2542108,\\n \\"ReadCount\\": 5685123,\\n \\"WriteCount\\": 241500\\n },\\n \\"CsUsage\\": {\\n \\"StorageSize\\": 4024575081,\\n \\"DownloadCount\\": 45668113,\\n \\"UploadCount\\": 2352,\\n \\"CdnTraffic\\": 94134230\\n },\\n \\"WhUsage\\": {\\n \\"StorageSize\\": 226230160,\\n \\"CdnTraffic\\": 5644311\\n },\\n \\"EffectiveBillFlag\\": true\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询资源用量',
'description' => '> 仅商业版支持该功能。',
],
'QuerySpaceConsumption' => [
'summary' => '查询服务空间的当月用量消费。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => false,
'example' => 'mp-95865273-9b1f-496d-****-cb88fa4d66a2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'F16FEFE8-4E57-5795-BE7B-2D29F0C61B8C',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '0',
],
'SpaceId' => [
'description' => '服务空间ID。',
'type' => 'string',
'example' => 'mp-26fe89b6-****-4a90-b332-b424ce9651e6',
],
'SpecCode' => [
'description' => '- FREE 开发者版'."\n"
.'- BASE 基础版'."\n"
.'- STANDARD 标准版'."\n"
.'- PROFESSIONAL 专业版'."\n"
.'- ENTERPRISE 企业版'."\n"
.'- UTIMATE 旗舰版',
'type' => 'string',
'example' => 'BASE',
],
'FcUsage' => [
'description' => '云函数用量',
'type' => 'object',
'properties' => [
'Cost' => [
'description' => '计算量(MB百毫秒)',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'RequestCount' => [
'description' => '函数调用次数'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TxTraffic' => [
'description' => '函数出网总流量,单位为byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'DbUsage' => [
'description' => '云数据库用量。',
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReadCount' => [
'description' => '读请求次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'WriteCount' => [
'description' => '写请求次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'CsUsage' => [
'description' => '云存储用量。'."\n"
."\n",
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DownloadCount' => [
'description' => '文件访问或者下载次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'UploadCount' => [
'description' => '文件上传次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CdnTraffic' => [
'description' => 'CDN 流量,单位为byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'WhUsage' => [
'description' => '静态网站托管用量。',
'type' => 'object',
'properties' => [
'StorageSize' => [
'description' => '磁盘容量,单位:byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CdnTraffic' => [
'description' => 'CDN 流量,单位为byte。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'CycleStartTime' => [
'description' => '当前计费周期起始时间(秒)',
'type' => 'integer',
'format' => 'int64',
'example' => '1664467200',
],
'CycleEndTime' => [
'description' => '当前计费周期结束时间(秒)',
'type' => 'integer',
'format' => 'int64',
'example' => '1667059200',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F16FEFE8-4E57-5795-BE7B-2D29F0C61B8C\\",\\n \\"GmtCreate\\": \\"0\\",\\n \\"SpaceId\\": \\"mp-26fe89b6-****-4a90-b332-b424ce9651e6\\",\\n \\"SpecCode\\": \\"BASE\\",\\n \\"FcUsage\\": {\\n \\"Cost\\": 0,\\n \\"RequestCount\\": 0,\\n \\"TxTraffic\\": 0\\n },\\n \\"DbUsage\\": {\\n \\"StorageSize\\": 0,\\n \\"ReadCount\\": 0,\\n \\"WriteCount\\": 0\\n },\\n \\"CsUsage\\": {\\n \\"StorageSize\\": 0,\\n \\"DownloadCount\\": 0,\\n \\"UploadCount\\": 0,\\n \\"CdnTraffic\\": 0\\n },\\n \\"WhUsage\\": {\\n \\"StorageSize\\": 0,\\n \\"CdnTraffic\\": 0\\n },\\n \\"CycleStartTime\\": 1664467200,\\n \\"CycleEndTime\\": 1667059200\\n}","type":"json"}]',
'title' => '查询空间资源消费',
'description' => '> 仅商业版支持该功能。',
],
'DescribeResourceQuota' => [
'summary' => '查询服务空间资源的阈值。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
'notSupportAutoTestReason' => '资源无法自动创建,已沟通加白',
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '226e5213-697c-****-b4ff-35a09f8a52de',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'StaticWebDataSizeQuota' => [
'description' => '静态网站容量阈值,单位GB 。',
'type' => 'number',
'format' => 'double',
'example' => '2',
],
'CloudStorageDataSizeQuota' => [
'description' => '云存储容量阈值,单位GB。',
'type' => 'number',
'format' => 'double',
'example' => '10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"StaticWebDataSizeQuota\\": 2,\\n \\"CloudStorageDataSizeQuota\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n C293BB03-B6AD-46C2-80D1-19C8FB573916\\n 2\\n 10\\n","errorExample":""}]',
'title' => '查询服务空间资源的阈值',
],
'DescribeResourceUsage' => [
'summary' => '查询资源使用量。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasY2CCBF',
],
'autoTest' => false,
],
'parameters' => [
[
'name' => 'SpaceId',
'in' => 'formData',
'schema' => [
'description' => '服务空间ID。',
'type' => 'string',
'required' => true,
'example' => '226e5213-697c-****-b4ff-35a09f8a52de',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => [
'description' => '页码。取值范围:大于1的任意整数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '页大小。默认30,最大1000,取值:1-1000。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '100',
'default' => '30',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => [
'description' => '获取资源用量起始时间。日期格式按照ISO8601表示法,并使用北京时间(UTC+8),格式为yyyy-MM-ddTHH:mm:ssZ,默认返回今天的数据。',
'type' => 'string',
'required' => false,
'example' => '2021-10-01T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => [
'description' => '获取资源用量结束时间。日期格式按照ISO8601表示法,并使用北京时间(UTC+8),格式为yyyy-MM-ddTHH:mm:ssZ。结束时间需晚于起始时间。',
'type' => 'string',
'required' => false,
'example' => '2021-10-02T00:00:00Z',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '请求返回状态。'."\n"
.'- success:成功。'."\n"
.'- failed:失败。',
'type' => 'string',
'example' => 'success',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'SpaceNotExist',
],
'HttpStatusCode' => [
'description' => 'HTTP请求返回的响应状态码,200表示请求成功。',
'type' => 'string',
'required' => true,
'example' => '200',
],
'RequestId' => [
'description' => '唯一请求ID。',
'type' => 'string',
'example' => 'C293BB03-B6AD-46C2-80D1-19C8FB573916',
],
'Success' => [
'description' => '请求返回状态。'."\n"
.'- true:成功。'."\n"
.'- false:失败',
'type' => 'boolean',
'example' => 'true',
],
'DataList' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '函数数据大小。',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '获取资源用量起始时间。日期格式按照ISO8601表示法,并使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ, 默认返回今天的数据。',
'type' => 'string',
'example' => '2021-10-01T15:00:00Z',
],
'EndTime' => [
'description' => '获取资源用量结束时间。结束时间需晚于起始时间。',
'type' => 'string',
'example' => '2021-10-01T16:00:00Z',
],
'CloudStorage' => [
'description' => '云存储。',
'type' => 'object',
'properties' => [
'DataSize' => [
'description' => '容量 (单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Traffic' => [
'description' => '流量(单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Upload' => [
'description' => '上传次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Download' => [
'description' => '下载次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'CloudDB' => [
'description' => '云数据库。',
'type' => 'object',
'properties' => [
'DataSize' => [
'description' => '容量 (单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Write' => [
'description' => '写次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Read' => [
'description' => '读次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'CloudFunction' => [
'description' => '云函数。',
'type' => 'object',
'properties' => [
'Compute' => [
'description' => '计算量(单位 GBS)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Count' => [
'description' => '调用次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Traffic' => [
'description' => '流量(单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'StaticWeb' => [
'description' => '静态网站托管',
'type' => 'object',
'properties' => [
'DataSize' => [
'description' => '容量 (单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Traffic' => [
'description' => '流量(单位字节)。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
'Paginator' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageCount' => [
'description' => '当前页面总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'PageNum' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'Total' => [
'description' => '总数',
'type' => 'integer',
'format' => 'int64',
'example' => '255',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"SpaceNotExist\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"RequestId\\": \\"C293BB03-B6AD-46C2-80D1-19C8FB573916\\",\\n \\"Success\\": true,\\n \\"DataList\\": [\\n {\\n \\"StartTime\\": \\"2021-10-01T15:00:00Z\\",\\n \\"EndTime\\": \\"2021-10-01T16:00:00Z\\",\\n \\"CloudStorage\\": {\\n \\"DataSize\\": 0,\\n \\"Traffic\\": 0,\\n \\"Upload\\": 0,\\n \\"Download\\": 0\\n },\\n \\"CloudDB\\": {\\n \\"DataSize\\": 0,\\n \\"Write\\": 0,\\n \\"Read\\": 0\\n },\\n \\"CloudFunction\\": {\\n \\"Compute\\": 0,\\n \\"Count\\": 0,\\n \\"Traffic\\": 0\\n },\\n \\"StaticWeb\\": {\\n \\"DataSize\\": 0,\\n \\"Traffic\\": 0\\n }\\n }\\n ],\\n \\"Paginator\\": {\\n \\"PageCount\\": 3,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 100,\\n \\"Total\\": 255\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n SpaceNotExist\\n 200\\n C293BB03-B6AD-46C2-80D1-19C8FB573916\\n true\\n \\n \\n 3\\n 1\\n 100\\n 255\\n \\n","errorExample":""}]',
'title' => '查询资源使用量',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'mpserverless.aliyuncs.com',
],
],
];