'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Workorder',
'version' => '2021-06-10',
],
'directories' => [
'GetTicket',
'CreateTicket',
'ReplyTicket',
'CloseTicket',
'EvaluateTicket',
'ListTickets',
'ListTicketNotes',
'ListProducts',
'ListCategories',
'GetMqConsumerTag',
'ReopenTicket',
'GetAttachmentUploadUrl',
],
'components' => [
'schemas' => [],
],
'apis' => [
'GetTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单编号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '001571BTXC',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => 'UID',
'type' => 'string',
'required' => false,
'example' => '1604499804113750',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:GetTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => 'C499BB0F-630D-5BE6-B3EA-5FCD95B85503',
],
'Success' => [
'description' => '调用接口返回是否成功,true代表调用正常',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '接口请求结果返回码',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'success',
],
'PageNumber' => [
'description' => '分页查询参数的页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询参数的每页条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '查询结果总数, 即我的工单记录总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '108',
],
'Data' => [
'description' => '接口调用成功后，返回的业务数据',
'type' => 'object',
'properties' => [
'TicketId' => [
'description' => '工单编号',
'type' => 'string',
'example' => '0005PYGCW',
],
'Title' => [
'description' => '工单标题',
'type' => 'string',
'example' => 'ecs续费失败啥原因',
],
'Description' => [
'description' => '工单问题描述, 目前只支持纯文本格式',
'type' => 'string',
'example' => 'ecs无法启动',
],
'CreateTime' => [
'description' => '工单创建时间的时间戳',
'type' => 'integer',
'format' => 'int64',
'example' => '1623396736000',
],
'CreatorId' => [
'description' => '工单创建人uid',
'type' => 'string',
'example' => '1168025',
],
'CategoryId' => [
'description' => '工单问题分类ID',
'type' => 'string',
'example' => '7161',
],
'Status' => [
'description' => '工单状态, 参考值如下'."\n"
.'1, "assigned", "待响应", '."\n"
.'2, "dealing", "处理中",'."\n"
.'3, "wait_feedback", "待反馈",'."\n"
.'4, "feedback", "已反馈",'."\n"
.'5, "wait_confirm", "待确认",'."\n"
.'6, "confirmed", "已完成"',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '状态枚举文本',
'type' => 'string',
'example' => '已完成',
],
'Value' => [
'description' => '状态枚举值',
'type' => 'string',
'example' => '6',
],
],
],
'Severity' => [
'description' => '紧急度枚举值, 1 代表一般问题, 2 代表紧急问题',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '枚举文本',
'type' => 'string',
'example' => '一般问题',
],
'Value' => [
'description' => '枚举值',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'illegal.param',
'errorMessage' => 'Illegal param.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:GetTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"C499BB0F-630D-5BE6-B3EA-5FCD95B85503\\",\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 108,\\n \\"Data\\": {\\n \\"TicketId\\": \\"0005PYGCW\\",\\n \\"Title\\": \\"ecs续费失败啥原因\\",\\n \\"Description\\": \\"ecs无法启动\\",\\n \\"CreateTime\\": 1623396736000,\\n \\"CreatorId\\": \\"1168025\\",\\n \\"CategoryId\\": \\"7161\\",\\n \\"Status\\": {\\n \\"Label\\": \\"已完成\\",\\n \\"Value\\": \\"6\\"\\n },\\n \\"Severity\\": {\\n \\"Label\\": \\"一般问题\\",\\n \\"Value\\": \\"1\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '查询工单',
'summary' => '查询工单。',
],
'CreateTicket' => [
'summary' => '创建工单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Description',
'in' => 'formData',
'schema' => [
'description' => '工单问题描述, 目前只支持纯文本格式',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecs备份失败',
],
],
[
'name' => 'Severity',
'in' => 'formData',
'schema' => [
'description' => '枚举值, 1 代表一般问题, 2 代表紧急问题',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '1000',
'minimum' => '0',
'enumValueTitles' => [
1 => '普通',
'紧急',
],
'example' => '1',
],
],
[
'name' => 'CategoryId',
'in' => 'formData',
'schema' => [
'description' => '问题分类ID, 从ListCategories接口中获取返回值CategoryId',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '53812',
],
],
[
'name' => 'Title',
'in' => 'formData',
'schema' => [
'description' => '工单标题',
'type' => 'string',
'required' => false,
'example' => 'ecs备份失败',
],
],
[
'name' => 'CreatorId',
'in' => 'formData',
'schema' => [
'description' => '提交账号的阿里云uid，MPK虚商场景需要',
'type' => 'string',
'required' => false,
'example' => '1289427240739141',
],
],
[
'name' => 'Email',
'in' => 'formData',
'schema' => [
'description' => '用户提交工单的联系邮箱地址。',
'type' => 'string',
'required' => false,
'example' => 'sdahkjdshga@qq.com',
],
],
[
'name' => 'FileNameList',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => '附件名称列表，GetAttachmentUploadUrl接口返回的ObjectKey字段',
'type' => 'array',
'items' => [
'description' => 'GetAttachmentUploadUrl接口返回的ObjectKey字段',
'type' => 'string',
'required' => false,
'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png',
],
'required' => false,
],
],
[
'name' => 'SecretInfo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '敏感信息',
'type' => 'object',
'properties' => [
'Content' => [
'description' => '敏感信息—文本内容',
'type' => 'string',
'required' => false,
'example' => '身份证：3310xxxx',
],
'FileNameList' => [
'description' => '敏感信息—附件名称列表',
'type' => 'array',
'items' => [
'description' => 'GetAttachmentUploadUrl接口返回的ObjectKey字段',
'type' => 'string',
'required' => false,
'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png',
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:CreateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '接口请求结果返回码',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '返回值, 即工单号',
'type' => 'string',
'example' => '0005PYGCW',
],
'RequestId' => [
'description' => '接口请求的唯一ID, 每次调用requestID唯一',
'type' => 'string',
'example' => '0254B7DE-7365-57B4-8E38-14FE927E3FEB',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常',
'type' => 'boolean',
'example' => 'True',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:CreateTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"0005PYGCW\\",\\n \\"RequestId\\": \\"0254B7DE-7365-57B4-8E38-14FE927E3FEB\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '新建工单',
],
'ReplyTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0005PYGCW',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => '工单回复的内容',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '好的, 我这边已经续费成功',
],
],
[
'name' => 'FileNameList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '附件名称列表，GetAttachmentUploadUrl接口返回的ObjectKey字段',
'type' => 'array',
'items' => [
'description' => 'GetAttachmentUploadUrl接口返回的ObjectKey字段',
'type' => 'string',
'required' => false,
'example' => '6bc06f96-f8c1-4c00-9e30-368444fbd025.jpg,',
],
'required' => false,
],
],
[
'name' => 'Encrypt',
'in' => 'formData',
'schema' => [
'description' => '是否加密',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => '阿里云UID',
'type' => 'string',
'required' => false,
'example' => '1289427240739141',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => '非法的入参',
],
'Data' => [
'description' => '返回值, 即工单回复内容的dialogID'."\n",
'type' => 'string',
'example' => '46434030',
],
'RequestId' => [
'description' => '接口请求的唯一id,每次调用requestid唯一',
'type' => 'string',
'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD',
],
'Success' => [
'description' => '调用接口返回是否成功,true代表调用正常',
'type' => 'boolean',
'example' => 'true',
],
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:ReplyTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"非法的入参\\",\\n \\"Data\\": \\"46434030\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ReplyTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\"\\n}","type":"json"}]',
'title' => '回复工单',
'summary' => '工单回复, 回复的内容可以通过ListTicketNotes接口获取。',
],
'CloseTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单编号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'G2BKRWG',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => '用户UID。您可以通过DMS控制台右上角头像处查看您的UID。',
'type' => 'string',
'required' => false,
'example' => '1139477549527134',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:CloseTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '接口请求结果返回码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码。',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用接口返回是否成功,true代表调用正常',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:CloseTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '关闭工单',
'summary' => '关闭工单。',
],
'EvaluateTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '001ET1BU1P',
],
],
[
'name' => 'Solved',
'in' => 'formData',
'schema' => [
'description' => '是否解决',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'Score',
'in' => 'formData',
'schema' => [
'description' => '评价星级1-5星',
'type' => 'string',
'required' => true,
'example' => '1',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => '评价内容',
'type' => 'string',
'required' => false,
'example' => '很满意的一次工单服务',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => 'UID',
'type' => 'string',
'required' => false,
'example' => '1902070573958003',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:EvaluateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'successful',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:EvaluateTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n successful\\n C1DA4C6F-963E-5741-AB57-67A554D102FD\\n true\\n","errorExample":""}]',
'title' => '评价工单',
'summary' => '评价工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTickets' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'StartDate',
'in' => 'formData',
'schema' => [
'description' => '工单创建时间, 配合EndDate使用, 用于查询在指定的开始和结束时间范围内创建的工单',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '1623396736000',
],
],
[
'name' => 'EndDate',
'in' => 'formData',
'schema' => [
'description' => '工单创建截止时间, 配合StartDate使用, 用于查询在指定的开始和结束时间范围内提交的工单',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '1623396736000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页查询页码参数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '9999999',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询条数参数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '10',
'example' => '10',
],
],
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单编号',
'type' => 'string',
'required' => false,
'example' => '0005PYGCW',
],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => [
'description' => '工单关键词, 用于模糊搜索匹配工单创建时的Description字段的内容',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'StatusList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '多个工单状态',
'type' => 'array',
'items' => [
'description' => '工单状态,参考值如下1,"assigned","待响应",2,"dealing","处理中",3,"wait-feedback","待反馈",4,"feedback","已反馈",5,"wait_confirm","待确认",6,"confirmed","已完成"',
'type' => 'string',
'required' => false,
'example' => 'confirmed',
],
'required' => false,
'example' => '6',
'maxItems' => 11,
],
],
[
'name' => 'TicketIdList',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'description' => '多个工单编号',
'type' => 'array',
'items' => [
'description' => '工单号',
'type' => 'string',
'required' => false,
'example' => '0006S6ZL6E',
],
'required' => false,
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => 'UID',
'type' => 'string',
'required' => false,
'example' => '1902070573958003',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:ListTickets\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'RequestId' => [
'description' => '接口请求的唯一ID, 每次调用requestID唯一'."\n",
'type' => 'string',
'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口请求结果返回码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => '入参解析失败',
],
'PageNumber' => [
'description' => '分页查询参数的页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询参数的每页条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '查询结果总数, 即我的工单记录总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '99',
],
'Data' => [
'description' => '返回值为我的工单列表数据'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TicketId' => [
'description' => '工单编号',
'type' => 'string',
'example' => '0005PYGCW',
],
'Title' => [
'description' => '工单标题',
'type' => 'string',
'example' => 'ecs续费失败啥原因',
],
'Status' => [
'description' => '工单状态, 参考值如下'."\n"
.'1, "assigned", "待响应", '."\n"
.'2, "dealing", "处理中",'."\n"
.'3, "wait_feedback", "待反馈",'."\n"
.'4, "feedback", "已反馈",'."\n"
.'5, "wait_confirm", "待确认",'."\n"
.'6, "confirmed", "已完成"',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '状态描述, 如已完成',
'type' => 'string',
'example' => '已完成',
],
'Value' => [
'description' => '状态值, 如6, 代表已完成',
'type' => 'string',
'example' => '6',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'illegal.param',
'errorMessage' => 'Params illegal',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ListTickets\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Code\\": 0,\\n \\"Message\\": \\"入参解析失败\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 99,\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"0005PYGCW\\",\\n \\"Title\\": \\"ecs续费失败啥原因\\",\\n \\"Status\\": {\\n \\"Label\\": \\"已完成\\",\\n \\"Value\\": \\"6\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"99\\n10\\n入参解析失败\\nAC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\n1\\n\\n 0005PYGCW\\n ecs续费失败啥原因\\n \\n 6\\n \\n \\n\\n0\\ntrue","errorExample":""}]',
'title' => '获取我的工单列表',
'summary' => '获取我的工单列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTicketNotes' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'query',
'schema' => [
'description' => '工单编号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0005PYGCW',
],
],
[
'name' => 'Uid',
'in' => 'query',
'schema' => [
'description' => 'UID',
'type' => 'string',
'required' => false,
'example' => '1936753548534516',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:ListTicketNotes\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '接口请求结果返回码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => '入参非法',
],
'RequestId' => [
'description' => '接口请求的唯一ID, 每次调用requestID唯一'."\n",
'type' => 'string',
'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回值, 即指定工单的对话记录列表数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '对话类型'."\n"
.'1 卡片, 即schema'."\n"
.'2 文本, 即content',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Status' => [
'description' => '沟通消息状态字段, 参考值'."\n"
.'未读=1、已读=2',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'Tip' => [
'description' => '暂不使用的字段',
'type' => 'string',
'example' => 'null',
],
'DialogId' => [
'description' => '对话记录唯一ID标识',
'type' => 'integer',
'format' => 'int64',
'example' => '9999',
],
'CreateTime' => [
'description' => '沟通消息创建时间的时间戳',
'type' => 'integer',
'format' => 'int64',
'example' => '1623396736000',
],
'Dialog' => [
'description' => '工单沟通记录对象',
'type' => 'object',
'properties' => [
'Schema' => [
'description' => '工单沟通记录系统卡片, 将来开放系统卡片对接能力时使用, 目前阶段用content取纯文本内容即可',
'type' => 'string',
'example' => 'null',
],
'Content' => [
'description' => '工单沟通内容',
'type' => 'string',
'example' => '你好, 我的ECS续费失败, 请问是什么原因',
],
],
],
'User' => [
'description' => '对话的用户',
'type' => 'object',
'properties' => [
'Role' => [
'description' => '对话用户角色, 区分小二和用户使用'."\n"
.'2, 客服'."\n"
.'3, 用户',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Name' => [
'description' => '对话用户名称',
'type' => 'string',
'example' => '工单小二',
],
],
],
'Attachments' => [
'description' => '附件列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '附件名称',
'type' => 'string',
'example' => '003.jpg',
],
'Url' => [
'description' => '临时可访问的附件地址',
'type' => 'string',
'example' => 'https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ListTicketNotes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"入参非法\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 6,\\n \\"Tip\\": \\"null\\",\\n \\"DialogId\\": 9999,\\n \\"CreateTime\\": 1623396736000,\\n \\"Dialog\\": {\\n \\"Schema\\": \\"null\\",\\n \\"Content\\": \\"你好, 我的ECS续费失败, 请问是什么原因\\"\\n },\\n \\"User\\": {\\n \\"Role\\": 3,\\n \\"Name\\": \\"工单小二\\"\\n },\\n \\"Attachments\\": [\\n {\\n \\"Name\\": \\"003.jpg\\",\\n \\"Url\\": \\"https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"入参非法\\nAC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\n\\n 6\\n 1\\n 1623396736000\\n 9999\\n null\\n \\n \\n 3\\n 工单小二\\n \\n\\n0\\ntrue","errorExample":""}]',
'title' => '获取工单沟通记录',
'summary' => '获取工单沟通记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListProducts' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '产品名称, 支持模糊搜索, 非必填。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ecs',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言。取值：'."\n"
."\n"
.'- 中文：zh。'."\n"
.'- 英文：en。'."\n"
.'- 日文：jp。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '接口请求结果返回码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => '入参非法',
],
'RequestId' => [
'description' => '接口请求的唯一ID, 每次调用requestID唯一'."\n",
'type' => 'string',
'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回值, 即产品列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DirectoryId' => [
'description' => '产品目录ID, 代表产品大类, 如弹性计算',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'DirectoryName' => [
'description' => '产品目录名称, 代表产品大类, 如弹性计算',
'type' => 'string',
'example' => '云服务器',
],
'ProductList' => [
'description' => '阿里云产品列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductId' => [
'description' => '阿里云产品ID',
'type' => 'integer',
'format' => 'int64',
'example' => '7160',
],
'ProductName' => [
'description' => '阿里云产品名称',
'type' => 'string',
'example' => 'ECS',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"入参非法\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DirectoryId\\": 1,\\n \\"DirectoryName\\": \\"云服务器\\",\\n \\"ProductList\\": [\\n {\\n \\"ProductId\\": 7160,\\n \\"ProductName\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"入参非法\\nAC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\n\\n 1\\n 云服务器\\n \\n ECS\\n 7160\\n \\n\\n0\\ntrue","errorExample":""}]',
'title' => '获取阿里云产品列表数据',
'summary' => '获取阿里云产品列表数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCategories' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ProductId',
'in' => 'formData',
'schema' => [
'description' => '产品ID, 通过ListProducts接口获取. ProductId为阿里云产品ID, 一个产品下会挂多个Category(工单问题分类)',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '99999999999',
'minimum' => '0',
'example' => '18550',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => [
'description' => '分类问题名称, 支持模糊搜索',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言。取值：'."\n"
."\n"
.'- 中文：zh。'."\n"
.'- 英文：en。'."\n"
.'- 日文：jp。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回值,即问题分类列表',
'type' => 'array',
'items' => [
'description' => '返回值,即问题分类列表',
'type' => 'object',
'properties' => [
'CategoryName' => [
'description' => '工单问题分类名称',
'type' => 'string',
'example' => 'ECS',
],
'CategoryId' => [
'description' => '工单问题分类ID',
'type' => 'integer',
'format' => 'int64',
'example' => '7161',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"CategoryName\\": \\"ECS\\",\\n \\"CategoryId\\": 7161\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取指定产品下的类别',
'summary' => '获取工单问题分类列表数据。',
],
'GetMqConsumerTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:GetMqConsumerTag\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '接口请求结果返回码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '返回值,即你的唯一的mq消费的tag',
'type' => 'string',
'example' => '46434030',
],
'RequestId' => [
'description' => '请求唯一识别码',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:GetMqConsumerTag\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"46434030\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取工单RocketMQ消息监听的TAG',
'summary' => '获取工单RocketMQ消息监听的TAG。',
],
'ReopenTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TicketId',
'in' => 'formData',
'schema' => [
'description' => '工单编号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0005PYGCW',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => '重开工单回复内容',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '还没有解决问题',
],
],
[
'name' => 'Uid',
'in' => 'formData',
'schema' => [
'description' => 'UID',
'type' => 'string',
'required' => false,
'example' => '1013872004421947',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '无权限错误详细信息。如果有权限，则返回空字符串。',
'type' => 'string',
'example' => '{\\"AuthAction\\":\\"ram:ReopenTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}',
],
'Code' => [
'description' => '接口请求结果返回码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '调用成功后返回的业务数据。',
'type' => 'string',
'example' => '0005PYGCW',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ReopenTicket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"0005PYGCW\\",\\n \\"RequestId\\": \\"C1DA4C6F-963E-5741-AB57-67A554D102FD\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '重开工单',
'summary' => '重开工单。',
],
'GetAttachmentUploadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'APP' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FileName',
'in' => 'formData',
'schema' => [
'description' => '上传文件的名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '81A0D93D-54D7-4529-ABFA-633ED63223BA.jpg',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Message' => [
'description' => '错误信息, 当success=false的时候, 可以取到message'."\n",
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '阿里云为该请求生成的唯一标识符。',
'type' => 'string',
'example' => 'ED195C2C-787F-511C-8204-714456781861',
],
'Success' => [
'description' => '调用接口返回是否成功, true代表调用正常'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '调用成功后返回的业务数据。',
'type' => 'object',
'properties' => [
'ObjectKey' => [
'description' => '已上传的文件标识符',
'type' => 'string',
'example' => 'cdb5d174-c282-4b2d-9048-e74ea2223127.jpg',
],
'PutSignedUrl' => [
'description' => '上传OSS文件的签名URL',
'type' => 'string',
'example' => 'https://workorder.oss-cn-beijing.aliyuncs.com'."\n"
.'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI***************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D',
],
'GetSignedUrl' => [
'description' => '查询OSS文件的签名URL',
'type' => 'string',
'example' => 'https://workorder.oss-cn-beijing.aliyuncs.com'."\n"
.'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI**************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'Params illegal.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'You are not authorized to perform the operation.',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"ED195C2C-787F-511C-8204-714456781861\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ObjectKey\\": \\"cdb5d174-c282-4b2d-9048-e74ea2223127.jpg\\",\\n \\"PutSignedUrl\\": \\"https://workorder.oss-cn-beijing.aliyuncs.com\\\\n/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI***************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D\\",\\n \\"GetSignedUrl\\": \\"https://workorder.oss-cn-beijing.aliyuncs.com\\\\n/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI**************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D\\"\\n }\\n}","type":"json"}]',
'title' => '获取临时附件上传OSS地址',
'summary' => '查询附件上传OSS地址。',
'description' => '> 附件上传'."\n"
.'> - 请参考OSS官方文档，使用预签名URL上传文件。'."\n"
."\n"
.'您可在拿到临时上传链接后通过如下方式上传：'."\n"
.''."\n"
.'示例'."\n"
.'
'."\n"
.'curl -X PUT -H "Content-Type:application/octet-stream" -H "x-oss-meta-author:aliy" -T /home/admin/file.png "https://xx.oss-cn-zhangjiakou.aliyuncs.com/xx/xx.png"'."\n"
.' ',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'workorder.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'workorder.ap-southeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'workorder.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'workorder.aliyuncs.com',
],
],
];