'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Workorder',
'version' => '2020-03-26',
],
'directories' => [
[
'id' => 69792,
'title' => '工单',
'type' => 'directory',
'children' => [
'CreateTicket',
'ListTicketNotes',
'ListTickets',
'CloseTicket',
],
],
[
'id' => 69798,
'title' => '类别',
'type' => 'directory',
'children' => [
'ListCategories',
'ListProducts',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言，支持，中文，英文，日文。值定义：zh：中文，en：英文，jp：日文。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '工单标题。',
'type' => 'string',
'required' => false,
'example' => 'ecs连不上了',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '问题描述。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '我的一台ecs连不上了，还请帮忙看看咋回事',
],
],
[
'name' => 'SecretContent',
'in' => 'query',
'schema' => [
'description' => '机密备注，您的ecs实例信息、个人相关的信息，请通过机密备注提交。机密备注有更高的数据安全等级。',
'type' => 'string',
'required' => false,
'example' => '实例id是XXXXXX',
],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => [
'description' => '产品code，枚举值定义如下：'."\n"
.'ecs：云服务器 ECS，finance：财务类，rds 云数据库 RDS，'."\n"
.'account：会员账号，'."\n"
.'oss：对象存储 OSS，'."\n"
.'sms：短信服务，'."\n"
.'host_xuni：虚拟主机，'."\n"
.'cas：SSL证书，'."\n"
.'cdn：CDN，'."\n"
.'slb：负载均衡，'."\n"
.'mail：企业邮箱，'."\n"
.'trademark：商标服务，'."\n"
.'swas：轻量应用服务器，'."\n"
.'domain：域名，'."\n"
.'cs：容器服务，'."\n"
.'presales：购买/续费咨询，'."\n"
.'vod：视频点播，'."\n"
.'beian：备案，'."\n"
.'live：视频直播，'."\n"
.'iot：物联网平台，'."\n"
.'alidns：云解析DNS，'."\n"
.'contract：合同类，'."\n"
.'vpc：专有网络VPC，'."\n"
.'sls：日志服务，'."\n"
.'cms：云监控，'."\n"
.'dts：数据传输，'."\n"
.'dm：邮件推送，'."\n"
.'sas：云安全中心，'."\n"
.'redis：云数据库Redis版，'."\n"
.'ide：DataWorks，'."\n"
.'ons：消息队列 RocketMQ，'."\n"
.'others：其它，'."\n"
.'dcdn：全站加速，'."\n"
.'mpaas：移动开发平台 mPaaS，'."\n"
.'eip：弹性公网IP，'."\n"
.'companyreg：企业工商注册服务，'."\n"
.'ram：访问控制，'."\n"
.'waf：Web应用防火墙，'."\n"
.'odps：MaxCompute，'."\n"
.'IVRTicket：热线工单二线组，'."\n"
.'polardb：云数据库POLARDB，'."\n"
.'dds：云数据库MongoDB版，'."\n"
.'link_living：阿里云Link生活平台，'."\n"
.'yundun：云盾，'."\n"
.'ads：分析型数据库MySQL版，'."\n"
.'nas：文件存储NAS，'."\n"
.'rdc：云效，'."\n"
.'elasticsearch：Elasticsearch，'."\n"
.'free_mail：免费企业邮箱，'."\n"
.'expressconnect：高速通道，'."\n"
.'vpn：VPN网关，'."\n"
.'dyvms：语音服务，'."\n"
.'cbn：云企业网，'."\n"
.'edas：企业级分布式应用服务EDAS，'."\n"
.'market：云市场，'."\n"
.'cloudauth：实人认证，'."\n"
.'galaxy：实时计算（流计算），'."\n"
.'emr：E-MapReduce，'."\n"
.'bastionhost：堡垒机，'."\n"
.'fc：函数计算，'."\n"
.'swcopyright：软件著作权登记，'."\n"
.'huodongzixun：活动咨询，'."\n"
.'drds：分布式关系型数据库服务 DRDS，'."\n"
.'deploy：专有云部署问题，'."\n"
.'speech：智能语音交互'."\n"
.'lvwang：内容安全，'."\n"
.'rtc：音视频通信，'."\n"
.'yun_dplus_datav：DataV数据可视化，'."\n"
.'agent：代理商类，'."\n"
.'ccc：云呼叫中心，'."\n"
.'dyiot：物联网无线连接服务，'."\n"
.'tianji：天基，'."\n"
.'face：人脸识别，'."\n"
.'apigateway：API 网关，'."\n"
.'cbs：数据库备份，'."\n"
.'quickbi：Quick BI，'."\n"
.'arms：应用实时监控服务 ARMS，'."\n"
.'mqiot：微消息队列MQTT，'."\n"
.'ccs：云客服，'."\n"
.'app：阿里云App，'."\n"
.'opensearch：开放搜索，'."\n"
.'ots：表格存储，'."\n"
.'ess：弹性伸缩，'."\n"
.'eci：弹性容器实例 ECI，'."\n"
.'mps：媒体处理，'."\n"
.'vs：视频监控，'."\n"
.'cps：移动推送，'."\n"
.'fundamental：基础组件，'."\n"
.'dtcenter：DTCenter，'."\n"
.'natgw：NAT网关，'."\n"
.'ddos：DDoS高防IP，'."\n"
.'dypns：号码认证服务，'."\n"
.'pts：性能测试，'."\n"
.'clouddesktop：云桌面，'."\n"
.'hbase：云数据库 HBase，'."\n"
.'others：其它',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecs',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'Phone',
'in' => 'query',
'schema' => [
'description' => '用于接收工单处理进度提醒短信的手机号。',
'type' => 'string',
'required' => false,
'example' => '13288888888',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '用于接收工单处理进度等消息的邮箱。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'support@aliyun.com',
],
],
[
'name' => 'NotifyTimeRange',
'in' => 'query',
'schema' => [
'description' => '接收工单提醒消息的时间段，值定义：normal：每日9:00-18:00提醒；all：无接收时间限制，任何时间都可以接收；never：:从不接收。默认：all。',
'type' => 'string',
'required' => false,
'example' => 'all',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'Message' => [
'type' => 'string',
],
'Data' => [
'type' => 'string',
],
'RequestId' => [
'description' => '请求唯一识别码。',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'type' => 'boolean',
],
'AccessDeniedDetail' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'illegalParam.emailOrPhone',
'errorMessage' => 'The specified contact email or mobile phone number must be the data received by the account messenger.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::CreateTicket',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TicketId\\": \\"ETARNPP\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\"\\n}","errorExample":""},{"type":"xml","example":"ETARNPP\\nCA6204AC-6AA9-4CFA-9310-7DFD20C19EBC","errorExample":""}]',
'title' => '新建工单',
'summary' => '创建工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTicketNotes' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言，支持，中文，英文，日文。'."\n"
.'值定义：zh：中文，en：英文，jp：日文。'."\n",
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => [
'description' => '工单号。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'G2BKRWG',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '提示信息。',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码。',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '调用成功后返回的业务数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '沟通记录列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FromOfficial' => [
'description' => '是否售后工程师回复，标示这条会是用户发出的还是售后工程师发出的。true：售后工程师回复，false：用户回复。',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreated' => [
'description' => '这条回复发出的时间戳，是精确到秒的时间戳。',
'type' => 'integer',
'format' => 'int32',
'example' => '1586920240',
],
'NoteId' => [
'description' => '回复id。',
'type' => 'string',
'example' => 'CT24GHXT',
],
'Content' => [
'description' => '沟通内容。',
'type' => 'string',
'example' => '您好我有个问题需要请教下',
],
],
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::ListTicketNotes',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"FromOfficial\\": false,\\n \\"GmtCreated\\": 1586920240,\\n \\"NoteId\\": \\"CT24GHXT\\",\\n \\"Content\\": \\"您好我有个问题需要请教下\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"successful\\n\\n \\n CT24GHXT\\n false\\n 有个问题请教下\\n 1586920240\\n
\\n\\n200\\ntrue","errorExample":""}]',
'title' => '获取工单沟通记录',
'summary' => '获取一个工单中的沟通记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTickets' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'query',
'schema' => [
'description' => '指定工单号筛选，多个工单号通过英文逗号分隔',
'type' => 'string',
'required' => false,
'example' => 'ETARNPP,RTARNP',
],
],
[
'name' => 'CreatedAfterTime',
'in' => 'query',
'schema' => [
'description' => '工单创建开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1585790280',
],
],
[
'name' => 'CreatedBeforeTime',
'in' => 'query',
'schema' => [
'description' => '工单创建结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1586049480',
],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => [
'description' => '产品code',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页展示的工单数，默认20，最大100',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'TicketStatus',
'in' => 'query',
'schema' => [
'description' => '通过工单状态筛选，多个工单状态通过英文逗号分隔，'."\n"
.'工单状态定义。in_progress：正在为您处理，wait_feedback：待您反馈，wait_confirm：待您确认，completed：已关闭。',
'type' => 'string',
'required' => false,
'example' => 'wait_confirm,dealing',
],
],
[
'name' => 'PageStart',
'in' => 'query',
'schema' => [
'description' => '分页查询的页码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SubUserId',
'in' => 'query',
'schema' => [
'description' => '指定子账号id查询',
'type' => 'string',
'required' => false,
'example' => '252448085032933023',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言，支持，中文，英文，日文。'."\n"
.'值定义：zh：中文，en：英文，jp：日文。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '提示信息'."\n",
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码'."\n",
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '接口调用成功返回的业务数据',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '当前页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页数行数',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'Total' => [
'description' => '列表总数',
'type' => 'integer',
'format' => 'int32',
'example' => '99',
],
'List' => [
'description' => '工单列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Title' => [
'description' => '工单标题',
'type' => 'string',
'example' => '这是一个测试工单',
],
'CreatorId' => [
'description' => '工单创建人uid',
'type' => 'string',
'example' => '252448085032933023',
],
'AddTime' => [
'description' => '工单创建时间，单位到秒的时间戳',
'type' => 'integer',
'format' => 'int32',
'example' => '1585818240',
],
'Id' => [
'description' => '工单号',
'type' => 'string',
'example' => 'CAB327A',
],
'TicketStatus' => [
'description' => '工单状态'."\n"
.'工单状态定义。in_progress：正在为您处理，wait_feedback：待您反馈，wait_confirm：待您确认，completed：已关闭。',
'type' => 'string',
'example' => 'assigned',
],
],
],
],
],
],
'AccessDeniedDetail' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::ListTickets',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 15,\\n \\"Total\\": 99,\\n \\"List\\": [\\n {\\n \\"Title\\": \\"这是一个测试工单\\",\\n \\"CreatorId\\": \\"252448085032933023\\",\\n \\"AddTime\\": 1585818240,\\n \\"Id\\": \\"CAB327A\\",\\n \\"TicketStatus\\": \\"assigned\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"success\\n\\n 20\\n 1\\n 9\\n \\n pop测试\\n assigned\\n CAB327A\\n 1585818240\\n
\\n \\n pop测试\\n assigned\\n 2HB89DX\\n 1585818240\\n
\\n\\n200\\ntrue","errorExample":""}]',
'title' => '获取工单列表',
'summary' => '通过ListTickets接口获取您创建的工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CloseTicket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'none',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言，支持，中文，英文，日文。'."\n"
.'值定义：zh：中文，en：英文，jp：日文。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'TicketId',
'in' => 'query',
'schema' => [
'description' => '工单号',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3EBYRY7',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '提示信息',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码',
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。',
'type' => 'boolean',
'example' => 'true',
],
'AccessDeniedDetail' => [
'type' => 'string',
],
],
],
],
],
'errorCodes' => [
200 => [
[
'errorCode' => 'business.error',
'errorMessage' => 'The business does not allow the current operation',
],
],
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
403 => [
[
'errorCode' => 'No permissions',
'errorMessage' => 'No permissions to access.',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::CloseTicket',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"success\\n200\\ntrue\\nCA6204AC-6AA9-4CFA-9310-7DFD20C19EBC","errorExample":""}]',
'title' => '关闭工单',
'summary' => '调用CloseTicket接口关闭工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCategories' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '您使用的语言，支持，中文，英文，日文。 值定义：zh：中文，en：英文，jp：日文。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => [
'description' => '产品编码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecs',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '提示信息',
'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' => 'object',
'properties' => [
'List' => [
'description' => '类别列表数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '类别名称',
'type' => 'string',
'example' => 'ECS无法远程',
],
'Id' => [
'description' => '类别id',
'type' => 'integer',
'format' => 'int32',
'example' => '793',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::ListCategories',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Name\\": \\"ECS无法远程\\",\\n \\"Id\\": 793\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"success\\n\\n \\n 793\\n ECS无法远程\\n
\\n \\n 794\\n 服务器打不开\\n
\\n\\n200\\ntrue","errorExample":""}]',
'title' => '获取指定产品下的类别',
'summary' => '调用ListCategories获取指定产品下的类别。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListProducts' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Message' => [
'description' => '提示信息'."\n",
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求唯一识别码'."\n",
'type' => 'string',
'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC',
],
'Success' => [
'description' => '调用是否成功。true：表示成功；false：表示失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '接口调用成功后，返回的数据',
'type' => 'object',
'properties' => [
'TechMore' => [
'description' => '更多技术产品',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '技术产品组',
'type' => 'string',
'example' => '存储与CDN',
],
'ProductList' => [
'description' => '组下包含的产品列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '产品名称',
'type' => 'string',
'example' => '对象存储 OSS',
],
'Description' => [
'description' => '产品描述',
'type' => 'string',
'example' => '对象存储 OSS',
],
'ProductCode' => [
'description' => '产品编码',
'type' => 'string',
'example' => 'oss',
],
],
],
],
],
],
],
'HotConsultation' => [
'description' => '热门咨询类产品',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '产品名称',
'type' => 'string',
'example' => '代理商类',
],
'Description' => [
'description' => '产品描述',
'type' => 'string',
'example' => '代理商类相关问题',
],
'ProductCode' => [
'description' => '产品编码',
'type' => 'string',
'example' => 'agent',
],
],
],
],
'ConsultationMore' => [
'description' => '咨询类更多产品类别',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '产品名称',
'type' => 'string',
'example' => '会员帐号',
],
'Description' => [
'description' => '产品描述',
'type' => 'string',
'example' => '换绑手机/邮箱、实名认证、找回用户名/密码等相关问题',
],
'ProductCode' => [
'description' => '产品编码',
'type' => 'string',
'example' => 'account',
],
],
],
],
'HotTech' => [
'description' => '热门技术产品',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '产品名称',
'type' => 'string',
'example' => '云服务器 ECS',
],
'Description' => [
'description' => '产品描述',
'type' => 'string',
'example' => '服务器无法远程、网站无法访问、安全等服务器咨询或技术问题',
],
'ProductCode' => [
'description' => '产品编码',
'type' => 'string',
'example' => 'ecs',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'param.illegal',
'errorMessage' => 'The specified parameter is invalid. Please check the parameter.',
],
[
'errorCode' => 'Illegal.NeedAccessChinaSite',
'errorMessage' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.',
],
[
'errorCode' => 'Illegal.NeedAccessInternationalSite',
'errorMessage' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.',
],
],
[
[
'errorCode' => 'illegal.auth',
'errorMessage' => 'illegal auth',
],
],
500 => [
[
'errorCode' => 'System.error',
'errorMessage' => 'An error occurred while processing your request.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Workorder::2021-06-10::ListProducts',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TechMore\\": [\\n {\\n \\"GroupName\\": \\"存储与CDN\\",\\n \\"ProductList\\": [\\n {\\n \\"Name\\": \\"对象存储 OSS\\",\\n \\"Description\\": \\"对象存储 OSS\\",\\n \\"ProductCode\\": \\"oss\\"\\n }\\n ]\\n }\\n ],\\n \\"HotConsultation\\": [\\n {\\n \\"Name\\": \\"代理商类\\",\\n \\"Description\\": \\"代理商类相关问题\\",\\n \\"ProductCode\\": \\"agent\\"\\n }\\n ],\\n \\"ConsultationMore\\": [\\n {\\n \\"Name\\": \\"会员帐号\\",\\n \\"Description\\": \\"换绑手机/邮箱、实名认证、找回用户名/密码等相关问题\\",\\n \\"ProductCode\\": \\"account\\"\\n }\\n ],\\n \\"HotTech\\": [\\n {\\n \\"Name\\": \\"云服务器 ECS\\",\\n \\"Description\\": \\"服务器无法远程、网站无法访问、安全等服务器咨询或技术问题\\",\\n \\"ProductCode\\": \\"ecs\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"success\\n\\n \\n 备案咨询、补偿、退款、等相关问题\\n 76\\n 备案\\n \\n \\n 订单，提现，发票，汇款，代金券等相关问题\\n 1193\\n 财务类\\n \\n \\n 换绑手机/邮箱、实名认证、找回用户名/密码等相关问题\\n 1194\\n 会员帐号\\n \\n \\n 客户端配置/使用、收发信件异常及退信、postmaster管理员、垃圾邮件等相关问题\\n 88\\n 企业邮箱\\n \\n \\n 弹性计算\\n \\n 无法配置SLB、负载不均衡、健康检查异常等问题\\n 86\\n 负载均衡\\n \\n \\n bucket创建/使用、API密钥等OSS咨询或技术问题--\\n 22\\n 对象存储 OSS\\n \\n \\n 独享主机重启、远程无法连接、密码初始化、系统初始化等相关问题\\n 101\\n 独享主机\\n \\n \\n 控制面板、FTP使用、数据库、网站访问等轻云服务器问题\\n 1205\\n 轻云服务器\\n \\n \\n （原万网）虚拟主机、独享主机、轻云服务器、云享服务器相关问题\\n 1215\\n (原万网)主机\\n \\n \\n \\n 更多\\n \\n 竞赛规则、技术咨询等相关问题\\n 1209\\n 天池\\n \\n \\n\\n200\\ntrue","errorExample":""}]',
'title' => '获取产品类别列表',
'summary' => '通过ListProducts可获取到产品列表数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
],
'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',
],
],
];