diff options
Diffstat (limited to 'data/en_us/workorder/2021-06-10/api-docs.php')
| -rw-r--r-- | data/en_us/workorder/2021-06-10/api-docs.php | 2228 |
1 files changed, 667 insertions, 1561 deletions
diff --git a/data/en_us/workorder/2021-06-10/api-docs.php b/data/en_us/workorder/2021-06-10/api-docs.php index 4550fab..01db248 100644 --- a/data/en_us/workorder/2021-06-10/api-docs.php +++ b/data/en_us/workorder/2021-06-10/api-docs.php @@ -1,37 +1,14 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Workorder', - 'version' => '2021-06-10', - ], - 'directories' => [ - 'GetTicket', - 'CreateTicket', - 'ReplyTicket', - 'CloseTicket', - 'EvaluateTicket', - 'ListTickets', - 'ListTicketNotes', - 'ListProducts', - 'ListCategories', - 'GetMqConsumerTag', - 'ReopenTicket', - 'GetAttachmentUploadUrl', - ], + 'info' => ['style' => 'RPC', 'product' => 'Workorder', 'version' => '2021-06-10'], + 'directories' => ['GetTicket', 'ReplyTicket', 'CloseTicket', 'EvaluateTicket', 'ListTickets', 'ListTicketNotes', 'ListCategories', 'GetMqConsumerTag', 'ReopenTicket', 'GetAttachmentUploadUrl', 'CreateTicket', 'ListProducts'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GetTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloseTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40,33 +17,19 @@ 'APP' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '001571BTXC', - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'G2BKRWG', 'title' => ''], ], [ 'name' => 'Uid', 'in' => 'formData', - 'schema' => [ - 'description' => 'UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1604499804113750', - ], + 'schema' => ['description' => 'The user UID. You can find your UID by clicking the profile picture in the upper-right corner of the DMS console.', 'type' => 'string', 'required' => false, 'example' => '1139477549527134', 'title' => ''], ], ], 'responses' => [ @@ -74,162 +37,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C499BB0F-630D-5BE6-B3EA-5FCD95B85503', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageNumber' => [ - 'description' => 'Page number of the paging query parameter'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page in a pagination query parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of query results, that is, the total number of my ticket records.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '108', - ], - 'Data' => [ - 'description' => 'The data returned after the call succeeds.'."\n", - 'type' => 'object', - 'properties' => [ - 'TicketId' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'example' => '0005PYGCW', - ], - 'Title' => [ - 'description' => 'The title of the ticket.'."\n", - 'type' => 'string', - 'example' => 'Why ECS renewal failed?', - ], - 'Description' => [ - 'description' => 'The description of the ticket. Only pure text format is supported.'."\n", - 'type' => 'string', - 'example' => 'Why ECS renewal failed?', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the ticket was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1623396736000', - ], - 'CreatorId' => [ - 'description' => 'The uid of the ticket creator.'."\n", - 'type' => 'string', - 'example' => '1168025', - ], - 'CategoryId' => [ - 'description' => 'The ID of the ticket issue category.'."\n", - 'type' => 'string', - 'example' => '7161', - ], - 'Status' => [ - 'description' => 'The status of the ticket. The reference values are as follows 1, "assigned", "Pending Response", 2, "handling", "handling", 3, "wait_feedback", "Pending feedback", 4: "feedback", "Feedback", 5, "wait_confirm", "To be confirmed", 6, "confirmed", "Completed"'."\n", - 'type' => 'object', - 'properties' => [ - 'Label' => [ - 'description' => 'Status Enumeration Text'."\n", - 'type' => 'string', - 'example' => 'Completed', - ], - 'Value' => [ - 'description' => 'State enumeration value'."\n", - 'type' => 'string', - 'example' => '6', - ], - ], - ], - 'Severity' => [ - 'description' => 'Urgency enumeration value, 1 for general problem, 2 for urgent problem'."\n", - 'type' => 'object', - 'properties' => [ - 'Label' => [ - 'description' => 'Enumeration Text'."\n", - 'type' => 'string', - 'example' => 'Common', - ], - 'Value' => [ - 'description' => 'Enumeration'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], + 'AccessDeniedDetail' => ['description' => 'Details about the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:CloseTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The return code of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message. The message is returned if \\`Success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates a successful call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'illegal.param', - 'errorMessage' => 'Illegal param.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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' => 'GetTicket', - 'summary' => 'Query tickets.', + 'title' => 'CloseTicket', + 'summary' => 'Closes a ticket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseTicket'], + ], + ], + '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"}]', ], 'CreateTicket' => [ 'summary' => 'Creates a ticket.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -240,102 +87,60 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the ticket. Only pure text format is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Why ECS backup failed?', - ], + 'schema' => ['description' => 'The description of the issue in the ticket. Only plain text is supported.', 'type' => 'string', 'example' => 'ECS backup failed', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ 'name' => 'Severity', 'in' => 'formData', 'schema' => [ - 'description' => 'Enumeration value, 1 for general problem, 2 for urgent problem'."\n" - ."\n" - .'Enumeration values:'."\n" - ."\n" - .'* 1: regular.'."\n" - .'* 2: emergency.'."\n", + 'description' => 'An enumeration value. A value of 1 indicates a normal issue. A value of 2 indicates an urgent issue.', + 'enumValueTitles' => [1 => 'Normal', 'Urgent'], 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '0', - 'enumValueTitles' => [ - 1 => '', - '', - ], 'example' => '1', + 'title' => '', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the problem category. You can obtain the returned value from the ListCategories operation by using the CategoryId parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7161', - ], + 'schema' => ['description' => 'The ID of the issue category. Obtain this ID from the ListCategories operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '53812', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'formData', - 'schema' => [ - 'description' => 'The title of the ticket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Why ECS backup failed?', - ], + 'schema' => ['description' => 'The title of the ticket.', 'type' => 'string', 'example' => 'ECS backup failed', 'required' => false, 'title' => ''], ], [ 'name' => 'CreatorId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Submit the Alibaba Cloud UID of the account, which is required for the MPK virtual market scene.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1289427240739141', - ], + 'schema' => ['description' => 'The Alibaba Cloud UID of the account that submits the ticket. This parameter is required for Marketplace reseller scenarios.', 'type' => 'string', 'required' => false, 'example' => '1289427240739141', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'formData', - 'schema' => [ - 'description' => 'sdahkjdshga@qq.com'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '163@163.com', - ], + 'schema' => ['description' => 'The contact email address for the ticket.', 'type' => 'string', 'required' => false, 'example' => 'sdahkjdshga@qq.com', 'title' => ''], ], [ 'name' => 'FileNameList', 'in' => 'formData', 'style' => 'simple', 'schema' => [ - 'description' => 'The list of attachment names, GetAttachmentUploadUrl the ObjectKey field returned by the interface.'."\n", + 'description' => 'A list of attachment names. Use the ObjectKey value returned by the GetAttachmentUploadUrl operation.', 'type' => 'array', - 'items' => [ - 'description' => 'The ObjectKey field returned by the GetAttachmentUploadUrl interface.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', - ], + 'items' => ['description' => 'The ObjectKey value returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -343,28 +148,22 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Sensitive information'."\n", + 'description' => 'Sensitive information.', 'type' => 'object', 'properties' => [ - 'Content' => [ - 'description' => 'Sensitive information-text content'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ID:330102xxxxxx', - ], + 'Content' => ['description' => 'The text of the sensitive information.', 'type' => 'string', 'example' => 'ID card: 3310xxxx', 'required' => false, 'title' => ''], 'FileNameList' => [ - 'description' => 'Sensitive Information-Attachment Name List'."\n", + 'description' => 'A list of attachment names for the sensitive information.', 'type' => 'array', - 'items' => [ - 'description' => 'The ObjectKey field returned by the GetAttachmentUploadUrl interface.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', - ], + 'items' => ['description' => 'The ObjectKey value returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => 'cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -373,78 +172,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The return value is the work order number.'."\n", - 'type' => 'string', - 'example' => '0005PYGCW', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the API request. The requestID is unique for each call.'."\n", - 'type' => 'string', - 'example' => '0254B7DE-7365-57B4-8E38-14FE927E3FEB', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if the permissions are sufficient.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:CreateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned when the value of Success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The return value, which is the ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. Each request has a unique ID.', 'type' => 'string', 'example' => '0254B7DE-7365-57B4-8E38-14FE927E3FEB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], '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' => 'CreateTicket', - ], - 'ReplyTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTicket'], + ], ], + 'translator' => 'manual', + ], + 'EvaluateTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -455,69 +222,32 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the ticket.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0005PYGCW', - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '001ET1BU1P', 'title' => ''], ], [ - 'name' => 'Content', + 'name' => 'Solved', 'in' => 'formData', - 'schema' => [ - 'description' => 'Content of the ticket reply'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Why ECS backup failed?', - ], + 'schema' => ['description' => 'Indicates whether the issue was resolved.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'FileNameList', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => 'The list of attachment names, GetAttachmentUploadUrl the ObjectKey field returned by the interface.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ObjectKey field returned by the GetAttachmentUploadUrl interface.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6bc06f96-f8c1-4c00-9e30-368444fbd025.jpg,', - ], - 'required' => false, - ], + 'name' => 'Score', + 'in' => 'formData', + 'schema' => ['description' => 'The rating, from 1 to 5 stars.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Encrypt', + 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => 'Encryption status'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The content of the evaluation.', 'type' => 'string', 'example' => 'Very satisfactory support experience', 'required' => false, 'title' => ''], ], [ 'name' => 'Uid', 'in' => 'formData', - 'schema' => [ - 'description' => 'Alibaba Cloud UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1289427240739141', - ], + 'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1902070573958003', 'title' => ''], ], ], 'responses' => [ @@ -525,79 +255,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The returned value is the dialogID of the response to the ticket.'."\n", - 'type' => 'string', - 'example' => '46434030', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the API request. The requestid is unique for each call.'."\n", - 'type' => 'string', - 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:EvaluateTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only when the \\`Success\\` parameter is \\`false\\`.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates that the call succeeded. A value of \\`false\\` indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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' => 'ReplyTicket', - 'summary' => 'Reply to the ticket. You can call the ListTicketNotes operation to obtain the content of the reply.', - ], - 'CloseTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'EvaluateTicket', + 'summary' => 'Evaluates a ticket.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EvaluateTicket'], + ], ], + 'translator' => 'manual', + ], + 'GetAttachmentUploadUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -608,31 +308,12 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TicketId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'G2BKRWG', - ], - ], - [ - 'name' => 'Uid', + 'name' => 'FileName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The UID of the Alibaba Cloud account. You can view your UID in the profile picture in the upper-right corner of the DMS console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1139477549527134', - ], + 'schema' => ['description' => 'Name of the uploaded file', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '81A0D93D-54D7-4529-ABFA-633ED63223BA.jpg', 'title' => ''], ], ], 'responses' => [ @@ -640,74 +321,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ED195C2C-787F-511C-8204-714456781861', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned after the call succeeds.', + 'type' => 'object', + 'properties' => [ + 'ObjectKey' => ['description' => 'Uploaded file identifier', 'type' => 'string', 'example' => 'cdb5d174-c282-4b2d-9048-e74ea2223127.jpg', 'title' => ''], + 'PutSignedUrl' => ['description' => 'The signed URL used to upload the object to OSS.', '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', 'title' => ''], + 'GetSignedUrl' => ['description' => 'Query the signed URL of an OSS object', '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', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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' => 'CloseTicket', - 'summary' => 'Closes a ticket.', - ], - 'EvaluateTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetAttachmentUploadUrl', + 'summary' => 'Queries the Object Storage Service (OSS) URL that is used to upload attachments.', + 'description' => '> Attachment upload'."\n" + .'>'."\n" + .'> - Use a presigned URL to upload the file. For more information, see the OSS documentation.'."\n" + ."\n" + .'After you obtain the temporary upload URL, you can upload the file as follows:'."\n" + ."\n" + .'<details>'."\n" + ."\n" + .'<summary>'."\n" + ."\n" + .'Sample'."\n" + ."\n" + .'</summary>'."\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" + ."\n" + .'</details>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAttachmentUploadUrl'], + ], ], + '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"}]', + ], + 'GetMqConsumerTag' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -716,63 +397,76 @@ 'APP' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TicketId', - 'in' => 'formData', + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the ticket.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '001ET1BU1P', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:GetMqConsumerTag\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned when \\`success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The return value. This is the unique tag for your Message Queue (MQ) consumer.', 'type' => 'string', 'example' => '46434030', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], + ], [ - 'name' => 'Solved', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether to resolve'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], + ], + 403 => [ + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], + ], + 500 => [ + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], + ], + ], + 'title' => 'GetMqConsumerTag', + 'summary' => 'Retrieves the tag for a ticket\'s RocketMQ message listener.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMqConsumerTag'], + ], + ], + '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"}]', + ], + 'GetTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], [ - 'name' => 'Score', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rating star 1-5 stars'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'APP' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'Content', + 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Comment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The engineer solved my issue.', - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '001571BTXC', 'title' => ''], ], [ 'name' => 'Uid', 'in' => 'formData', - 'schema' => [ - 'description' => 'UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1902070573958003', - ], + 'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1604499804113750', 'title' => ''], ], ], 'responses' => [ @@ -780,77 +474,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'AccessDeniedDetail' => ['description' => 'The details of the access denial. An empty string is returned if you have sufficient permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:GetTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C499BB0F-630D-5BE6-B3EA-5FCD95B85503', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. Returned only when Success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tickets.', 'type' => 'integer', 'format' => 'int64', 'example' => '108', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned on success.', + 'type' => 'object', + 'properties' => [ + 'TicketId' => ['description' => 'The ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''], + 'Title' => ['description' => 'The ticket title.', 'type' => 'string', 'example' => 'Why did ECS renewal fail?', 'title' => ''], + 'Description' => ['description' => 'The description of the ticket. Only plain text is supported.', 'type' => 'string', 'example' => 'Why ECS renewal failed?', 'title' => ''], + 'CreateTime' => ['description' => 'The UNIX timestamp when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623396736000', 'title' => ''], + 'CreatorId' => ['description' => 'The UID of the user who created the ticket.', 'type' => 'string', 'example' => '1168025', 'title' => ''], + 'CategoryId' => ['description' => 'The ID of the ticket category.', 'type' => 'string', 'example' => '7161', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the ticket. The following are the valid values:'."\n" + ."\n" + .'1: assigned (To be processed)'."\n" + ."\n" + .'2: dealing (Processing)'."\n" + ."\n" + .'3: wait\\_feedback (Waiting for feedback)'."\n" + ."\n" + .'4: feedback (Feedback received)'."\n" + ."\n" + .'5: wait\\_confirm (To be confirmed)'."\n" + ."\n" + .'6: confirmed (Completed)', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The status label.', 'type' => 'string', 'example' => 'Completed', 'title' => ''], + 'Value' => ['description' => 'The status value.', 'type' => 'string', 'example' => '6', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Severity' => [ + 'description' => 'The severity level. A value of 1 indicates a common issue. A value of 2 indicates an urgent issue.', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The severity label.', 'type' => 'string', 'example' => 'General issue', 'title' => ''], + 'Value' => ['description' => 'The severity value.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'illegal.param', 'errorMessage' => 'Illegal param.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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":"<EvaluateTicketResponse>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <RequestId>C1DA4C6F-963E-5741-AB57-67A554D102FD</RequestId>\\n <Success>true</Success>\\n</EvaluateTicketResponse>","errorExample":""}]', - 'title' => 'EvaluateTicket', - 'summary' => 'Evaluates a ticket.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTickets' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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\\": \\"Why did ECS renewal fail?\\",\\n \\"Description\\": \\"Why ECS renewal failed?\\",\\n \\"CreateTime\\": 1623396736000,\\n \\"CreatorId\\": \\"1168025\\",\\n \\"CategoryId\\": \\"7161\\",\\n \\"Status\\": {\\n \\"Label\\": \\"Completed\\",\\n \\"Value\\": \\"6\\"\\n },\\n \\"Severity\\": {\\n \\"Label\\": \\"General issue\\",\\n \\"Value\\": \\"1\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetTicket', + 'summary' => 'Queries a ticket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTicket'], + ], ], + 'translator' => 'manual', + ], + 'ListCategories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -861,126 +573,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'StartDate', + 'name' => 'ProductId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the ticket was created. This parameter is used with EndDate to query tickets that are created within the specified start and end time ranges.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1623396736000', - ], + 'schema' => ['description' => 'The ID of the product. You can call the ListProducts operation to obtain the product ID. The ProductId parameter is the ID of an Alibaba Cloud product. Multiple Categories are displayed for each product.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '0', 'example' => '18550', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The deadline for ticket creation. This parameter is used in conjunction with StartDate to query tickets submitted within the specified start and end time ranges.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1623396736000', - ], + 'schema' => ['description' => 'The name of the classification question. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'Paging query page number parameters'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries queried by page parameter'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - ], - ], - [ - 'name' => 'TicketId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0005PYGCW', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ticket keyword, which is used for fuzzy search to match the content of the Description field when a ticket is created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - ], - [ - 'name' => 'StatusList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Multiple ticket statuses'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ticket status. Valid values: 1,"assigned","To be responded",2,"dealing","processing",3,"wait-feedback","To be responded",4,"feedback","Feedback",5,"wait_confirm","To be confirmed",6,"confirmed","Completed"'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'confirmed', - ], - 'required' => false, - 'example' => '6', - 'maxItems' => 11, - ], - ], - [ - 'name' => 'TicketIdList', - 'in' => 'formData', - 'style' => 'simple', - 'schema' => [ - 'description' => 'Multiple job numbers'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ticket ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0006S6ZL6E', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Uid', - 'in' => 'formData', - 'schema' => [ - 'description' => 'UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1902070573958003', - ], + 'schema' => ['description' => 'Multi-language, support, Chinese, English. Value definition: zh: Chinese, en: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -988,130 +596,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the API request. The requestID is unique for each call.'."\n", - 'type' => 'string', - 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'PageNumber' => [ - 'description' => 'Page number of the paging query parameter'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page in a pagination query parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of query results, that is, the total number of my ticket records.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: The value true indicates a success. The value false indicates a failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The return value is my ticket list data.'."\n", + 'description' => 'The return value, which is a list of question categories', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'TicketId' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'example' => '0005PYGCW', - ], - 'Title' => [ - 'description' => 'The title of the ticket.'."\n", - 'type' => 'string', - 'example' => 'Why ECS backup failed?', - ], - 'Status' => [ - 'description' => 'The status of the ticket. The reference values are as follows 1, "assigned", "Pending Response", 2, "handling", "handling", 3, "wait_feedback", "Pending feedback", 4: "feedback", "Feedback", 5, "wait_confirm", "To be confirmed", 6, "confirmed", "Completed"'."\n", - 'type' => 'object', - 'properties' => [ - 'Label' => [ - 'description' => 'Status description, if completed'."\n", - 'type' => 'string', - 'example' => 'Completed', - ], - 'Value' => [ - 'description' => 'A status value, such as 6, represents completed'."\n", - 'type' => 'string', - 'example' => '6', - ], - ], - ], + 'CategoryName' => ['description' => 'The name of the ticket issue category.', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'CategoryId' => ['description' => 'The ID of the ticket issue category.', 'type' => 'integer', 'format' => 'int64', 'example' => '7161', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'illegal.param', - 'errorMessage' => 'Params illegal', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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":"<TotalCount>99</TotalCount>\\n<PageSize>10</PageSize>\\n<Message>入参解析失败</Message>\\n<RequestId>AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD</RequestId>\\n<PageNumber>1</PageNumber>\\n<Data>\\n <TicketId>0005PYGCW</TicketId>\\n <Title>ecs续费失败啥原因</Title>\\n <Status>\\n <Value>6</Value>\\n <Label>已完成</Label>\\n </Status>\\n</Data>\\n<Code>0</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'ListTickets', - 'summary' => 'You can call this operation to obtain the list of my tickets.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTicketNotes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListCategories', + 'summary' => 'Obtains the list data of ticket problem categories.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCategories'], + ], ], + '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"}]', + ], + 'ListProducts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1122,31 +660,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TicketId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0005PYGCW', - ], + 'schema' => ['description' => 'The name of the product. Fuzzy search is supported. This parameter is optional.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecs', 'title' => ''], ], [ - 'name' => 'Uid', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1936753548534516', - ], + 'schema' => ['description' => 'The language that you use, supporting English, Chinese, and Japanese. Valid values: en, zh, and jp, which indicate English, Chinese, and Japanese, respectively.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -1154,168 +678,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the API request. The requestID is unique for each call.'."\n", - 'type' => 'string', - 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The return code of the request result.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. If success is set to false, the message is returned.', 'type' => 'string', 'example' => 'Invalid input parameter', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the API request. The requestID is unique for each call.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Return value, that is, the dialog record list data of the specified ticket'."\n", + 'description' => 'Return value, that is, product list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Conversation Type 1 card, that is, schema 2 Text, that is, content'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => 'Communication message status field, reference value Unread=1, Read=2'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'Tip' => [ - 'description' => 'Fields Not Used'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'DialogId' => [ - 'description' => 'The unique ID of the conversation record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9999', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the communication message was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1623396736000', - ], - 'Dialog' => [ - 'description' => 'Work order communication record object'."\n", - 'type' => 'object', - 'properties' => [ - 'Schema' => [ - 'description' => 'The ticket communication record system card will be used when the system card docking capability is opened in the future. At present, the content can be used to obtain plain text content.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Content' => [ - 'description' => 'Work order communication content'."\n", - 'type' => 'string', - 'example' => 'ECS backup failed', - ], - ], - ], - 'User' => [ - 'description' => 'Conversation of users'."\n", - 'type' => 'object', - 'properties' => [ - 'Role' => [ - 'description' => 'Dialogue user role, distinguish between agent and user.'."\n" - .'2 represents agent, 3 represents user.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Name' => [ - 'description' => 'Dialog User Name'."\n", - 'type' => 'string', - 'example' => 'agent', - ], - ], - ], - 'Attachments' => [ - 'description' => 'Attachment List'."\n", + 'DirectoryId' => ['description' => 'The ID of the product catalog, which represents the product category, such as elastic computing', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DirectoryName' => ['description' => 'The name of the product catalog, which represents the product category, such as elastic computing', 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'ProductList' => [ + 'description' => 'List of Alibaba Cloud products', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Attachment Name'."\n", - 'type' => 'string', - 'example' => '003.jpg', - ], - 'Url' => [ - 'description' => 'Temporary Accessible Attachment Address'."\n", - 'type' => 'string', - 'example' => 'https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png', - ], + 'ProductId' => ['description' => 'Alibaba Cloud product ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7160', 'title' => ''], + 'ProductName' => ['description' => 'Alibaba Cloud product name', 'type' => 'string', 'example' => 'ECS', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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":"<Message>入参非法</Message>\\n<RequestId>AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD</RequestId>\\n<Data>\\n <Status>6</Status>\\n <Type>1</Type>\\n <CreateTime>1623396736000</CreateTime>\\n <DialogId>9999</DialogId>\\n <Tip>null</Tip>\\n <Dialog>\\n <Content>你好, 我的ECS续费失败, 请问是什么原因</Content>\\n <Schema>null</Schema>\\n </Dialog>\\n <User>\\n <Role>3</Role>\\n <Name>工单小二</Name>\\n </User>\\n</Data>\\n<Code>0</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'ListTicketNotes', - 'summary' => 'Obtains the ticket communication records.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameter\\",\\n \\"RequestId\\": \\"AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DirectoryId\\": 1,\\n \\"DirectoryName\\": \\"ECS\\",\\n \\"ProductList\\": [\\n {\\n \\"ProductId\\": 7160,\\n \\"ProductName\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListProducts', + 'summary' => 'Obtains the data of the Alibaba Cloud product list.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListProducts' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListProducts'], + ], ], + 'translator' => 'manual', + ], + 'ListTicketNotes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1326,31 +762,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the product. Fuzzy search is supported. This parameter is optional.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ecs', - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'Uid', 'in' => 'query', - 'schema' => [ - 'description' => 'The language that you use, supporting English, Chinese, and Japanese. Valid values: en, zh, and jp, which indicate English, Chinese, and Japanese, respectively.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn', - ], + 'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1936753548534516', 'title' => ''], ], ], 'responses' => [ @@ -1358,114 +780,104 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the API request. The requestID is unique for each call.'."\n", - 'type' => 'string', - 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. An empty string is returned if you have the required permissions.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ListTicketNotes\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The return code for the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned when \\`Success\\` is \\`false\\`.', 'type' => 'string', 'example' => 'Invalid input parameter', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. Each request has a unique ID.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates a successful call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Return value, that is, product list'."\n", + 'description' => 'The return value, which is a list of communication records for the specified ticket.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DirectoryId' => [ - 'description' => 'The ID of the product catalog, which represents the product category, such as elastic computing'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Type' => ['description' => 'The type of communication. Valid values: \\`1\\`: Card, which corresponds to \\`Schema\\`. \\`2\\`: Text, which corresponds to \\`Content\\`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The status of the communication message. Valid values: \\`1\\`: Unread. \\`2\\`: Read.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'Tip' => ['description' => 'This parameter is not in use.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DialogId' => ['description' => 'The unique ID of the communication record.', 'type' => 'integer', 'format' => 'int64', 'example' => '9999', 'title' => ''], + 'CreateTime' => ['description' => 'The UNIX timestamp when the communication message was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623396736000', 'title' => ''], + 'Dialog' => [ + 'description' => 'The ticket communication record object.', + 'type' => 'object', + 'properties' => [ + 'Schema' => ['description' => 'The system card for the ticket communication record. This parameter is reserved for future use. Currently, you can use the \\`Content\\` parameter to retrieve the plain text.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Content' => ['description' => 'The content of the ticket communication.', 'type' => 'string', 'example' => 'Hello, my ECS renewal failed. What is the reason?', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'DirectoryName' => [ - 'description' => 'The name of the product catalog, which represents the product category, such as elastic computing'."\n", - 'type' => 'string', - 'example' => 'ECS', + 'User' => [ + 'description' => 'The user in the communication.', + 'type' => 'object', + 'properties' => [ + 'Role' => ['description' => 'The role of the user in the communication. This parameter distinguishes between customer service agents and customers. Valid values: \\`2\\`: Customer service agent. \\`3\\`: Customer.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The name of the user.', 'type' => 'string', 'example' => 'John', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ProductList' => [ - 'description' => 'List of Alibaba Cloud products'."\n", + 'Attachments' => [ + 'description' => 'The list of attachments.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ProductId' => [ - 'description' => 'Alibaba Cloud product ID'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7160', - ], - 'ProductName' => [ - 'description' => 'Alibaba Cloud product name'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], + 'Name' => ['description' => 'The name of the attachment.', 'type' => 'string', 'example' => '003.jpg', 'title' => ''], + 'Url' => ['description' => 'A temporary URL to access the attachment.', 'type' => 'string', 'example' => 'https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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":"<Message>入参非法</Message>\\n<RequestId>AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD</RequestId>\\n<Data>\\n <DirectoryId>1</DirectoryId>\\n <DirectoryName>云服务器</DirectoryName>\\n <ProductList>\\n <ProductName>ECS</ProductName>\\n <ProductId>7160</ProductId>\\n </ProductList>\\n</Data>\\n<Code>0</Code>\\n<Success>true</Success>","errorExample":""}]', - 'title' => 'ListProducts', - 'summary' => 'Obtains the data of the Alibaba Cloud product list.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{\\\\\\\\\\\\\\"AuthAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ram:ListTicketNotes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalDisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2146216584788xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1135850448xxxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AuthPrincipalType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SubUser\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"NoPermissionType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ImplicitDeny\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PolicyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AccountLevelIdentityBasedPolicy\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameter\\",\\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\\": \\"Hello, my ECS renewal failed. What is the reason?\\"\\n },\\n \\"User\\": {\\n \\"Role\\": 3,\\n \\"Name\\": \\"John\\"\\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}","type":"json"}]', + 'title' => 'ListTicketNotes', + 'summary' => 'Retrieves the communication records for a ticket.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListCategories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTicketNotes'], + ], ], + 'translator' => 'manual', + ], + 'ListTickets' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1476,219 +888,148 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProductId', + 'name' => 'StartDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the product. You can call the ListProducts operation to obtain the product ID. The ProductId parameter is the ID of an Alibaba Cloud product. Multiple Categories are displayed for each product.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '0', - 'example' => '18550', - ], + 'schema' => ['description' => 'The start time when the ticket was created. Use this parameter with EndDate to query tickets created within a specific time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1623396736000', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end time when the ticket was created. Use this parameter with StartDate to query tickets created within a specific time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1623396736000', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '0005PYGCW', 'title' => ''], + ], + [ + 'name' => 'Keyword', 'in' => 'formData', + 'schema' => ['description' => 'The keyword for a fuzzy search. The keyword is used to match the content of the Description field of the ticket.', 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + [ + 'name' => 'StatusList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the classification question. Fuzzy search is supported.'."\n", - 'type' => 'string', + 'description' => 'A list of ticket statuses.', + 'type' => 'array', + 'items' => ['description' => 'The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait\\_feedback (Waiting for feedback), feedback (Feedback received), wait\\_confirm (Pending confirmation), and confirmed (Completed).', 'type' => 'string', 'required' => false, 'example' => 'confirmed', 'title' => ''], 'required' => false, - 'example' => 'ecs', + 'example' => '6', + 'maxItems' => 11, + 'title' => '', ], ], [ - 'name' => 'Language', - 'in' => 'query', + 'name' => 'TicketIdList', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'description' => 'Multi-language, support, Chinese, English. Value definition: zh: Chinese, en: English.'."\n", - 'type' => 'string', + 'description' => 'A list of ticket IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '0006S6ZL6E', 'title' => ''], 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Uid', + 'in' => 'formData', + 'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1902070573958003', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: The value true indicates a success. The value false indicates a failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ListTickets\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. A unique ID is returned for each request.', 'type' => 'string', 'example' => 'AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The return code of the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only when the value of success is false.', 'type' => 'string', 'example' => '入参解析失败', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of query results, which is the total number of your tickets.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''], 'Data' => [ - 'description' => 'The return value, which is a list of question categories'."\n", + 'description' => 'The list of your tickets.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'CategoryName' => [ - 'description' => 'The name of the ticket issue category.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'CategoryId' => [ - 'description' => 'The ID of the ticket issue category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7161', + 'TicketId' => ['description' => 'The ticket ID.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''], + 'Title' => ['description' => 'The ticket title.', 'type' => 'string', 'example' => 'Why did ECS renewal fail?', 'title' => ''], + 'Status' => [ + 'description' => 'The ticket status. Valid values: assigned (Pending response), dealing (In progress), wait\\_feedback (Waiting for feedback), feedback (Feedback received), wait\\_confirm (Pending confirmation), and confirmed (Completed).', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The description of the status. Example: Completed.', 'type' => 'string', 'example' => 'Completed', 'title' => ''], + 'Value' => ['description' => 'The value of the status. For example, a value of 6 indicates that the ticket is completed.', 'type' => 'string', 'example' => '6', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'illegal.param', 'errorMessage' => 'Params illegal', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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' => 'ListCategories', - 'summary' => 'Obtains the list data of ticket problem categories.', - ], - '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' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - '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: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\\": \\"Why did ECS renewal fail?\\",\\n \\"Status\\": {\\n \\"Label\\": \\"Completed\\",\\n \\"Value\\": \\"6\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListTickets', + 'summary' => 'Retrieves a list of your tickets.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTickets'], ], ], - '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' => 'GetMqConsumerTag', - 'summary' => 'Obtain the tag of the Message Queue for Apache RocketMQ message listener.', + 'translator' => 'manual', ], 'ReopenTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1699,42 +1040,22 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Work Order Number'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0005PYGCW', - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => 'Reply content of rework order'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecs backup fails', - ], + 'schema' => ['description' => 'The content of the reply to reopen the ticket.', 'type' => 'string', 'example' => 'The issue has not been resolved yet.', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ 'name' => 'Uid', 'in' => 'formData', - 'schema' => [ - 'description' => 'UID'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1013872004421947', - ], + 'schema' => ['description' => 'The UID.', 'type' => 'string', 'required' => false, 'example' => '1013872004421947', 'title' => ''], ], ], 'responses' => [ @@ -1742,79 +1063,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Code' => [ - 'description' => 'The return code of the request result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The data returned after the call succeeds.'."\n", - 'type' => 'string', - 'example' => '0005PYGCW', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ReopenTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], + 'Code' => ['description' => 'The return code of the API request.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned when success is false.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The business data returned after the call is successful.', 'type' => 'string', 'example' => '0005PYGCW', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID that is generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. A value of true indicates that the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], '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' => 'ReopenTicket', - 'summary' => 'Reopens a ticket', - ], - 'GetAttachmentUploadUrl' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'summary' => 'Reopens a ticket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReopenTicket'], + ], ], + 'translator' => 'manual', + ], + 'ReplyTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1825,324 +1114,141 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'FileName', + 'name' => 'TicketId', 'in' => 'formData', + 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0005PYGCW', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The content of the reply to the ticket.', 'type' => 'string', 'example' => 'OK, the renewal was successful on my end.', 'required' => true, 'docRequired' => true, 'title' => ''], + ], + [ + 'name' => 'FileNameList', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'Name of the uploaded file'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '81A0D93D-54D7-4529-ABFA-633ED63223BA.jpg', + 'description' => 'A list of attachment names. This is the ObjectKey field returned by the GetAttachmentUploadUrl operation.', + 'type' => 'array', + 'items' => ['description' => 'The ObjectKey field returned by the GetAttachmentUploadUrl operation.', 'type' => 'string', 'required' => false, 'example' => '6bc06f96-f8c1-4c00-9e30-368444fbd025.jpg,', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Encrypt', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to encrypt the content.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Uid', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID (UID).', 'type' => 'string', 'required' => false, 'example' => '1289427240739141', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Message' => [ - 'description' => 'The error message. If success is set to false, the message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ED195C2C-787F-511C-8204-714456781861', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. A value of true indicates that the call is normal.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned after the call succeeds.'."\n", - 'type' => 'object', - 'properties' => [ - 'ObjectKey' => [ - 'description' => 'Uploaded file identifier'."\n", - 'type' => 'string', - 'example' => 'cdb5d174-c282-4b2d-9048-e74ea2223127.jpg', - ], - 'PutSignedUrl' => [ - 'description' => 'The signed URL used to upload the object to OSS.'."\n", - 'type' => 'string', - 'example' => 'https://gts-workorder-pre.oss-cn-beijing.aliyuncs.com'."\n" - .'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI****************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D', - ], - 'GetSignedUrl' => [ - 'description' => 'Query the signed URL of an OSS object'."\n", - 'type' => 'string', - 'example' => 'https://gts-workorder-pre.oss-cn-beijing.aliyuncs.com'."\n" - .'/20220314/cabb80c3-430b-4079-a9f2-d2a0d1c2a587.png?Expires=1647328689&OSSAccessKeyId=LTAI****************&Signature=AbSEh26G3oYrJ8ivr4B0xzF89zk%3D', - ], - ], - ], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned when the value of Success is false.', 'type' => 'string', 'example' => 'Invalid input parameters', 'title' => ''], + 'Data' => ['description' => 'The dialog ID of the ticket reply.', 'type' => 'string', 'example' => '46434030', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C1DA4C6F-963E-5741-AB57-67A554D102FD', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The detailed information about the permission error. If you have the required permissions, an empty string is returned.', 'type' => 'string', 'example' => '{\\"AuthAction\\":\\"ram:ReplyTicket\\",\\"AuthPrincipalDisplayName\\":\\"2146216584788xxxxx\\",\\"AuthPrincipalOwnerId\\":\\"1135850448xxxxx\\",\\"AuthPrincipalType\\":\\"SubUser\\",\\"NoPermissionType\\":\\"ImplicitDeny\\",\\"PolicyType\\":\\"AccountLevelIdentityBasedPolicy\\"}', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'param.illegal', - 'errorMessage' => 'Params illegal.', - ], + ['errorCode' => 'param.illegal', 'errorMessage' => 'Params illegal.', 'description' => ''], ], [ - [ - 'errorCode' => 'illegal.auth', - 'errorMessage' => 'You are not authorized to perform the operation.', - ], + ['errorCode' => 'illegal.auth', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform this operation.'], ], 403 => [ - [ - 'errorCode' => 'No permissions', - 'errorMessage' => 'No permissions to access.', - ], + ['errorCode' => 'No permissions', 'errorMessage' => 'No permissions to access.', 'description' => 'RAM authentication does not have permission'], ], 500 => [ - [ - 'errorCode' => 'System.error', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'System.error', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request. Please try again.'], ], ], - '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' => 'GetAttachmentUploadUrl', - 'summary' => 'Queries the Object Storage Service (OSS) URL that is used to upload attachments.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"Invalid input parameters\\",\\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' => 'ReplyTicket', + 'summary' => 'Replies to a ticket. You can call the ListTicketNotes operation to retrieve the reply.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReplyTicket'], + ], + ], + 'translator' => 'manual', ], ], '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', + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.ap-northeast-1.aliyuncs.com', 'endpoint' => 'workorder.ap-northeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.ap-southeast-1.aliyuncs.com', 'endpoint' => 'workorder.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'workorder.aliyuncs.com', 'endpoint' => 'workorder.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'business.error', 'message' => 'The business does not allow the current operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'illegal.auth', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 401, 'description' => 'You are not authorized to perform this operation.'], + ['code' => 'Illegal.NeedAccessChinaSite', 'message' => 'Please visit the China site. The endpoint is workorder.aliyuncs.com.', 'http_code' => 400, 'description' => 'Please visit the china site. endpoint is workorder.aliyuncs.com.'], + ['code' => 'Illegal.NeedAccessInternationalSite', 'message' => 'Please visit the international site. The endpoint is workorder.ap-southeast-1.aliyuncs.com.', 'http_code' => 400, 'description' => 'Please visit the international site . endpoint is workorder.ap-southeast-1.aliyuncs.com.'], + ['code' => 'illegal.param', 'message' => 'Illegal param.', 'http_code' => 400, 'description' => ''], + ['code' => 'illegalParam.emailOrPhone', 'message' => 'The specified contact email or mobile phone number must be the data received by the account messenger.', 'http_code' => 400, 'description' => ''], + ['code' => 'No permissions', 'message' => 'No permissions to access.', 'http_code' => 403, 'description' => 'RAM authentication does not have permission'], + ['code' => 'NoPermission', 'message' => 'No permissions to access.', 'http_code' => 403, 'description' => 'RAM authentication does not have permission'], + ['code' => 'param.illegal', 'message' => 'The specified parameter is invalid. Please check the parameter.', 'http_code' => 401, 'description' => 'The specified parameter is invalid. Please check the parameter.'], + ['code' => 'System.error', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request. Please try again.'], + ['code' => 'Throttling.Api', 'message' => 'The request was denied due to API flow control.', 'http_code' => 429, 'description' => 'The request was denied due to API flow control.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateTicket'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTickets'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListProducts'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReopenTicket'], + ['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetTicket'], + ['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EvaluateTicket'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCategories'], + ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CloseTicket'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAttachmentUploadUrl'], + ['threshold' => '256', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTicketNotes'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMqConsumerTag'], + ['threshold' => '20', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReplyTicket'], ], ], ]; |