'1.0', 'info' => ['style' => 'RPC', 'product' => 'OnsMqtt', 'version' => '2019-12-11'], 'directories' => [ [ 'id' => 66368, 'title' => null, 'type' => 'directory', 'children' => ['SendMessage'], ], [ 'id' => 66371, 'title' => null, 'type' => 'directory', 'children' => ['CreateGroupId', 'DeleteGroupId', 'ListGroupId'], ], [ 'id' => 66375, 'title' => null, 'type' => 'directory', 'children' => ['QuerySessionByClientId', 'BatchQuerySessionByClientIds'], ], [ 'id' => 66378, 'title' => null, 'type' => 'directory', 'children' => ['QueryToken', 'ApplyToken', 'RevokeToken'], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'SendMessage' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'MqttTopic', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Payload', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ReceiptId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'default' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MsgId' => ['type' => 'string'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SendMessageFailed', 'errorMessage' => 'A storage exception occurred while sending the message. Please try again.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'CreateGroupId' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'GroupIdAlreadyExsited', 'errorMessage' => 'The specified GroupId already exists.'], ['errorCode' => 'GroupIdAlreadyUsedByOtherUsers', 'errorMessage' => 'The current GroupId is used by another user. Please change to a different GroupId.'], ['errorCode' => 'ParameterFieldCheckFailed', 'errorMessage' => 'Failed to validate the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'Failed to find the instance. The instanceId may be invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ], 500 => [ ['errorCode' => 'CreateGroupIdError', 'errorMessage' => 'Failed to create GroupId. Try again later.'], ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'DeleteGroupId' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ParameterFieldCheckFailed', 'errorMessage' => 'Failed to validate the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'Failed to find the instance. The instanceId may be invalid.'], ['errorCode' => 'ResourcePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ], 500 => [ ['errorCode' => 'DeleteGroupIdError', 'errorMessage' => 'Failed to delete GroupId. Try again later.'], ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'ListGroupId' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'UpdateTime' => ['type' => 'integer', 'format' => 'int64'], 'IndependentNaming' => ['type' => 'boolean'], 'InstanceId' => ['type' => 'string'], 'GroupId' => ['type' => 'string'], 'CreateTime' => ['type' => 'integer', 'format' => 'int64'], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ParameterFieldCheckFailed', 'errorMessage' => 'Failed to validate the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'Failed to find the instance. The instanceId may be invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'QuerySessionByClientId' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ClientId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OnlineStatus' => ['type' => 'boolean'], 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'BatchQuerySessionByClientIds' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ClientIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string'], 'required' => true, 'maxItems' => 10, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], 'OnlineStatusList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OnlineStatus' => ['type' => 'boolean'], 'ClientId' => ['type' => 'string'], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'QueryToken' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], 'TokenStatus' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'QueryTokenOverFlow', 'errorMessage' => 'You have queried tokens too many times. Please try again later.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'ApplyToken' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'Resources', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ExpireTime', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Actions', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], 'Token' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ApplyTokenOverFlow', 'errorMessage' => 'You have applied for tokens too many times. Please try again later.'], ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], 'RevokeToken' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'CheckAccountInfoFailed', 'errorMessage' => 'An error occurred while checking the account information by the STS token.'], ['errorCode' => 'InstancePermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.'], ['errorCode' => 'ParameterCheckFailed', 'errorMessage' => 'An error occurred while validating the parameters. The parameters may be missing or invalid.'], ['errorCode' => 'PermissionCheckFailed', 'errorMessage' => 'An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.'], ['errorCode' => 'RevokeTokenOverFlow', 'errorMessage' => 'You have revoked tokens too many times. Please try again later.'], ['errorCode' => 'InvalidParameter.%s', 'errorMessage' => 'An error occurred while validating the parameter. The parameter may be missing or invalid.'], ], 404 => [ ['errorCode' => 'ApiNotSupport', 'errorMessage' => 'The specified API is not supported.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Try again later.'], ['errorCode' => 'SystemOverFlow', 'errorMessage' => 'An error occurred while processing your request. Please try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => null, ], ], 'endpoints' => [ ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'onsmqtt.cn-shanghai-finance-1.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'endpoint' => 'onsmqtt.cn-qingdao.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'endpoint' => 'onsmqtt.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'onsmqtt.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'ap-southeast-6', 'endpoint' => 'onsmqtt.ap-southeast-6.aliyuncs.com'], ['regionId' => 'eu-central-1', 'endpoint' => 'onsmqtt.eu-central-1.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'onsmqtt.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'endpoint' => 'onsmqtt.cn-shenzhen.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'endpoint' => 'onsmqtt.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'endpoint' => 'onsmqtt.cn-hangzhou.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'endpoint' => 'onsmqtt.ap-northeast-1.aliyuncs.com'], ['regionId' => 'me-central-1', 'endpoint' => 'onsmqtt.me-central-1.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'endpoint' => 'onsmqtt.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'onsmqtt.cn-heyuan-acdr-1.aliyuncs.com'], ['regionId' => 'mq-internet-access', 'endpoint' => 'onsmqtt.mq-internet-access.aliyuncs.com'], ['regionId' => 'cn-beijing', 'endpoint' => 'onsmqtt.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'endpoint' => 'onsmqtt.cn-huhehaote.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'endpoint' => 'onsmqtt.cn-chengdu.aliyuncs.com'], ['regionId' => 'us-east-1', 'endpoint' => 'onsmqtt.us-east-1.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'endpoint' => 'onsmqtt.cn-hongkong.aliyuncs.com'], ['regionId' => 'eu-west-1', 'endpoint' => 'onsmqtt.eu-west-1.aliyuncs.com'], ['regionId' => 'cn-wulanchabu', 'endpoint' => 'onsmqtt.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'us-west-1', 'endpoint' => 'onsmqtt.us-west-1.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'endpoint' => 'onsmqtt.ap-southeast-1.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'endpoint' => 'onsmqtt.cn-guangzhou.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'onsmqtt.cn-hangzhou-finance.aliyuncs.com'], ], ];