'1.0',
'info' => [
'style' => 'RPC',
'product' => 'tdsr',
'version' => '2020-01-01',
],
'directories' => [
[
'id' => 77266,
'title' => '场景',
'type' => 'directory',
'children' => [
'AddScene',
'DropScene',
'ScenePublish',
'UpdateScene',
'DetailScene',
'ListScene',
],
],
[
'id' => 77275,
'title' => '子场景',
'type' => 'directory',
'children' => [
'AddSubScene',
'DropSubScene',
'UpdateSubScene',
'DetailSubScene',
'ListSubScene',
],
],
[
'id' => 77281,
'title' => '项目',
'type' => 'directory',
'children' => [
'AddProject',
'DropProject',
'UpdateProject',
'DetailProject',
'ListProject',
],
],
[
'id' => 77291,
'title' => '马赛克',
'type' => 'directory',
'children' => [
'AddMosaics',
],
],
[
'id' => 350166,
'title' => '其他',
'type' => 'directory',
'children' => [
'GetHotspotConfig',
'GetHotspotTag',
'GetWindowConfig',
'PublishHotspot',
'SaveHotspotConfig',
'SaveHotspotTag',
'TempPreviewStatus',
'GetSingleConnData',
'GetTaskStatus',
'RectVertical',
'GetLayoutData',
'TempPreview',
'LabelBuild',
'GetOssPolicy',
'PredictionWallLine',
'GetSceneBuildTaskStatus',
'UpdateConnData',
'PredImage',
'GetRectifyImage',
'GetOriginLayoutData',
'RectifyImage',
'LinkImage',
'OptimizeRightAngle',
'GetConnData',
'UpdateLayoutData',
'GetSubSceneTaskStatus',
'PublishScene',
'AddRelativePosition',
'GetScenePreviewInfo',
'GetHotspotSceneData',
'RecoveryOriginImage',
'RollbackSubScene',
'PublishStatus',
'AddRoomPlan',
'GetScenePreviewData',
'CheckUserProperty',
'GetScenePreviewResource',
'GetPackSceneTaskStatus',
'GetScenePackUrl',
'PackScene',
'GetCopySceneTaskStatus',
'UpdateSubSceneSeq',
'CopyScene',
'GetSourcePackStatus',
'PackSource',
'SaveHotspotTagList',
'SaveModelConfig',
'CreateUploadPolicy',
'PublishHotspotConfig',
'AddHotspotFile',
'SaveMinimap',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddScene' => [
'summary' => '创建特定类型的主场景。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO 混合:MIX',
'description' => '场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO 混合:MIX',
'type' => 'string',
'required' => true,
'example' => 'MODEL_3D',
'enum' => [
'MODEL_3D',
'PIC',
'VIDEO',
'MIX',
],
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '场景名称',
'description' => '场景名称',
'type' => 'string',
'required' => true,
'example' => '场景A',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'title' => '项目ID',
'description' => '项目ID',
'type' => 'string',
'required' => true,
'minimum' => '1',
'example' => '1234****',
],
],
[
'name' => 'CustomerUid',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '业务方UID',
'type' => 'string',
'required' => false,
'example' => '2345****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'example' => '2345****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"2345****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n 2345****\\n","errorExample":""}]',
'title' => '创建主场景',
],
'DropScene' => [
'summary' => '删除指定主场景。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '主场景id',
'description' => '主场景ID',
'type' => 'string',
'required' => true,
'example' => '1234***',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '删除主场景',
],
'ScenePublish' => [
'summary' => '发布',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb1309366493',
],
'Code' => [
'title' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'PreviewUrl' => [
'title' => '预览链接',
'type' => 'string',
'example' => 'https://lyj.aliyun.com/xxx',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '',
],
'UpdateScene' => [
'summary' => '更新场景信息名称。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '场景名称',
'description' => '场景名称',
'type' => 'string',
'required' => true,
'example' => '场景A',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新场景名称',
],
'DetailScene' => [
'summary' => '获取指定主场景信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234***',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb130936****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '主场景Id',
'description' => '主场景ID',
'type' => 'string',
'example' => '1234***',
],
'Name' => [
'title' => '场景名称',
'description' => '场景名称',
'type' => 'string',
'example' => '场景A',
],
'Type' => [
'title' => '场景类型',
'description' => '场景类型',
'type' => 'string',
'example' => '场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO',
],
'SubSceneNum' => [
'title' => '子场景数',
'description' => '子场景数',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'SourceNum' => [
'title' => '资源数',
'description' => '资源数',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Published' => [
'title' => '是否已发布 true:已发布:false:未发布',
'description' => '是否已发布 true:已发布:false:未发布',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'GmtModified' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'PreviewToken' => [
'title' => '预览Token',
'description' => '预览Token',
'type' => 'string',
'example' => 'd989623696ab4f87a80b8d5b0b0****',
],
'CoverUrl' => [
'title' => '封面地址',
'description' => '封面地址(模型)',
'type' => 'string',
'example' => 'www.example.com/xxx/xxx.jpg',
],
'Status' => [
'title' => '场景状态,init:初始化,published:已发布,publishing:发布中,copying:复制中,making:制作中,publishable:构建成功,makeFailed:制作失败',
'description' => '场景状态,init:初始化,published:已发布,publishing:发布中,copying:复制中,making:制作中,publishable:构建成功,makeFailed:制作失败',
'type' => 'string',
'example' => 'init',
],
'StatusName' => [
'title' => '状态名称',
'description' => '状态名称',
'type' => 'string',
'example' => '初始化',
],
'Captures' => [
'title' => '实勘图列表',
'description' => '实勘图列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Url' => [
'title' => '实勘图url',
'description' => '实勘图url',
'type' => 'string',
'example' => 'http://www.aliyun.com/test1.jpg',
],
'Title' => [
'title' => '图片名称',
'description' => '图片名称',
'type' => 'string',
'example' => '图片名称',
],
],
],
],
'FloorPlans' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FloorLabel' => [
'title' => '楼层索引',
'description' => '楼层索引',
'type' => 'string',
],
'FloorName' => [
'title' => '楼层名称',
'description' => '楼层名称',
'type' => 'string',
],
'ColorMapUrl' => [
'title' => '彩色图地址',
'description' => '彩色图地址',
'type' => 'string',
],
'MiniMapUrl' => [
'title' => '黑白图地址',
'description' => '黑白图地址',
'type' => 'string',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"344794c32937474a9c59eb130936****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"1234***\\",\\n \\"Name\\": \\"场景A\\",\\n \\"Type\\": \\"场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO\\",\\n \\"SubSceneNum\\": 20,\\n \\"SourceNum\\": 20,\\n \\"Published\\": false,\\n \\"GmtCreate\\": 1621236933677,\\n \\"GmtModified\\": 1621236933677,\\n \\"PreviewToken\\": \\"d989623696ab4f87a80b8d5b0b0****\\",\\n \\"CoverUrl\\": \\"www.example.com/xxx/xxx.jpg\\",\\n \\"Status\\": \\"init\\",\\n \\"StatusName\\": \\"初始化\\",\\n \\"Captures\\": [\\n {\\n \\"Url\\": \\"http://www.aliyun.com/test1.jpg\\",\\n \\"Title\\": \\"图片名称\\"\\n }\\n ],\\n \\"FloorPlans\\": [\\n {\\n \\"FloorLabel\\": \\"\\",\\n \\"FloorName\\": \\"\\",\\n \\"ColorMapUrl\\": \\"\\",\\n \\"MiniMapUrl\\": \\"\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 344794c32937474a9c59eb130936****\\n 200\\n true\\n success\\n 1234***\\n 场景A\\n 场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO\\n 20\\n 20\\n false\\n 1621236933677\\n 1621236933677\\n d989623696ab4f87a80b8d5b0b0****\\n www.example.com/xxx/xxx.jpg\\n init\\n 初始化\\n \\n http://www.aliyun.com/test1.jpg\\n 图片名称\\n \\n","errorExample":""}]',
'title' => '查看场景详情',
],
'ListScene' => [
'summary' => '获取指定项目下的所有主场景列表。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '主场景名称',
'description' => '主场景名称',
'type' => 'string',
'required' => false,
'example' => '场景A',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'title' => '所有项目Id',
'description' => '所有项目ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'title' => '当前页',
'description' => '页码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '页长',
'description' => '页长',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'HasNext' => [
'title' => '是否有下一页',
'description' => '是否有下一页',
'type' => 'boolean',
'example' => 'true',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalPage' => [
'title' => '总页数',
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'Count' => [
'title' => '数据总数',
'description' => '数据总数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'List' => [
'title' => '主场景数据',
'description' => '主场景数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主场景Id',
'description' => '主场景ID',
'type' => 'string',
'example' => '1234****',
],
'Name' => [
'title' => '场景名称',
'description' => '场景名称',
'type' => 'string',
'example' => '场景A',
],
'Type' => [
'title' => '场景类型 3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO',
'description' => '场景类型',
'type' => 'string',
'example' => 'MODEL_3D',
],
'SubSceneNum' => [
'title' => '子场景数',
'description' => '子场景数',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'SourceNum' => [
'title' => '资源数',
'description' => '资源数',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'Published' => [
'title' => '是否已发布 true:已发布:false:未发布',
'description' => '是否已发布 true:已发布:false:未发布',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'GmtModified' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'PreviewToken' => [
'title' => '预览Token',
'description' => '预览Token',
'type' => 'string',
'example' => 'd989623696ab4f87a80b8d5b0b00****',
],
'CoverUrl' => [
'title' => '封面地址',
'description' => '封面地址(模型)',
'type' => 'string',
'example' => 'www.example.com/xxxx/xxx.jpg',
],
'Status' => [
'title' => '场景状态,init:初始化,published:已发布,publishing:发布中,copying:复制中,making:制作中,publishable:构建成功,makeFailed:制作失败',
'description' => '场景状态,init:初始化,published:已发布,publishing:发布中,copying:复制中,making:制作中,publishable:构建成功,makeFailed:制作失败',
'type' => 'string',
'example' => 'init',
],
'StatusName' => [
'title' => '状态名称',
'description' => '状态名称',
'type' => 'string',
'example' => '初始化',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"HasNext\\": true,\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 5,\\n \\"Count\\": 100,\\n \\"List\\": [\\n {\\n \\"Id\\": \\"1234****\\",\\n \\"Name\\": \\"场景A\\",\\n \\"Type\\": \\"MODEL_3D\\",\\n \\"SubSceneNum\\": 20,\\n \\"SourceNum\\": 20,\\n \\"Published\\": false,\\n \\"GmtCreate\\": 1621236933677,\\n \\"GmtModified\\": 1621236933677,\\n \\"PreviewToken\\": \\"d989623696ab4f87a80b8d5b0b00****\\",\\n \\"CoverUrl\\": \\"www.example.com/xxxx/xxx.jpg\\",\\n \\"Status\\": \\"init\\",\\n \\"StatusName\\": \\"初始化\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n true\\n 1\\n 5\\n 100\\n \\n 1234****\\n 场景A\\n MODEL_3D\\n 20\\n 20\\n false\\n 1621236933677\\n 1621236933677\\n d989623696ab4f87a80b8d5b0b00****\\n www.example.com/xxxx/xxx.jpg\\n init\\n 初始化\\n
\\n","errorExample":""}]',
'title' => '分页查看场景列表',
],
'AddSubScene' => [
'summary' => '在指定的主场景下添加新的子场景。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '子场景名称',
'description' => '子场景名称(长度为1~20个字符)',
'type' => 'string',
'required' => true,
'example' => '子场景A',
],
],
[
'name' => 'UploadType',
'in' => 'query',
'schema' => [
'title' => '类型 图片:IMAGE 视频:VIDEO',
'description' => '上传类型 图片:IMAGE 视频:VIDEO',
'type' => 'string',
'required' => false,
'example' => 'IMAGE',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'example' => '234****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"234****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 234****\\n","errorExample":""}]',
'title' => '创建子场景',
],
'DropSubScene' => [
'summary' => '删除指定子场景。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '删除子场景',
],
'UpdateSubScene' => [
'summary' => '更新指定的子场景信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '子场景名称',
'description' => '子场景名称(规则:^[0-9a-zA-Z_\\-\\u4e00-\\u9fa5]{1,20}$)',
'type' => 'string',
'required' => false,
'example' => '客厅',
],
],
[
'name' => 'ViewPoint',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '视角坐标,目前支持3元坐标,4元坐标,例如:[0.94005,0.13397,-0.3136,0.782992]',
'description' => '视角坐标,目前支持3元坐标,4元坐标,例如:[0.94005,0.13397,-0.3136,0.782992]',
'type' => 'array',
'items' => [
'title' => '浮点数',
'description' => '视角坐标,例如:[0.94005,0.13397,-0.3136,0.782992]',
'type' => 'number',
'format' => 'double',
'required' => false,
'example' => '0.94005',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新子场景名称',
],
'DetailSubScene' => [
'summary' => '查看子场景信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID(加密ID)',
'type' => 'string',
'required' => true,
'example' => 'F79siXLsJsVVca8Yp4fgPA==',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '子场景id',
'description' => '子场景id(加密ID)',
'type' => 'string',
'example' => '1234***',
],
'Name' => [
'title' => '子场景名称',
'description' => '子场景名称',
'type' => 'string',
'example' => '子场景A',
],
'ResourceId' => [
'title' => '图片ID/视频ID',
'description' => '图片ID/视频ID(加密ID)',
'type' => 'string',
'example' => '1234***',
],
'Url' => [
'title' => '图片路径/视频路径',
'description' => '图片路径/视频路径',
'type' => 'string',
'example' => 'https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'CoverUrl' => [
'title' => '图片路径/视频封面路径',
'description' => '图片路径/视频封面路径',
'type' => 'string',
'example' => 'https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'Status' => [
'title' => '子场景状态',
'description' => '子场景状态 1.未重建 2.中间模型重建中 3.中间模型重建完成 4.待重建 5.服务商重建中 6.服务商重建完成 7.已发布 8.发布中',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'GmtModified' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'CubemapPath' => [
'title' => '切图路径',
'description' => '切图路径',
'type' => 'string',
'example' => 'https://image-demo.oss-cn-hangzhou.aliyuncs.com/cubemap/****',
],
'OriginUrl' => [
'title' => '原图路径',
'description' => '原图路径',
'type' => 'string',
'example' => 'http://www.aliyun.com/test.jpg',
],
'ImageUrl' => [
'title' => '矫正后图的路径',
'description' => '矫正后图的路径',
'type' => 'string',
'example' => 'http://www.aliyun.com/test1.jpg',
],
'LayoutData' => [
'title' => '墙线标注数据',
'description' => '墙线标注数据',
'type' => 'string',
'example' => '{}',
],
'Type' => [
'title' => '资源类型,IMAGE:图片,VIDEO:视频',
'description' => '资源类型',
'type' => 'string',
'example' => 'IMAGE',
],
'Position' => [
'title' => '视角',
'description' => '视角坐标',
'type' => 'string',
'example' => '[-0.8928,-0.21467,0.39603]',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"1234***\\",\\n \\"Name\\": \\"子场景A\\",\\n \\"ResourceId\\": \\"1234***\\",\\n \\"Url\\": \\"https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"CoverUrl\\": \\"https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"Status\\": 1,\\n \\"GmtCreate\\": 1621236933677,\\n \\"GmtModified\\": 1621236933677,\\n \\"CubemapPath\\": \\"https://image-demo.oss-cn-hangzhou.aliyuncs.com/cubemap/****\\",\\n \\"OriginUrl\\": \\"http://www.aliyun.com/test.jpg\\",\\n \\"ImageUrl\\": \\"http://www.aliyun.com/test1.jpg\\",\\n \\"LayoutData\\": \\"{}\\",\\n \\"Type\\": \\"IMAGE\\",\\n \\"Position\\": \\"[-0.8928,-0.21467,0.39603]\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 1234***\\n 子场景A\\n 1234***\\n https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n 1\\n 1621236933677\\n 1621236933677\\n https://image-demo.oss-cn-hangzhou.aliyuncs.com/cubemap/****\\n http://www.aliyun.com/test.jpg\\n http://www.aliyun.com/test1.jpg\\n {}\\n IMAGE\\n [-0.8928,-0.21467,0.39603]\\n","errorExample":""}]',
'title' => '查看子场景信息',
],
'ListSubScene' => [
'summary' => '分页查看子场景列表。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID(加密ID)',
'type' => 'string',
'required' => true,
'example' => 'L2omaCMmQZZkEg4pE****',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'title' => '页码',
'description' => '页码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '页长',
'description' => '页长',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'ShowLayoutData',
'in' => 'query',
'schema' => [
'description' => '是否返回标注数据',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'SortField',
'in' => 'query',
'schema' => [
'title' => '排序字段,默认:NAME(名称),SEQUENCE(自定义排序)',
'description' => '排序字段,默认:NAME(名称),SEQUENCE(自定义序列)',
'type' => 'string',
'required' => false,
'example' => 'NAME',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'HasNext' => [
'title' => '是否有下一页',
'description' => '是否有下一页',
'type' => 'boolean',
'example' => 'true',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalPage' => [
'title' => '总页数',
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'Count' => [
'title' => '数据总条数',
'description' => '数据总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'List' => [
'title' => '子场景列表集',
'description' => '子场景列表集',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '子场景ID',
'description' => '子场景ID(加密ID)',
'type' => 'string',
'example' => 'xsfwsddd==',
],
'Name' => [
'title' => '子场景名称',
'description' => '子场景名称',
'type' => 'string',
'example' => '子场景A',
],
'ResourceId' => [
'title' => '图片ID/视频ID',
'description' => '图片ID/视频ID(加密ID)',
'type' => 'string',
'example' => '2345****',
],
'Url' => [
'title' => '图片路径/视频路径',
'description' => '图片路径/视频路径',
'type' => 'string',
'example' => 'https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'CoverUrl' => [
'title' => '图片路径/视频封面路径',
'description' => '图片路径/视频封面路径',
'type' => 'string',
'example' => 'https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'Status' => [
'title' => '子场景状态 1.未重建, * 2.中间模型重建中, * 3.中间模型重建完成, * 4.待重建, * 5.服务商重建中, * 6.服务商重建完成, * 7.已发布 * 8.发布中',
'description' => '子场景状态 1.未重建 2.中间模型重建中 3.中间模型重建完成 4.待重建 5.服务商重建中 6.服务商重建完成 7.已发布 8.发布中',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'GmtModified' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'ResourceName' => [
'title' => '资源名称',
'description' => '资源名称(有两种:jpg/mp4)'."\n",
'type' => 'string',
'example' => 'xxxx.jpg',
],
'CubemapPath' => [
'title' => '切图的路径',
'description' => '切图的路径(注意:有两种格式)'."\n"
.'1、****/pano_src'."\n"
.'2、****/cubemap',
'type' => 'string',
'example' => '****/pano_src',
],
'Deleted' => [
'title' => '是否删除',
'description' => '是否删除',
'type' => 'boolean',
'example' => 'true',
],
'OriginUrl' => [
'title' => '原图地址',
'description' => '原图地址',
'type' => 'string',
'example' => 'https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'BaseImageUrl' => [
'title' => '2k基准图路径',
'description' => '2k基准图路径',
'type' => 'string',
'example' => 'https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'LayoutData' => [
'title' => '标注数据',
'description' => '标注数据',
'type' => 'string',
'example' => '{}',
],
'Type' => [
'title' => '上传资源类型',
'description' => '上传资源类型(IMAGE、VIDEO)',
'type' => 'string',
'example' => 'IMAGE',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"HasNext\\": true,\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 5,\\n \\"Count\\": 100,\\n \\"List\\": [\\n {\\n \\"Id\\": \\"xsfwsddd==\\",\\n \\"Name\\": \\"子场景A\\",\\n \\"ResourceId\\": \\"2345****\\",\\n \\"Url\\": \\"https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"CoverUrl\\": \\"https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"Status\\": 1,\\n \\"GmtCreate\\": 1621236933677,\\n \\"GmtModified\\": 1621236933677,\\n \\"ResourceName\\": \\"xxxx.jpg\\",\\n \\"CubemapPath\\": \\"****/pano_src\\",\\n \\"Deleted\\": true,\\n \\"OriginUrl\\": \\"https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"BaseImageUrl\\": \\"https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\",\\n \\"LayoutData\\": \\"{}\\",\\n \\"Type\\": \\"IMAGE\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n true\\n 1\\n 5\\n 100\\n \\n xsfwsddd==\\n 子场景A\\n 2345****\\n https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n 1\\n 1621236933677\\n 1621236933677\\n xxxx.jpg\\n ****/pano_src\\n true\\n https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n https:/image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n {}\\n IMAGE\\n
\\n","errorExample":""}]',
'title' => '分页查看子场景列表',
],
'AddProject' => [
'summary' => '创建一个新项目。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'BusinessId',
'in' => 'query',
'schema' => [
'title' => '业务id',
'description' => '业务id,默认取值5(未归属项目),无特殊需求不要填写此参数',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '5432****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '项目名称',
'description' => '项目名称',
'type' => 'string',
'required' => true,
'example' => '项目A',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb130936****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '项目ID',
'description' => '项目ID',
'type' => 'string',
'example' => '1234****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"344794c32937474a9c59eb130936****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"1234****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 344794c32937474a9c59eb130936****\\n 200\\n true\\n success\\n 1234****\\n","errorExample":""}]',
'title' => '创建新项目',
],
'DropProject' => [
'summary' => '删除已有项目,项目下存在已发布场景的不支持删除。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'title' => '项目ID',
'description' => '项目ID',
'type' => 'string',
'required' => true,
'example' => '3242****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID与入参中requestId对应',
'description' => '请求ID与入参中requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '删除项目',
],
'UpdateProject' => [
'summary' => '更新指定的项目信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '项目id',
'description' => '项目ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '项目名称',
'description' => '项目名称',
'type' => 'string',
'required' => false,
'example' => '项目A',
],
],
[
'name' => 'BusinessId',
'in' => 'query',
'schema' => [
'title' => '业务Id',
'description' => '业务ID',
'type' => 'string',
'required' => false,
'example' => '5432****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新项目名称',
],
'DetailProject' => [
'summary' => '查询项目基本信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '项目Id',
'description' => '项目ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Id' => [
'title' => '项目ID',
'description' => '项目ID',
'type' => 'string',
'example' => '1234****',
],
'Name' => [
'title' => '项目名称',
'description' => '项目名称',
'type' => 'string',
'example' => '项目A',
],
'BusinessId' => [
'title' => '业务ID',
'description' => '业务ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5244****',
],
'BusinessName' => [
'title' => '业务名称',
'description' => '业务名称',
'type' => 'string',
'example' => '默认',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'GmtModified' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1621236933677',
],
'Token' => [
'title' => 'Token',
'description' => 'Token',
'type' => 'string',
'example' => 'd989623696ab4f87a80b8d5b0b00****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Id\\": \\"1234****\\",\\n \\"Name\\": \\"项目A\\",\\n \\"BusinessId\\": 0,\\n \\"BusinessName\\": \\"默认\\",\\n \\"GmtCreate\\": 1621236933677,\\n \\"GmtModified\\": 1621236933677,\\n \\"Token\\": \\"d989623696ab4f87a80b8d5b0b00****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n 1234****\\n 项目A\\n 默认\\n 1621236933677\\n 1621236933677\\n d989623696ab4f87a80b8d5b0b00****\\n","errorExample":""}]',
'title' => '查询项目信息',
],
'ListProject' => [
'summary' => '分页获取所有项目列表。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'title' => '页码',
'description' => '页码',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => false,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '页长',
'description' => '页长',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '项目名称(使用name%搜索)',
'description' => '项目名称(使用name%搜索)',
'type' => 'string',
'required' => false,
'example' => '项目A',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'HasNext' => [
'title' => '是否有下一页',
'description' => '是否有下一页',
'type' => 'boolean',
'example' => 'true',
],
'CurrentPage' => [
'title' => '当前页',
'description' => '当前页',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalPage' => [
'title' => '总页数',
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'Count' => [
'title' => 'count',
'description' => 'count',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'List' => [
'title' => '项目数据',
'description' => '项目数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '项目ID',
'description' => '项目ID',
'type' => 'string',
'example' => '1234****',
],
'Name' => [
'title' => '项目名称',
'description' => '项目名称',
'type' => 'string',
'example' => '项目A',
],
'BusinessId' => [
'title' => '业务ID',
'description' => '业务ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5244****',
],
'BusinessName' => [
'title' => '业务名称',
'description' => '业务名称',
'type' => 'string',
'example' => '默认',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '123123',
],
'ModifiedTime' => [
'title' => '最后修改时间',
'description' => '最后修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '123214',
],
'Token' => [
'title' => 'Token',
'description' => 'Token',
'type' => 'string',
'example' => 'd989623696ab4f87a80b8d5b0b0****',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"HasNext\\": true,\\n \\"CurrentPage\\": 1,\\n \\"TotalPage\\": 5,\\n \\"Count\\": 100,\\n \\"List\\": [\\n {\\n \\"Id\\": \\"1234****\\",\\n \\"Name\\": \\"项目A\\",\\n \\"BusinessId\\": 0,\\n \\"BusinessName\\": \\"默认\\",\\n \\"CreateTime\\": 123123,\\n \\"ModifiedTime\\": 123214,\\n \\"Token\\": \\"d989623696ab4f87a80b8d5b0b0****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n true\\n 1\\n 5\\n 100\\n \\n 1234****\\n 项目A\\n 默认\\n 123123\\n 123214\\n d989623696ab4f87a80b8d5b0b0****\\n
\\n","errorExample":""}]',
'title' => '分页查询项目列表',
],
'AddMosaics' => [
'summary' => '自定义区域打马赛克。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => 'skjjskjk****',
],
],
[
'name' => 'MarkPosition',
'in' => 'query',
'schema' => [
'title' => '马赛克位置数据',
'description' => '马赛克位置数据',
'type' => 'string',
'required' => true,
'example' => '[{"x": 504,"y": 450,"w": 256,"h": 153}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '3BCAD49D-2AC1-13EB-AC19-8C7A46C****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => 'OvFuuwhfoAX8uIpxC/GJ****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BCAD49D-2AC1-13EB-AC19-8C7A46C****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"TaskId\\": \\"OvFuuwhfoAX8uIpxC/GJ****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 3BCAD49D-2AC1-13EB-AC19-8C7A46C****\\n 200\\n true\\n SUCCESS\\n OvFuuwhfoAX8uIpxC/GJ****\\n","errorExample":""}]',
'title' => '添加马赛克',
],
'GetHotspotConfig' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'description' => '预览token',
'type' => 'string',
'required' => true,
'example' => '344794c32937474a9c59eb130936****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '0 未发布, 1 已发布',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '0',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '是否开启自用资源访问(需要在发布场景之前开启)',
'type' => 'boolean',
'required' => false,
'example' => 'true/false',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'description' => '自定义OSS域名(可为CDN域名)',
'type' => 'string',
'required' => false,
'example' => 'www.aliyundoc.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '热点配置信息',
'type' => 'string',
'example' => 'config',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"config\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n config\\n","errorExample":""}]',
'title' => '查询热点标注配置',
'summary' => '查询热点标注配置,后处理时使用。',
],
'GetHotspotTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'description' => '预览token',
'type' => 'string',
'required' => false,
'example' => '344794c32937474a9c59eb130936****',
],
],
[
'name' => 'SubSceneUuid',
'in' => 'query',
'schema' => [
'description' => '子场景Uid'."\n",
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '类型0:未发布。1:已发布',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '是否开启自用资源访问',
'type' => 'boolean',
'required' => false,
'example' => 'true/false',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'description' => '自定义OSS域名(可为CDN域名)',
'type' => 'string',
'required' => false,
'example' => 'www.aliyundoc.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'ObjectString' => [
'description' => '热点信息字符串',
'type' => 'string',
'example' => '"{}"',
],
'Data' => [
'description' => '热点信息',
'type' => 'string',
'example' => '{"watermarkImg":[],"enabledTitleTag":0}',
],
'ErrMessage' => [
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '请求是否成功',
'type' => 'boolean',
'example' => 'true',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"ObjectString\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"Data\\": \\"{\\\\\\"watermarkImg\\\\\\":[],\\\\\\"enabledTitleTag\\\\\\":0}\\",\\n \\"ErrMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n \\"{}\\"\\n json数据\\n success\\n true\\n","errorExample":""}]',
'title' => '获取热点标注信息',
'summary' => '获取热点标注信息,后处理时使用。',
],
'GetWindowConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'description' => '预览token',
'type' => 'string',
'required' => false,
'example' => '5dc5c2dd927e45039dadb312384b****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据'."\n",
'type' => 'object',
'example' => '2345****',
],
'ObjectString' => [
'description' => '配置信息JSON字符串',
'type' => 'string',
'example' => '"{}"',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Success' => [
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'success',
],
'ErrMessage' => [
'description' => '错误信息'."\n",
'type' => 'string',
'example' => '错误信息',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is invalid. For more information, see Signature Mechanism.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ObjectString\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"错误信息\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n json字符串\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n false\\n 错误信息\\n","errorExample":""}]',
'title' => '获取系统配置信息',
'summary' => '获取系统配置信息,预览、后处理时使用。',
],
'PublishHotspot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ParamTag',
'in' => 'query',
'schema' => [
'description' => '热点标签数据',
'type' => 'string',
'required' => false,
'example' => 'json字符串',
],
],
[
'name' => 'SubSceneUuid',
'in' => 'query',
'schema' => [
'description' => '子场景ID',
'type' => 'string',
'required' => false,
'example' => '2345****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '请求结果',
'type' => 'object',
'example' => '2345****',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'success',
],
'ErrMessage' => [
'description' => '错误信息'."\n",
'type' => 'string',
'example' => '错误信息',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is invalid. For more information, see Signature Mechanism.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"错误信息\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n false\\n 错误信息\\n","errorExample":""}]',
'title' => '发布热点信息',
'summary' => '发布热点信息。',
],
'SaveHotspotConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ParamTag',
'in' => 'query',
'schema' => [
'description' => '配置信息',
'type' => 'string',
'required' => false,
'example' => '{enabledTitleTag: 0, watermarkImg: []}',
],
],
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'description' => '预览token',
'type' => 'string',
'required' => false,
'example' => '5dc5c2dd927e45039dadb312384b****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'success',
],
'ErrMessage' => [
'description' => '错误信息',
'type' => 'string',
'example' => '错误信息',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is invalid. For more information, see Signature Mechanism.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"错误信息\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n false\\n 错误信息\\n","errorExample":""}]',
'title' => '保存热点标注配置',
'summary' => '保存热点标注配置,后处理时使用。',
],
'SaveHotspotTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
[
'PrivateKey' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ParamTag',
'in' => 'query',
'schema' => [
'description' => '热点标签数据',
'type' => 'string',
'required' => false,
'example' => 'json字符串',
],
],
[
'name' => 'SubSceneUuid',
'in' => 'query',
'schema' => [
'description' => '子场景ID',
'type' => 'string',
'required' => false,
'example' => '2345****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Success' => [
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'success',
],
'ErrMessage' => [
'description' => '错误信息',
'type' => 'string',
'example' => '错误信息',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter is invalid. For more information, see Signature Mechanism.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"错误信息\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n false\\n 错误信息\\n","errorExample":""}]',
'title' => '保存热点标注信息',
'summary' => '保存热点标注信息,后处理时使用。',
],
'TempPreviewStatus' => [
'summary' => '查询预览任务状态,调用TempPreview后可以使用此接口查看任务状态,当任务结束后才可以使用预览链接进行预览,需要在调用TempPreview接口后10分钟之内调用。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '任务ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Status' => [
'title' => '状态标识',
'description' => 'processing:处理中 succeed:成功 failed:失败',
'type' => 'string',
'example' => 'processing',
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '鉴权请求Action。',
'type' => 'string',
'example' => 'tdsr:TempPreviewStatus',
],
'AuthPrincipalDisplayName' => [
'description' => '请求中用于鉴权的身份标识。具体取值为:'."\n"
.'- RAM 用户:RAM 用户 UID'."\n"
.'- RAM 角色:RoleName:RoleSessionName'."\n"
.'- Federated:ProviderType/ProviderName',
'type' => 'string',
'example' => '2xxxxxxxxxxxxx',
],
'AuthPrincipalOwnerId' => [
'description' => '请求中用于鉴权的身份所属的阿里云账号UID信息',
'type' => 'string',
'example' => '1xxxxx',
],
'AuthPrincipalType' => [
'description' => '请求中用于鉴权的身份类型。具体取值为:'."\n"
.'- RAM 用户:SubUser'."\n"
.'- RAM 角色:AssumedRoleUser'."\n"
.'- SSO 联合身份:Federated',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '编码后的用于权限诊断的信息',
'type' => 'string',
'example' => 'AABBCCxxxxxxxx',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ExplicitDeny',
],
'PolicyType' => [
'description' => '导致鉴权失败的策略类型。具体取值为:'."\n"
.'- 管控策略:ControlPolicy'."\n"
.'- 会话策略:SessionPolicy'."\n"
.'- 角色信任策略:AssumeRolePolicy'."\n"
.'- 基于身份策略(账号级):AccountLevelIdentityBasedPolicy'."\n"
.'- 基于身份策略(资源组级): ResourceGroupLevelIdentityBasedPolicy'."\n"
.'- OSS Bucket Policy:BucketPolicy'."\n"
.'- SLS Project Policy:ProjectPolicy',
'type' => 'string',
'example' => 'AccountLevelIdentityBasedPolicy',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"processing\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"tdsr:TempPreviewStatus\\",\\n \\"AuthPrincipalDisplayName\\": \\"2xxxxxxxxxxxxx\\",\\n \\"AuthPrincipalOwnerId\\": \\"1xxxxx\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AABBCCxxxxxxxx\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n processing\\n","errorExample":""}]',
'title' => '查询预览任务状态',
'description' => '当预览任务成功结束后才可以使用预览链接进行预览,使用[预览](https://help.aliyun.com/document_detail/254008.html)接口发起预览任务后10分钟内可使用此接口获取预览任务状态。',
],
'GetSingleConnData' => [
'summary' => '获取单图的关联信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'minimum' => '1',
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Version' => [
'title' => '版本',
'description' => '版本',
'type' => 'string',
'example' => '2.1',
],
'List' => [
'title' => '关联信息',
'description' => '关联信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => 'ID',
'description' => 'ID',
'type' => 'string',
'example' => '1#234@abc',
],
'MapId' => [
'title' => '关联ID',
'description' => '关联ID',
'type' => 'string',
'example' => '1#567#def',
],
'Type' => [
'title' => 'outer:外关联 inner:内关联 stair:楼梯关联',
'description' => 'outer:外关联 inner:内关联 stair:楼梯关联',
'type' => 'string',
'example' => 'outer',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Version\\": \\"2.1\\",\\n \\"List\\": [\\n {\\n \\"Id\\": \\"1#234@abc\\",\\n \\"MapId\\": \\"1#567#def\\",\\n \\"Type\\": \\"outer\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 2.1\\n \\n 1#234@abc\\n 1#567#def\\n outer\\n
\\n","errorExample":""}]',
'title' => '获取单图的关联信息',
],
'GetTaskStatus' => [
'summary' => '查询任务状态,可以查询所有类型任务状态。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Status' => [
'title' => '未开始 :init 处理中 : processing 失败 :failure 完成 :succeed 取消 :canceled',
'description' => '未开始 :init 处理中 : processing 失败 :failed 完成 :succeed 取消 :canceled',
'type' => 'string',
'example' => 'init',
],
'Type' => [
'title' => '墙线预测: wall_line 切图: cut_image 重建: build 直角优化:right_angle_optimization 其他:other',
'description' => '墙线预测:wall_line 切图:cut_image 重建:build 直角优化:right_angle_optimization 其他:other ',
'type' => 'string',
'example' => 'wallline',
],
'ErrorCode' => [
'title' => '任务执行失败错误码',
'description' => '任务执行失败错误码',
'type' => 'string',
'example' => '2001',
],
'ErrorMsg' => [
'title' => '任务执行失败错误消息',
'description' => '任务执行失败错误消息',
'type' => 'string',
'example' => '未检测到墙线',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"init\\",\\n \\"Type\\": \\"wallline\\",\\n \\"ErrorCode\\": \\"2001\\",\\n \\"ErrorMsg\\": \\"未检测到墙线\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n init\\n wallline\\n 2001\\n 未检测到墙线\\n","errorExample":""}]',
'title' => '查询任务状态',
],
'RectVertical' => [
'summary' => '对指定子场景下的图片进行垂直矫正,矫正后会删除该子场景关联关系。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'VerticalRect',
'in' => 'query',
'schema' => [
'title' => '矫正数据',
'description' => '矫正数据',
'type' => 'string',
'required' => true,
'example' => '{"844946777965268992":[[0.42418407210144654,0.33625107620738004,0.42620819117478337,0.635753199572695],[0.5158627587152769,0.3071978991900134,0.5177513758740194,0.6312118011104786],[0.582693212445534,0.3733969265933281,0.5807612760319687,0.6139402811250833]]}',
],
],
[
'name' => 'DetectDoor',
'in' => 'query',
'schema' => [
'title' => '是否开启门预测',
'description' => '是否开启门预测',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'CountDetectDoor',
'in' => 'query',
'schema' => [
'title' => '需要预测的门的数量',
'description' => '需要预测的门的数量,DetectDoor为true时生效',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '错误消息',
'description' => '任务ID',
'type' => 'string',
'example' => 'syuwoiewyieiyy****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"syuwoiewyieiyy****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n syuwoiewyieiyy****\\n","errorExample":""}]',
'title' => '垂直矫正',
],
'GetLayoutData' => [
'summary' => '获取最新标注信息,标注时使用。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'title' => '标注信息',
'description' => '标注信息',
'type' => 'string',
'example' => '{}',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"{}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n {}\\n","errorExample":""}]',
'title' => '获取最新标注信息',
],
'TempPreview' => [
'summary' => '重建后可以调用此预览接口获取预览链接。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '主场景ID',
'type' => 'string',
'required' => true,
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'PreviewUrl' => [
'title' => '预览链接',
'description' => '临时预览链接,12小时内有效',
'type' => 'string',
'example' => 'https://preview-lyj.aliyuncs.com/preview/temp/xxx****',
],
'SceneId' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"PreviewUrl\\": \\"https://preview-lyj.aliyuncs.com/preview/temp/xxx****\\",\\n \\"SceneId\\": \\"m+0cmndEGjg9pv/hy4jh****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n https://preview-lyj.aliyuncs.com/preview/temp/xxx****\\n m+0cmndEGjg9pv/hy4jh****\\n","errorExample":""}]',
'title' => '预览',
],
'LabelBuild' => [
'summary' => '3D模型重建。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => [
'title' => '重建模式:MANUAL:手动(云端),默认,SEMI_AUTOMATIC:半自动(移动端)',
'description' => 'MANUAL(手动):仅限使用标注工具重建时使用此参数(默认调用参数);'."\n"
.'SEMI_AUTOMATIC(自动):仅限基于App端进行自动化建模时使用;',
'type' => 'string',
'required' => false,
'example' => 'MANUAL(手动)/SEMI_AUTOMATIC(自动)',
],
],
[
'name' => 'WallHeight',
'in' => 'query',
'schema' => [
'title' => '墙高,默认0不设置,范围200-1000. 单位cm',
'description' => '墙高,默认0不设置,范围200-1000. 单位cm',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'OptimizeWallWidth',
'in' => 'query',
'schema' => [
'title' => '墙宽优化,OFF:关闭(默认) NORMAL:标准 ENHANCED:加强',
'description' => '墙宽优化,OFF:关闭(默认) NORMAL:标准 ENHANCED:加强',
'type' => 'string',
'required' => false,
'example' => 'OFF',
],
],
[
'name' => 'ModelStyle',
'in' => 'query',
'schema' => [
'title' => '模型效果 PATCH:切片模型(默认) DEPTH:深度模型 VIRTUAL:虚拟模型 MOBILE:移动重建模型',
'description' => '模型效果 PATCH:切片模型(默认) DEPTH:深度模型 ',
'type' => 'string',
'required' => false,
'example' => 'PATCH',
],
],
[
'name' => 'PlanStyle',
'in' => 'query',
'schema' => [
'title' => '户型图,DEFAULT(默认),STANDARD(标准)',
'description' => '户型图,DEFAULT(默认),STANDARD(标准)',
'type' => 'string',
'required' => false,
'example' => 'DEFAULT',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '重建任务ID',
'description' => '重建任务ID',
'type' => 'string',
'example' => '234****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"234****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 234****\\n","errorExample":""}]',
'title' => '模型重建',
],
'GetOssPolicy' => [
'summary' => '获取oss授权,获取授权后使用OSS SDK往指定路径上传图片或视频文件,上传完后直接调用LinkImage接口往子场景中添加图片。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessId' => [
'title' => 'accessId',
'description' => 'accessId,OSS SDK上传时参数,对应OSSAccessKeyId',
'type' => 'string',
'example' => 'abc',
],
'Policy' => [
'title' => '授权',
'description' => '授权,OSS SDK上传时参数,对应policy',
'type' => 'string',
'example' => 'def',
],
'Signature' => [
'title' => '签名',
'description' => '签名,OSS SDK上传时参数,对应signature',
'type' => 'string',
'example' => 'ghi',
],
'Dir' => [
'title' => '授权路径',
'description' => '授权路径,OSS SDK上传时参数,需要拼接文件名后使用, ${DIR}/xxx.jpg对应key',
'type' => 'string',
'example' => '123/',
],
'Host' => [
'title' => '上传地址',
'description' => '上传地址, OSS SDK上传时的请求地址',
'type' => 'string',
'example' => 'oss.aliyun.com',
],
'Expire' => [
'title' => '授权失效时间(s)',
'description' => '授权失效时间(s),可以判断授权是否在有效期内,失效后授权不可用',
'type' => 'string',
'example' => '60',
],
'Callback' => [
'title' => '上传回调',
'description' => '上传回调,保留字段,目前未使用',
'type' => 'string',
'example' => '""',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"AccessId\\": \\"abc\\",\\n \\"Policy\\": \\"def\\",\\n \\"Signature\\": \\"ghi\\",\\n \\"Dir\\": \\"123/\\",\\n \\"Host\\": \\"oss.aliyun.com\\",\\n \\"Expire\\": \\"60\\",\\n \\"Callback\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n abc\\n def\\n ghi\\n 123/\\n oss.aliyun.com\\n 60\\n \\"\\"\\n","errorExample":""}]',
'title' => '获取OSS授权',
'description' => '获取上传凭据后请参考[服务端签名后直传](https://help.aliyun.com/document_detail/31926.html)流程上传文件,上传后调用[关联图片到子场景](https://help.aliyun.com/document_detail/254024.html)接口关联图片到子场景。',
],
'PredictionWallLine' => [
'summary' => '墙线预测,返回taskId以及subsceneId,可以根据taskId查询任务状态,任务结束后可以根据subsceneId查询具体墙线数据。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'title' => '图片地址',
'description' => '图片地址',
'type' => 'string',
'required' => true,
'example' => 'https://www.aliyundoc.com/****.jpg',
],
],
[
'name' => 'CameraHeight',
'in' => 'query',
'schema' => [
'title' => '相机高度 单位 cm',
'description' => '相机高度单位 cm',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '160',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => '1234****',
],
'SubSceneId' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'example' => '2345****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"1234****\\",\\n \\"SubSceneId\\": \\"2345****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 1234****\\n 2345****\\n","errorExample":""}]',
'title' => '墙线预测',
],
'GetSceneBuildTaskStatus' => [
'summary' => '查询场景重建任务状态。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'SceneId' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
'Status' => [
'title' => '未开始 init 处理中 失败 failed processing 完成 succeed 取消 canceled',
'description' => '未开始:init; 处理中:processing; 失败:failed;完成:succeed; 取消:canceled;',
'type' => 'string',
'example' => 'failed',
],
'ErrorCode' => [
'title' => '任务失败错误码',
'description' => '任务失败错误码',
'type' => 'string',
'example' => '2001',
],
'ErrorMsg' => [
'title' => '任务失败错误消息',
'description' => '任务失败错误消息',
'type' => 'string',
'example' => '墙线数量少于4',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"SceneId\\": \\"m+0cmndEGjg9pv/hy4jh****\\",\\n \\"Status\\": \\"failed\\",\\n \\"ErrorCode\\": \\"2001\\",\\n \\"ErrorMsg\\": \\"墙线数量少于4\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n m+0cmndEGjg9pv/hy4jh****\\n failed\\n 2001\\n 墙线数量少于4\\n","errorExample":""}]',
'title' => '查询场景重建任务状态',
],
'UpdateConnData' => [
'summary' => '更新关联信息,标注时使用,保存最新关联数据。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'ConnData',
'in' => 'query',
'schema' => [
'title' => '关联数据',
'description' => '关联数据',
'type' => 'string',
'required' => true,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新关联信息',
],
'PredImage' => [
'summary' => '图片预处理,包括垂直矫正、墙线预测、门预测,自动门预测与切图失败时可使用此接口发起重试。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'minimum' => '1',
'example' => '2345****',
],
],
[
'name' => 'DetectDoor',
'in' => 'query',
'schema' => [
'title' => '是否门预测',
'description' => '是否门预测',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'CountDetectDoor',
'in' => 'query',
'schema' => [
'title' => '门数量(DetectDoor为false时,可为0)',
'description' => '门数量',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '10',
'exclusiveMaximum' => false,
'minimum' => '1',
'exclusiveMinimum' => false,
'example' => '2',
],
],
[
'name' => 'CorrectVertical',
'in' => 'query',
'schema' => [
'title' => '是否垂直矫正',
'description' => '是否垂直矫正',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => '1234****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"1234****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 1234****\\n","errorExample":""}]',
'title' => '图片预处理',
],
'GetRectifyImage' => [
'summary' => '获取垂直矫正后的图片。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Url' => [
'title' => '图片地址',
'description' => '图片地址',
'type' => 'string',
'example' => 'https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Url\\": \\"https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n https://image-demo.oss-cn-hangzhou.aliyuncs.com/****.jpg\\n","errorExample":""}]',
'title' => '获取矫正后图片',
],
'GetOriginLayoutData' => [
'summary' => '获取原始标注信息,可以配合更新标注信息接口使用来还原标注信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'title' => '标注数据',
'description' => '标注数据',
'type' => 'string',
'example' => '{}',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"{}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n {}\\n","errorExample":""}]',
'title' => '获取原始标注信息',
],
'RectifyImage' => [
'summary' => '对输入图片进行垂直矫正。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Url',
'in' => 'query',
'schema' => [
'title' => '图片地址',
'description' => '图片地址',
'type' => 'string',
'required' => true,
'example' => 'https://www.aliyundoc.com/****.jpg',
],
],
[
'name' => 'CameraHeight',
'in' => 'query',
'schema' => [
'title' => '相机高度 单位 cm',
'description' => '相机高度单位 cm',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '160',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => '1234****',
],
'SubSceneId' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'example' => '2345****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"1234****\\",\\n \\"SubSceneId\\": \\"2345****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 1234****\\n 2345****\\n","errorExample":""}]',
'title' => '图片矫正',
],
'LinkImage' => [
'summary' => '关联图片或视频到子场景,目前一个子场景只能关联一张图片或者一个视频。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'title' => '图片或者视频名称xxx.jpg',
'description' => '图片或者视频名称(****.jpg/****.mp4)',
'type' => 'string',
'required' => true,
'example' => '****.jpg',
],
],
[
'name' => 'CameraHeight',
'in' => 'query',
'schema' => [
'title' => '相机高度 单位 cm',
'description' => '相机高度单位 cm',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '160',
],
],
[
'name' => 'Platform',
'in' => 'query',
'schema' => [
'title' => '平台标识,默认PC',
'description' => '平台标识:PC/MOBILE,默认为PC',
'type' => 'string',
'required' => false,
'example' => 'PC',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'ResourceId' => [
'title' => '图片/视频ID',
'description' => '图片/视频ID',
'type' => 'string',
'example' => '234****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"ResourceId\\": \\"234****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 234****\\n","errorExample":""}]',
'title' => '关联图片到子场景',
],
'OptimizeRightAngle' => [
'summary' => '将墙交汇处优化为直角。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => '2345****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"2345****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 2345****\\n","errorExample":""}]',
'title' => '直角优化',
],
'GetConnData' => [
'summary' => '获取关联信息,标注时使用。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Version' => [
'title' => '版本',
'description' => '版本',
'type' => 'string',
'example' => '2.1',
],
'Extend' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '{}',
],
'List' => [
'title' => '关联信息',
'description' => '关联信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => 'ID',
'description' => 'ID',
'type' => 'string',
'example' => '1#234#abc',
],
'MapId' => [
'title' => '关联的ID',
'description' => '关联的ID',
'type' => 'string',
'example' => '1#456#def',
],
'Type' => [
'title' => 'outer:外关联 inner:内关联 stair:楼梯关联',
'description' => 'outer:外关联 inner:内关联 stair:楼梯关联',
'type' => 'string',
'example' => 'outer',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Version\\": \\"2.1\\",\\n \\"Extend\\": \\"{}\\",\\n \\"List\\": [\\n {\\n \\"Id\\": \\"1#234#abc\\",\\n \\"MapId\\": \\"1#456#def\\",\\n \\"Type\\": \\"outer\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n 2.1\\n {}\\n \\n 1#234#abc\\n 1#456#def\\n outer\\n
\\n","errorExample":""}]',
'title' => '获取关联信息',
],
'UpdateLayoutData' => [
'summary' => '更新标注信息,标注后可以使用此接口保存标注信息。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'LayoutData',
'in' => 'query',
'schema' => [
'title' => '标注数据',
'description' => '标注数据',
'type' => 'string',
'required' => true,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新标注信息',
],
'GetSubSceneTaskStatus' => [
'summary' => '子场景的预处理及切图状态。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'List' => [
'title' => '任务信息',
'description' => '任务信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => '4638****',
],
'SceneId' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'example' => '2345****',
],
'SubSceneId' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'example' => '3456***',
],
'Status' => [
'title' => '未开始 init 处理中 processing 失败 failure 完成 succeed 取消 canceled',
'description' => '未开始 init 处理中 processing 失败 failure 完成 succeed 取消 canceled',
'type' => 'string',
'example' => 'init',
],
'Type' => [
'title' => '墙线预测: wall_line 切图: cut_image 重建: build 直角优化:right_angle_optimization 其他:other',
'description' => '墙线预测:wall_line 切图:cut_image 重建:build 直角优化:right_angle_optimization 其他:other ',
'type' => 'string',
'example' => 'cutimage',
],
'ErrorCode' => [
'title' => '任务失败错误码',
'description' => '任务失败错误码',
'type' => 'string',
'example' => '2001',
],
'ErrorMsg' => [
'title' => '任务失败错误信息',
'description' => '任务失败错误信息',
'type' => 'string',
'example' => '异常信息',
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"List\\": [\\n {\\n \\"Id\\": \\"4638****\\",\\n \\"SceneId\\": \\"2345****\\",\\n \\"SubSceneId\\": \\"3456***\\",\\n \\"Status\\": \\"init\\",\\n \\"Type\\": \\"cutimage\\",\\n \\"ErrorCode\\": \\"2001\\",\\n \\"ErrorMsg\\": \\"异常信息\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n \\n 4638****\\n 2345****\\n 3456***\\n init\\n cutimage\\n 2001\\n 异常信息\\n
\\n","errorExample":""}]',
'title' => '查看子场景预处理及切图状态',
],
'PublishScene' => [
'summary' => '场景发布。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'PreviewUrl' => [
'title' => '预览链接',
'description' => '正式预览链接 ',
'type' => 'string',
'example' => 'preview-lyj.aliyuncs.com/preview/xxx****',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"PreviewUrl\\": \\"preview-lyj.aliyuncs.com/preview/xxx****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n preview-lyj.aliyuncs.com/preview/xxx****\\n","errorExample":""}]',
'title' => '场景发布',
'description' => '请确保在使用该接口前,已充分了解临云镜产品的收费方式和[价格](https://help.aliyun.com/document_detail/159646.html)。',
],
'AddRelativePosition' => [
'summary' => '提交子场景间相对位置。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
[
'name' => 'RelativePosition',
'in' => 'query',
'schema' => [
'title' => '相对位置信息',
'description' => '相对位置信息',
'type' => 'string',
'required' => true,
'example' => '{"key":"value"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'staticInfo' => [
'noSubstitutionReason' => '无替代API,历史原因导致该API被标记为弃用。',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '相对位置提交',
],
'GetScenePreviewInfo' => [
'summary' => '获取场景模型点位信息。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ModelToken',
'in' => 'query',
'schema' => [
'title' => '模型token',
'description' => '模型token',
'type' => 'string',
'required' => true,
'example' => 'A.e.RQJRPYGIJJQP****',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'title' => '自定义oss域名(可为cdn域名)',
'description' => '自定义OSS域名(可为CDN域名)',
'type' => 'string',
'required' => false,
'example' => 'www.aliyundoc.com',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'title' => '是否开启自用资源访问',
'description' => '是否开启自用资源访问',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '0:成功,其他:失败',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true/false',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '业务数据',
'type' => 'object',
'properties' => [
'PanoList' => [
'title' => 'html转译后的预览数据',
'description' => 'html转译后的预览数据',
'type' => 'string',
'example' => '一串转译数据',
],
'ModelPath' => [
'title' => '模型地址',
'description' => '模型地址',
'type' => 'string',
'example' => 'https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW/A.e.QRQRLWYEHIUEYLYW****.sgm',
],
'TextureModelPath' => [
'title' => '模型的贴图路径',
'description' => '模型的贴图路径',
'type' => 'string',
'example' => 'https:/www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/model_texture/',
],
'TexturePanoPath' => [
'title' => '漫游后预览图片路径',
'description' => '漫游后预览图片路径',
'type' => 'string',
'example' => 'https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/pano_texture/',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"PanoList\\": \\"一串转译数据\\",\\n \\"ModelPath\\": \\"https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW/A.e.QRQRLWYEHIUEYLYW****.sgm\\",\\n \\"TextureModelPath\\": \\"https:/www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/model_texture/\\",\\n \\"TexturePanoPath\\": \\"https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/pano_texture/\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4****\\n false\\n xxxxx\\n \\n 一串转译数据\\n https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW/A.e.QRQRLWYEHIUEYLYW****.sgm\\n https:/www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/model_texture/\\n https://www.aliyundoc.com/sgm/A.e.QRQRLWYEHIUEYLYW****/pano_texture/\\n \\n","errorExample":""}]',
'title' => '获取场景模型点位信息',
],
'GetHotspotSceneData' => [
'summary' => '根据预览token查询场景模型预览数据。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'title' => '预览token',
'description' => '预览token',
'type' => 'string',
'required' => true,
'example' => '344794c32937474a9c59eb130936****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '0 未发布, 1 已发布',
'description' => '0 未发布, 1 已发布',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '1',
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'title' => '自定义oss域名(可为cdn域名)',
'description' => '自定义OSS域名(可为CDN域名)',
'type' => 'string',
'required' => false,
'example' => 'www.aliyundoc.com',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'title' => '是否开启自用资源访问',
'description' => '是否开启自用资源访问',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true/false',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '业务数据',
'type' => 'object',
'properties' => [
'SceneType' => [
'title' => '3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO',
'description' => '3D模型:MODEL_3D 全景图片:PIC 全景视频:VIDEO',
'type' => 'string',
'example' => 'MODEL_3D',
],
'PreviewToken' => [
'title' => '预览token',
'description' => '预览token',
'type' => 'string',
'example' => '344794c32937474a9c59eb130936****',
],
'PreviewData' => [
'title' => 'html转译后的预览数据,包含图片、子场景ID等信息',
'description' => 'html转译后的预览数据,包含图片、子场景ID等信息',
'type' => 'string',
'example' => '一串转译数据',
],
'ModelToken' => [
'title' => '模型token(sgm token)',
'description' => '模型token(sgm token)',
'type' => 'string',
'example' => 'A.e.QRQRLWYEHIUE****',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"SceneType\\": \\"MODEL_3D\\",\\n \\"PreviewToken\\": \\"344794c32937474a9c59eb130936****\\",\\n \\"PreviewData\\": \\"一串转译数据\\",\\n \\"ModelToken\\": \\"A.e.QRQRLWYEHIUE****\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76****\\n false\\n xxxxx\\n \\n MODEL_3D\\n a888a26557174524b5558d65aab****\\n 一串转译数据\\n A.e.QRQRLWYEHIU****\\n \\n","errorExample":""}]',
'title' => '获取场景模型预览数据',
],
'RecoveryOriginImage' => [
'summary' => '该接口用于打马赛克图片的重置恢复。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SubSceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => 'skjjskjk****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '3BCAD49D-2AC1-13EB-AC19-8C7A46CF****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BCAD49D-2AC1-13EB-AC19-8C7A46CF****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 3BCAD49D-2AC1-13EB-AC19-8C7A46CF****\\n 200\\n true\\n SUCCESS\\n","errorExample":""}]',
'title' => '恢复原图',
],
'RollbackSubScene' => [
'summary' => '用于全景类型场景中已删除的子场景的恢复。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => 'skjjskjk****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '3BCAD49D-2AC1-13EB-AC19-8C7A46CF****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'sucess',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BCAD49D-2AC1-13EB-AC19-8C7A46CF****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"sucess\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 3BCAD49D-2AC1-13EB-AC19-8C7A46CF****\\n 200\\n true\\n sucess\\n","errorExample":""}]',
'title' => '回滚子场景',
],
'PublishStatus' => [
'summary' => '查询发布状态。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'm+0cmndEGjg9pv/hy4jh****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb130936****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Status' => [
'title' => '任务运行状态',
'description' => '场景发布状态,processing:处理中 succeed:成功 failed:失败',
'type' => 'string',
'example' => 'succeed',
],
'SyncStatus' => [
'title' => '文件同步状态',
'description' => '文件同步状态,processing:处理中 succeed:成功 failed:失败',
'type' => 'string',
'example' => 'succeed',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"344794c32937474a9c59eb130936****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Status\\": \\"succeed\\",\\n \\"SyncStatus\\": \\"succeed\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 344794c32937474a9c59eb130936****\\n 200\\n true\\n success\\n succeed\\n succeed\\n","errorExample":""}]',
'title' => '查询发布状态',
],
'AddRoomPlan' => [
'summary' => '通过移动端算法处理会生成相应的房屋数据,将该数据上传至云端后,可通过云端算法模块进行三维模型重建。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => '1234****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'title' => '文件上传凭据',
'description' => '文件上传凭据',
'type' => 'object',
'properties' => [
'AccessId' => [
'title' => 'accessId',
'description' => 'accessId,OSS SDK上传时参数,对应OSSAccessKeyId',
'type' => 'string',
'example' => 'LTAI****************',
],
'Policy' => [
'title' => '授权',
'description' => '授权,OSS SDK上传时参数,对应policy',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAy****',
],
'Signature' => [
'title' => '签名',
'description' => '签名,OSS SDK上传时参数,对应signature',
'type' => 'string',
'example' => 'ngEWGzttc3v2gJWCxEEt****',
],
'Dir' => [
'title' => '授权路径',
'description' => '授权路径,OSS SDK上传时参数,需要拼接文件名后使用, ${DIR}/xxx.jpg对应key',
'type' => 'string',
'example' => '123/',
],
'Host' => [
'title' => '上传地址',
'description' => '上传地址, OSS SDK上传时的请求地址',
'type' => 'string',
'example' => 'oss.aliyun.com',
],
'Expire' => [
'title' => '授权失效时间(s)',
'description' => '授权失效时间(s),可以判断授权是否在有效期内,失效后授权不可用',
'type' => 'string',
'example' => '1640315897',
],
'Callback' => [
'title' => '上传回调',
'description' => '上传回调,保留字段,目前未使用',
'type' => 'string',
'example' => '""',
],
],
],
'AccessDeniedDetail' => [
'description' => '无权限错误详情',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '请求中用于鉴权的操作信息',
'type' => 'string',
'example' => 'tdsr:AddRoomPlan',
],
'AuthPrincipalDisplayName' => [
'description' => '请求中用于鉴权的身份标识。具体取值为:'."\n"
.'- RAM 用户:RAM 用户 UID'."\n"
.'- RAM 角色:RoleName:RoleSessionName'."\n"
.'- Federated:ProviderType/ProviderName',
'type' => 'string',
'example' => '2xxxxxxxxxxxxx',
],
'AuthPrincipalOwnerId' => [
'description' => '请求中用于鉴权的身份所属的阿里云账号UID信息',
'type' => 'string',
'example' => '1xxxxx',
],
'AuthPrincipalType' => [
'description' => '请求中用于鉴权的身份类型。具体取值为:'."\n"
.'- RAM 用户:SubUser'."\n"
.'- RAM 角色:AssumedRoleUser'."\n"
.'- SSO 联合身份:Federated',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '编码后的用于权限诊断的信息',
'type' => 'string',
'example' => 'AABBCCxxxxxxxx',
],
'NoPermissionType' => [
'description' => 'NoPermissionType 导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '导致鉴权失败的策略类型。具体取值为:'."\n"
.'- 管控策略:ControlPolicy'."\n"
.'- 会话策略:SessionPolicy'."\n"
.'- 角色信任策略:AssumeRolePolicy'."\n"
.'- 基于身份策略(账号级):AccountLevelIdentityBasedPolicy'."\n"
.'- 基于身份策略(资源组级): ResourceGroupLevelIdentityBasedPolicy'."\n"
.'- OSS Bucket Policy:BucketPolicy'."\n"
.'- SLS Project Policy:ProjectPolicy',
'type' => 'string',
'example' => 'ResourceGroupLevelIdentityBassdPolicy',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AccessId\\": \\"LTAI****************\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAy****\\",\\n \\"Signature\\": \\"ngEWGzttc3v2gJWCxEEt****\\",\\n \\"Dir\\": \\"123/\\",\\n \\"Host\\": \\"oss.aliyun.com\\",\\n \\"Expire\\": \\"1640315897\\",\\n \\"Callback\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"tdsr:AddRoomPlan\\",\\n \\"AuthPrincipalDisplayName\\": \\"2xxxxxxxxxxxxx\\",\\n \\"AuthPrincipalOwnerId\\": \\"1xxxxx\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AABBCCxxxxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ResourceGroupLevelIdentityBassdPolicy\\"\\n }\\n}","type":"json"}]',
'title' => '房屋数据提交',
],
'GetScenePreviewData' => [
'summary' => '场景预览数据,用于模型渲染。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'title' => '预览token',
'description' => '预览token',
'type' => 'string',
'required' => true,
'example' => '2735913e96da44ea8c86f8e777c8****',
],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'title' => '自定义oss域名(可为cdn域名)',
'description' => '自定义oss域名(可为cdn域名)',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'title' => '是否开启自用资源访问(默认false)',
'description' => '是否开启自用资源访问(默认false)',
'type' => 'boolean',
'required' => false,
'example' => 'true/false',
],
],
[
'name' => 'ShowTag',
'in' => 'query',
'schema' => [
'title' => '是否返回热点数据(默认false)',
'description' => '是否返回热点数据(默认false)',
'type' => 'boolean',
'required' => false,
'example' => 'true/false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76FF387',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '0:成功,其他:失败',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true/false',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '响应数据',
'type' => 'object',
'properties' => [
'Model' => [
'title' => '模型数据',
'description' => '模型数据',
'type' => 'object',
'properties' => [
'PanoList' => [
'title' => '点位数据',
'description' => '点位数据',
'type' => 'array',
'items' => [
'description' => '模型场景数据',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '点位ID',
'description' => '点位ID',
'type' => 'string',
'example' => '1****',
],
'RawName' => [
'title' => '一个名称,无实际意义',
'description' => '一个名称,无实际意义',
'type' => 'string',
'example' => 'location_93132801658010****',
],
'FloorIdx' => [
'title' => '楼层号',
'description' => '楼层号',
'type' => 'string',
'example' => '1****',
],
'RoomIdx' => [
'title' => '房间号',
'description' => '房间号',
'type' => 'string',
'example' => '1****',
],
'Enabled' => [
'title' => '当前点位是否渲染,false不渲染,场景无法跳转',
'description' => '当前点位是否渲染,false不渲染,场景无法跳转',
'type' => 'boolean',
'example' => 'true/false',
],
'Token' => [
'title' => 'token',
'description' => 'token',
'type' => 'string',
'example' => 'sIPGWRGLJHEIQE****',
],
'Resource' => [
'title' => '全景贴图路径',
'description' => '全景贴图路径',
'type' => 'string',
'example' => 'sgm/A.e.EOGTOEGYOOI****/pano_texture/multi/0/%s.jpg',
],
'VirtualId' => [
'title' => '图片虚拟ID',
'description' => '图片虚拟ID',
'type' => 'string',
'example' => '93132801658010****',
],
'VirtualName' => [
'title' => '图片名称',
'description' => '图片名称',
'type' => 'string',
'example' => '卧室',
],
'MainImage' => [
'title' => '单房间多图情况下,是否为主图,默认true',
'description' => '单房间多图情况下,是否为主图,默认true',
'type' => 'boolean',
'example' => 'true/false',
],
'SubSceneId' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'example' => 'a7RqCd3kLMgglmn****',
],
'CurRoomPicList' => [
'title' => '当前房间的所有点位',
'description' => '当前房间的所有点位',
'type' => 'array',
'items' => [
'description' => '点位ID',
'type' => 'string',
'example' => '1****',
],
],
'Neighbours' => [
'title' => '当前房间邻近可视的点位id',
'description' => '当前房间邻近可视的点位id',
'type' => 'array',
'items' => [
'description' => '点位ID',
'type' => 'string',
'example' => '1****',
],
],
'Position' => [
'title' => '位置数据',
'description' => '位置数据',
'type' => 'object',
'properties' => [
'Viewpoint' => [
'title' => '当前子场景名标签在场景中的坐标',
'description' => '当前子场景名标签在场景中的坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '1.8893****',
],
],
'Spot' => [
'title' => '当前点位在场景中的坐标',
'description' => '当前点位在场景中的坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '0.23493****',
],
],
'Rotation' => [
'title' => '当前点位在场景中的旋转四元素',
'description' => '当前点位在场景中的旋转四元素',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '1.234893****',
],
],
],
],
],
],
],
'ModelPath' => [
'title' => '模型地址',
'description' => '模型地址',
'type' => 'string',
'example' => 'https://www.example.com/sgm/A.e.EOGTOE****/A.e.EOGTOE****.sgm',
],
'TextureModelPath' => [
'title' => '模型的贴图路径',
'description' => '模型的贴图路径',
'type' => 'string',
'example' => 'https://www.example.com/sgm/A.e.EOGTOE****/model_texture/',
],
'TexturePanoPath' => [
'title' => '漫游后预览图片路径',
'description' => '漫游后预览图片路径',
'type' => 'string',
'example' => 'https://www.example.com/sgm/A.e.EOGTOE****/pano_texture/',
],
],
],
'Tags' => [
'title' => '热点数据',
'description' => '热点数据',
'type' => 'array',
'items' => [
'description' => '热点数据',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '标签ID',
'description' => '标签ID',
'type' => 'string',
'example' => '1****',
],
'Type' => [
'title' => '热点类型',
'description' => '热点类型(TEXT | IMAGE | VIDEO | LINK | SCENESLINK)',
'type' => 'string',
'example' => 'IMAGE',
],
'Position' => [
'title' => '坐标',
'description' => '坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '1.0033',
],
],
'PositionPanoCube' => [
'description' => '坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '1.0033',
],
],
'Config' => [
'title' => '配置',
'description' => '配置',
'type' => 'object',
'properties' => [
'Title' => [
'title' => '标题',
'description' => '标题',
'type' => 'string',
'example' => '标题',
],
'Content' => [
'title' => '内容',
'description' => '内容',
'type' => 'string',
'example' => '内容',
],
'BackgroundColor' => [
'title' => '背景色',
'description' => '背景色',
'type' => 'string',
'example' => '#00000',
],
'PanoId' => [
'title' => '点位ID',
'description' => '点位ID',
'type' => 'string',
'example' => '1****',
],
'Video' => [
'title' => '视频链接',
'description' => '视频链接',
'type' => 'string',
'example' => 'http://www.example.com/****.mp4',
],
'Link' => [
'title' => '超链接',
'description' => '超链接',
'type' => 'string',
'example' => 'http://www.example.com/***',
],
'SceneId' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'integer',
'format' => 'int64',
'example' => '323****',
],
'Position' => [
'title' => '坐标',
'description' => '坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '-1.323****',
],
],
'PositionPanoCube' => [
'description' => '坐标',
'type' => 'array',
'items' => [
'description' => '坐标',
'type' => 'number',
'format' => 'double',
'example' => '1.323****',
],
],
'Images' => [
'title' => '图片链接',
'description' => '图片链接',
'type' => 'array',
'items' => [
'description' => '链接',
'type' => 'string',
'example' => 'http://www.example.com/****.jpg',
],
],
'ButtonConfig' => [
'title' => '按钮配置',
'description' => '按钮配置',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '按钮类型',
'type' => 'string',
'example' => 'CLICK_CHECK',
],
'CustomText' => [
'description' => '按钮内容',
'type' => 'string',
'example' => '点击查看',
],
],
],
'FormSelectImgType' => [
'description' => '内容类型,支持默认(default),小标(point),壁纸(mural)',
'type' => 'string',
'example' => 'default',
],
'IsTagVisibleBy3d' => [
'title' => '是否在鸟瞰模式下显示',
'description' => '是否在鸟瞰模式下显示',
'type' => 'boolean',
'example' => 'true/false',
],
'FormJumpType' => [
'description' => 'type为SCENESLINK时生效,背景图的大小',
'type' => 'boolean',
'example' => 'true/false',
],
'FormImgSize' => [
'description' => 'type为SCENESLINK时生效,背景图的大小',
'type' => 'array',
'items' => [
'description' => '大小',
'type' => 'integer',
'format' => 'int64',
'example' => '1****',
],
],
'RelatedPanoIds' => [
'description' => '当前热点所在房间的所有点位id'."\n",
'type' => 'array',
'items' => [
'description' => '点位ID',
'type' => 'string',
'example' => '1****',
],
],
],
],
],
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76FF387\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Model\\": {\\n \\"PanoList\\": [\\n {\\n \\"Id\\": \\"1****\\",\\n \\"RawName\\": \\"location_93132801658010****\\",\\n \\"FloorIdx\\": \\"1****\\",\\n \\"RoomIdx\\": \\"1****\\",\\n \\"Enabled\\": true,\\n \\"Token\\": \\"sIPGWRGLJHEIQE****\\",\\n \\"Resource\\": \\"sgm/A.e.EOGTOEGYOOI****/pano_texture/multi/0/%s.jpg\\",\\n \\"VirtualId\\": \\"93132801658010****\\",\\n \\"VirtualName\\": \\"卧室\\",\\n \\"MainImage\\": true,\\n \\"SubSceneId\\": \\"a7RqCd3kLMgglmn****\\",\\n \\"CurRoomPicList\\": [\\n \\"1****\\"\\n ],\\n \\"Neighbours\\": [\\n \\"1****\\"\\n ],\\n \\"Position\\": {\\n \\"Viewpoint\\": [\\n 0\\n ],\\n \\"Spot\\": [\\n 0\\n ],\\n \\"Rotation\\": [\\n 0\\n ]\\n }\\n }\\n ],\\n \\"ModelPath\\": \\"https://www.example.com/sgm/A.e.EOGTOE****/A.e.EOGTOE****.sgm\\",\\n \\"TextureModelPath\\": \\"https://www.example.com/sgm/A.e.EOGTOE****/model_texture/\\",\\n \\"TexturePanoPath\\": \\"https://www.example.com/sgm/A.e.EOGTOE****/pano_texture/\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Id\\": \\"1****\\",\\n \\"Type\\": \\"IMAGE\\",\\n \\"Position\\": [\\n 1.0033\\n ],\\n \\"PositionPanoCube\\": [\\n 1.0033\\n ],\\n \\"Config\\": {\\n \\"Title\\": \\"标题\\",\\n \\"Content\\": \\"内容\\",\\n \\"BackgroundColor\\": \\"#00000\\",\\n \\"PanoId\\": \\"1****\\",\\n \\"Video\\": \\"http://www.example.com/****.mp4\\",\\n \\"Link\\": \\"http://www.example.com/***\\",\\n \\"SceneId\\": 0,\\n \\"Position\\": [\\n 0\\n ],\\n \\"PositionPanoCube\\": [\\n 0\\n ],\\n \\"Images\\": [\\n \\"http://www.example.com/****.jpg\\"\\n ],\\n \\"ButtonConfig\\": {\\n \\"Type\\": \\"CLICK_CHECK\\",\\n \\"CustomText\\": \\"点击查看\\"\\n },\\n \\"FormSelectImgType\\": \\"default\\",\\n \\"IsTagVisibleBy3d\\": true,\\n \\"FormJumpType\\": true,\\n \\"FormImgSize\\": [\\n 0\\n ],\\n \\"RelatedPanoIds\\": [\\n \\"1****\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76FF387\\n false\\n xxxxx\\n \\n \\n \\n 1****\\n location_93132801658010****\\n 1****\\n 1****\\n false\\n sIPGWRGLJHEIQE****\\n sgm/A.e.EOGTOEGYOOI****/pano_texture/multi/0/%s.jpg\\n 93132801658010****\\n 卧室\\n false\\n a7RqCd3kLMgglmn****\\n 1****\\n 1****\\n \\n \\n \\n https://www.example.com/sgm/A.e.EOGTOE****/A.e.EOGTOE****.sgm\\n https://www.example.com/sgm/A.e.EOGTOE****/model_texture/\\n https://www.example.com/sgm/A.e.EOGTOE****/pano_texture/\\n \\n \\n 1****\\n IMAGE\\n 1.0033\\n 1.0033\\n \\n 标题\\n 内容\\n #00000\\n 1****\\n \\n http://www.example.com/***\\n http://www.example.com/****.jpg\\n \\n CLICK_CHECK\\n 点击查看\\n \\n default\\n false\\n false\\n 1****\\n \\n \\n \\n","errorExample":""}]',
'title' => '场景预览数据',
],
'CheckUserProperty' => [
'summary' => '检查用户是否具有指定业务属性。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => [
'title' => '用户uid',
'description' => '用户uid',
'type' => 'string',
'required' => true,
'example' => '2345****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb1309366493',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Match' => [
'title' => '用户属性是否匹配',
'description' => '指定UID是否具有阿里拍卖业务属性标记',
'type' => 'boolean',
'example' => 'true',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"344794c32937474a9c59eb1309366493\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Match\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 344794c32937474a9c59eb1309366493\\n 200\\n true\\n success\\n true\\n","errorExample":""}]',
'title' => '检查用户业务属性',
],
'GetScenePreviewResource' => [
'summary' => '用于模型类场景的预览。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PreviewToken',
'in' => 'query',
'schema' => [
'title' => '预览token',
'description' => '预览token',
'type' => 'string',
'required' => true,
'example' => '2deb941b3e1****',
],
],
[
'name' => 'Draft',
'in' => 'query',
'schema' => [
'title' => '是否草稿预览',
'description' => 'true/false,是否草稿预览,默认:false,用于热点添加后的预览',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'Id of the request',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76*****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '0:成功,其他:失败',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true/false',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'title' => '模型数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Version' => [
'title' => '版本',
'description' => '引擎版本',
'type' => 'string',
'example' => '1.0',
],
'Name' => [
'title' => '模型名称',
'description' => '场景名称',
'type' => 'string',
'example' => '场景-Example',
],
'ResourceDirectory' => [
'title' => '资源路径',
'description' => '模型资源',
'type' => 'object',
'properties' => [
'RootPath' => [
'title' => '模型路径',
'description' => '模型所在路径',
'type' => 'string',
'example' => 'A.e.YKPYuuYuituy****',
],
'OrthomapConfig' => [
'title' => '小地图数据文件路径',
'description' => '小地图配置文件',
'type' => 'string',
'example' => 'orthomap/orthomap.json',
],
'ModelConfig' => [
'title' => '模型配置路径',
'description' => '模型配置文件',
'type' => 'string',
'example' => 'config.json',
],
'HotspotTagConfig' => [
'title' => '热点文件路径',
'description' => '热点文件路径',
'type' => 'string',
'example' => 'hotspotTag.json',
],
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76*****\\",\\n \\"Code\\": 0,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Version\\": \\"1.0\\",\\n \\"Name\\": \\"场景-Example\\",\\n \\"ResourceDirectory\\": {\\n \\"RootPath\\": \\"A.e.YKPYuuYuituy****\\",\\n \\"OrthomapConfig\\": \\"orthomap/orthomap.json\\",\\n \\"ModelConfig\\": \\"config.json\\",\\n \\"HotspotTagConfig\\": \\"hotspotTag.json\\"\\n }\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76*****\\n false\\n xxxxx\\n \\n 1.0\\n 场景-Example\\n \\n A.e.YKPYuuYuituy****\\n orthomap/orthomap.json\\n config.json\\n hotspotTag.json\\n \\n \\n","errorExample":""}]',
'title' => '场景预览数据',
],
'GetPackSceneTaskStatus' => [
'summary' => '获取场景数据打包状态。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'required' => true,
'example' => 'hjsyuyiuwe7wehg****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '操作类型:download(下载),sync(同步)',
'description' => '操作类型:download(下载),sync(同步)',
'type' => 'string',
'required' => true,
'example' => 'download',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B****',
],
'Code' => [
'title' => '返回码',
'description' => '200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '任务状态',
'description' => '状态:处理中 : processing 失败 :failed 完成 :succeed',
'type' => 'string',
'example' => 'succeed',
],
'Progress' => [
'title' => '任务进度',
'description' => '进度百分比',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Status\\": \\"succeed\\",\\n \\"Progress\\": 100\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B****\\n 200\\n true\\n xxxxx\\n \\n succeed\\n \\n \\n","errorExample":""}]',
'title' => '获取场景数据打包状态',
],
'GetScenePackUrl' => [
'summary' => '用于调用PackScene接口后,获取数据包地址,以便于下载。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'L2omaCMmQZZkEg4p****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76****',
],
'Code' => [
'title' => '返回码',
'description' => '200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Url' => [
'title' => '打包文件地址',
'description' => '打包文件地址',
'type' => 'string',
'example' => 'www.example.com/preview/24714a7****/****.zip',
],
'Expire' => [
'title' => '失效日期',
'description' => '失效日期',
'type' => 'string',
'example' => '2022-05-17 11:00:17',
],
'Valid' => [
'title' => '是否有效',
'description' => '是否有效',
'type' => 'boolean',
'example' => 'true',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Url\\": \\"www.example.com/preview/24714a7****/****.zip\\",\\n \\"Expire\\": \\"2022-05-17 11:00:17\\",\\n \\"Valid\\": true\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76****\\n 200\\n true\\n xxxxx\\n \\n www.example.com/preview/24714a7****/****.zip\\n 2022-05-17 11:00:17\\n true\\n \\n","errorExample":""}]',
'title' => '获取场景打包文件地址',
],
'PackScene' => [
'summary' => '打包场景数据,入参type为download可下载到本地,入参type为sync可可同步到自己的阿里云oss(前提是自己已开通)。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'L2omaCMmQZZkEg4p****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '操作类型:download(下载),sync(同步)',
'description' => '操作类型:download(下载),sync(同步)',
'type' => 'string',
'required' => true,
'example' => 'download',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76****',
],
'Code' => [
'title' => '返回码',
'description' => '200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => 'hjsyuyiuwe7wehg****',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"hjsyuyiuwe7wehg****\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76****\\n 200\\n true\\n xxxxx\\n \\n hjsyuyiuwe7wehg****\\n \\n","errorExample":""}]',
'title' => '场景数据打包',
],
'GetCopySceneTaskStatus' => [
'summary' => '查询复制场景任务状态。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'required' => true,
'example' => 'yuywey****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码,200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '任务状态',
'description' => '状态:处理中 : processing 失败 :failed 完成 :succeed',
'type' => 'string',
'example' => 'succeed',
],
'Progress' => [
'title' => '任务进度',
'description' => '进度百分比',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Status\\": \\"succeed\\",\\n \\"Progress\\": 100\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4****\\n 200\\n true\\n xxxxx\\n \\n succeed\\n \\n \\n","errorExample":""}]',
'title' => '查询复制场景任务状态',
],
'UpdateSubSceneSeq' => [
'summary' => '此接口用于预览页面中子场景的顺序。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '子场景ID',
'description' => '子场景ID',
'type' => 'string',
'required' => true,
'example' => 'sgyuyewyew****',
],
],
[
'name' => 'SortSubSceneIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '用于排序的子场景ID数组',
'type' => 'array',
'items' => [
'description' => '子场景ID',
'type' => 'string',
'required' => false,
'example' => 'hjsiiqw****',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => '344794c32937474a9c59eb13093****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"344794c32937474a9c59eb13093****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 344794c32937474a9c59eb13093****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '更新子场景顺序',
],
'CopyScene' => [
'summary' => '可以把原来的场景复制一份。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'description' => '场景Id',
'type' => 'string',
'required' => true,
'example' => 'sgyuyewyew****',
],
],
[
'name' => 'SceneName',
'in' => 'query',
'schema' => [
'title' => '新场景名称',
'description' => '新场景名称',
'type' => 'string',
'required' => true,
'example' => '场景A',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'title' => '复制到的项目Id,默认为空,复制到当前场景所在的项目',
'description' => '复制到的项目Id,默认为空,复制到当前场景所在的项目',
'type' => 'string',
'required' => false,
'example' => 'opwuoieywtyqw****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID',
'type' => 'string',
'example' => '4F882EA7-3A1D-0113-94E4-70162C4B***',
],
'Code' => [
'title' => '返回码',
'description' => '返回码,200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => 'yuywey****',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F882EA7-3A1D-0113-94E4-70162C4B***\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"yuywey****\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4F882EA7-3A1D-0113-94E4-70162C4B***\\n 200\\n true\\n success\\n \\n yuywey****\\n \\n","errorExample":""}]',
'title' => '复制场景',
],
'GetSourcePackStatus' => [
'summary' => '获取全景图文件打包状态。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'required' => true,
'example' => 'hjsyuyiuwe7wehg****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76****',
],
'Code' => [
'title' => '返回码',
'description' => '200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Status' => [
'title' => '任务状态',
'description' => '状态:处理中 : processing 失败 :failed 完成 :succeed',
'type' => 'string',
'example' => 'succeed',
],
'Progress' => [
'title' => '任务进度',
'description' => '进度百分比',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
'Url' => [
'title' => '压缩包的地址',
'description' => '压缩包的地址',
'type' => 'string',
'example' => 'www.example.com/preview/24714a7****/****.zip',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"Status\\": \\"succeed\\",\\n \\"Progress\\": 100\\n },\\n \\"Url\\": \\"www.example.com/preview/24714a7****/****.zip\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76FF387\\n 200\\n true\\n xxxxx\\n \\n succeed\\n \\n \\n www.example.com/preview/24714a7****/****.zip\\n","errorExample":""}]',
'title' => '获取全景图文件打包状态',
],
'PackSource' => [
'summary' => '获取3D模型类型下所有全景图片。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'L2omaCMmQZZkEg4p****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '响应',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID',
'type' => 'string',
'example' => 'A8CD0AD9-8A92-455A-A984-A7E4B76F****',
],
'Code' => [
'title' => '返回码',
'description' => '200:成功,其他:失败',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'xxxxx',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'TaskId' => [
'title' => '任务ID',
'description' => '任务ID',
'type' => 'string',
'example' => 'hjsyuyiuwe7wehg****',
],
],
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A8CD0AD9-8A92-455A-A984-A7E4B76F****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"hjsyuyiuwe7wehg****\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A8CD0AD9-8A92-455A-A984-A7E4B76F****\\n 200\\n true\\n xxxxx\\n \\n hjsyuyiuwe7wehg****\\n \\n","errorExample":""}]',
'title' => '获取全景图文件',
],
'SaveHotspotTagList' => [
'summary' => '保存热点数据。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'description' => '场景Id',
'type' => 'string',
'required' => true,
'example' => 'tqwiuwetwet****',
],
],
[
'name' => 'HotspotListJson',
'in' => 'query',
'schema' => [
'title' => '热点数据,json字符串数组',
'description' => '热点数据,json字符串数组',
'type' => 'string',
'required' => true,
'example' => '[{}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => 'B28A2ECB-AB29-1E01****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B28A2ECB-AB29-1E01****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B28A2ECB-AB29-1E01****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '保存热点数据',
'requestParamsDescription' => 'HotspotListJson字段为json字符串数组,具体格式参照前端引擎。',
],
'SaveModelConfig' => [
'summary' => '保存模型配置。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Data',
'in' => 'query',
'schema' => [
'title' => '模型配置,json字符串',
'description' => '模型配置,json字符串',
'type' => 'string',
'required' => true,
'example' => '{}',
],
],
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'iyweyteyue****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => 'B28A2ECB-AB29-1E01****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B28A2ECB-AB29-1E01****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B28A2ECB-AB29-1E01****\\n 200\\n true\\n SUCCESS\\n","errorExample":""}]',
'title' => '保存模型配置',
],
'CreateUploadPolicy' => [
'summary' => '获取上传凭据。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '上传类型,值为:scene(场景)、subScene(子场景)、rooms(rooms文件)、hotspot(后处理相关)',
'description' => '上传类型,值为:scene(场景)、subScene(子场景)、hotspot(后处理相关)',
'type' => 'string',
'required' => true,
'example' => 'scene',
],
],
[
'name' => 'Option',
'in' => 'query',
'schema' => [
'title' => '不同类型对应的参数',
'description' => '不同类型对应的参数',
'type' => 'string',
'required' => true,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => 'B28A2ECB-AB29-1E01****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'SUCCESS',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'AccessId' => [
'title' => 'accessId',
'description' => 'accessId',
'type' => 'string',
'example' => 'LTAI****************',
],
'Policy' => [
'title' => '授权',
'description' => '授权',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMj****',
],
'Signature' => [
'title' => '签名',
'description' => '签名',
'type' => 'string',
'example' => 'KdnPJFIG25SM****',
],
'Dir' => [
'title' => '授权路径',
'description' => '授权路径',
'type' => 'string',
'example' => 'dir/',
],
'Host' => [
'title' => '上传地址',
'description' => '上传地址',
'type' => 'string',
'example' => 'oss.aliyun.com',
],
'Expire' => [
'title' => '授权失效时间(s)',
'description' => '授权失效时间(s)',
'type' => 'string',
'example' => '1658812297',
],
'Callback' => [
'title' => '上传回调',
'description' => '上传回调',
'type' => 'string',
'example' => '""',
],
],
],
'AccessDeniedDetail' => [
'description' => '无权限错误详情',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '请求中用于鉴权的操作信息',
'type' => 'string',
'example' => 'tdsr:CreateUploadPolicy',
],
'AuthPrincipalDisplayName' => [
'description' => '请求中用于鉴权的身份标识。具体取值为:'."\n"
.'- RAM 用户:RAM 用户 UID'."\n"
.'- RAM 角色:RoleName:RoleSessionName'."\n"
.'- Federated:ProviderType/ProviderName',
'type' => 'string',
'example' => '2xxxxxxxxxxxxx',
],
'AuthPrincipalOwnerId' => [
'description' => '请求中用于鉴权的身份所属的阿里云账号UID信息',
'type' => 'string',
'example' => '1xxxxx',
],
'AuthPrincipalType' => [
'description' => 'AuthPrincipalType 请求中用于鉴权的身份类型。具体取值为:'."\n"
.'- RAM 用户:SubUser'."\n"
.'- RAM 角色:AssumedRoleUser'."\n"
.'- SSO 联合身份:Federated',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '编码后的用于权限诊断的信息',
'type' => 'string',
'example' => 'AABBCCxxxxxxxx',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => 'PolicyType 导致鉴权失败的策略类型。具体取值为:'."\n"
.'- 管控策略:ControlPolicy'."\n"
.'- 会话策略:SessionPolicy'."\n"
.'- 角色信任策略:AssumeRolePolicy'."\n"
.'- 基于身份策略(账号级):AccountLevelIdentityBasedPolicy'."\n"
.'- 基于身份策略(资源组级): ResourceGroupLevelIdentityBasedPolicy'."\n"
.'- OSS Bucket Policy:BucketPolicy'."\n"
.'- SLS Project Policy:ProjectPolicy',
'type' => 'string',
'example' => 'ResourceGroupLevelIdentityBassdPolicy',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B28A2ECB-AB29-1E01****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"AccessId\\": \\"LTAI****************\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMj****\\",\\n \\"Signature\\": \\"KdnPJFIG25SM****\\",\\n \\"Dir\\": \\"dir/\\",\\n \\"Host\\": \\"oss.aliyun.com\\",\\n \\"Expire\\": \\"1658812297\\",\\n \\"Callback\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"tdsr:CreateUploadPolicy\\",\\n \\"AuthPrincipalDisplayName\\": \\"2xxxxxxxxxxxxx\\",\\n \\"AuthPrincipalOwnerId\\": \\"1xxxxx\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AABBCCxxxxxxxx\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"ResourceGroupLevelIdentityBassdPolicy\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B28A2ECB-AB29-1E01****\\n 200\\n true\\n SUCCESS\\n \\n LTAI****************\\n eyJleHBpcmF0aW9uIjoiMj****\\n KdnPJFIG25SM****\\n dir/\\n oss.aliyun.com\\n 1658812297\\n \\"\\"\\n \\n \\n","errorExample":""}]',
'title' => '获取上传凭据',
'requestParamsDescription' => '- 上传场景数据包 '."\n"
.' ```type: "scene", option: { "sceneld": "Td6HbmTJ****", "modelStyle":"PATCH" } ``` '."\n"
.'说明:modelStyle取 PATCH(2.5D模型)DEPTH(深度模型)'."\n"
.'- 上传子场景 '."\n"
.'``` type: "subScene", option: { "subSceneld": "AZK5wcg****" }```'."\n"
.'- 上传热点资源 '."\n"
.' ```type: "hotspot", option: { "sceneld": "Td6HbmTJ****" "type": "IMAGE" } ``` '."\n"
.'说明:option中的type可以取IMAGE、 VIDEO、AUDIO、ICON ',
],
'PublishHotspotConfig' => [
'summary' => '发布热点配置。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'description' => '场景Id',
'type' => 'string',
'required' => true,
'example' => 'rteyauiiuw****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'description' => '请求ID,与入参requestId对应',
'type' => 'string',
'example' => 'B28A2ECB-AB29-1E01****',
],
'Code' => [
'title' => '返回码',
'description' => '返回码',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'Success' => [
'title' => '是否请求成功',
'description' => '是否请求成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误消息',
'description' => '错误消息',
'type' => 'string',
'example' => 'success',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B28A2ECB-AB29-1E01****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"\\",\\n \\"AuthPrincipalDisplayName\\": \\"\\",\\n \\"AuthPrincipalOwnerId\\": \\"\\",\\n \\"AuthPrincipalType\\": \\"\\",\\n \\"EncodedDiagnosticMessage\\": \\"\\",\\n \\"NoPermissionType\\": \\"\\",\\n \\"PolicyType\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B28A2ECB-AB29-1E01****\\n 200\\n true\\n success\\n","errorExample":""}]',
'title' => '发布热点配置',
],
'AddHotspotFile' => [
'summary' => '保存模型文件',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景Id',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'title' => '文件名',
'type' => 'string',
'required' => true,
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '文件类型',
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'type' => 'string',
],
'Code' => [
'title' => '返回码',
'type' => 'integer',
'format' => 'int64',
],
'Success' => [
'title' => '是否请求成功',
'type' => 'boolean',
],
'Message' => [
'title' => '错误消息',
'type' => 'string',
],
'Data' => [
'type' => 'object',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '',
],
'SaveMinimap' => [
'summary' => '保存小地图数据',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SceneId',
'in' => 'query',
'schema' => [
'title' => '场景ID',
'type' => 'string',
'required' => true,
],
],
[
'name' => 'Data',
'in' => 'query',
'schema' => [
'title' => '小地图数据,json字符串',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,与入参requestId对应',
'type' => 'string',
],
'Code' => [
'title' => '返回码',
'type' => 'integer',
'format' => 'int64',
],
'Success' => [
'title' => '是否请求成功',
'type' => 'boolean',
],
'Message' => [
'title' => '错误消息',
'type' => 'string',
],
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
'AuthAction' => [
'type' => 'string',
],
'AuthPrincipalDisplayName' => [
'type' => 'string',
],
'AuthPrincipalOwnerId' => [
'type' => 'string',
],
'AuthPrincipalType' => [
'type' => 'string',
],
'EncodedDiagnosticMessage' => [
'type' => 'string',
],
'NoPermissionType' => [
'type' => 'string',
],
'PolicyType' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'lyj.cn-hangzhou.aliyuncs.com',
],
],
];