diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/maas | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/maas')
| -rw-r--r-- | data/en_us/maas/2026-03-18/api-docs.php | 688 |
1 files changed, 688 insertions, 0 deletions
diff --git a/data/en_us/maas/2026-03-18/api-docs.php b/data/en_us/maas/2026-03-18/api-docs.php new file mode 100644 index 0000000..e45c4e5 --- /dev/null +++ b/data/en_us/maas/2026-03-18/api-docs.php @@ -0,0 +1,688 @@ +<?php return [ + 'version' => '1.0', + 'info' => ['style' => 'ROA', 'product' => 'MaaS', 'version' => '2026-03-18'], + 'directories' => [ + [ + 'children' => ['ListWorkspaces'], + 'type' => 'directory', + 'title' => 'Workspace', + ], + [ + 'children' => ['CreateApiKey', 'UpdateApiKey', 'DeleteApiKey', 'GetApiKey', 'ListApiKeys'], + 'type' => 'directory', + 'title' => 'API key', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateApiKey' => [ + 'summary' => 'Before using large models or applications in Alibaba Cloud Model Studio, create an API key as an authentication credential.', + 'path' => '/maas/apikeys', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.'."\n" + .'> '."\n" + .'> - If you leave this parameter empty, the created API key is automatically assigned to the default workspace.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 128, 'example' => 'llm-y3kv9qctnlytgmga', 'title' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'maxLength' => 200, 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD217D2-9F5B-5CCF-96E3-AF8E5FC8496A'], + 'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'apiKey' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29', 'title' => ''], + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3291361', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-p3krn6ctp17d34e9', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => '1378030599924858', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'You are not authorized to perform this action.'], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::CreateApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => 'Create an API key', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiKey'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'maas:CreateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6BD217D2-9F5B-5CCF-96E3-AF8E5FC8496A\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true,\\n \\"apiKey\\": {\\n \\"apiKeyValue\\": \\"sk-f83898fqwer340049bae6209cbb0bc29\\",\\n \\"apiKeyId\\": 3291361,\\n \\"workspaceId\\": \\"llm-p3krn6ctp17d34e9\\",\\n \\"description\\": \\"test\\",\\n \\"creator\\": \\"1378030599924858\\",\\n \\"gmtCreate\\": 1774338222000\\n }\\n}","type":"json"}]', + ], + 'DeleteApiKey' => [ + 'path' => '/maas/apikeys/{apiKeyId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'apiKeyId', + 'in' => 'path', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '43ED6679-672D-5EB6-B3AC-E0EF90129DFF'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::DeleteApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => 'Delete an API key', + 'summary' => 'Deletes an authentication credential API key.', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiKey'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'maas:DeleteApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"200\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"43ED6679-672D-5EB6-B3AC-E0EF90129DFF\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'GetApiKey' => [ + 'path' => '/maas/apikeys/{apiKeyId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'apiKeyId', + 'in' => 'path', + 'schema' => ['description' => 'The API key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3685841', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B9650D6-68B0-55CC-845D-E8C1E5BED38B'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'apiKey' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3303332', 'title' => ''], + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-jj04jmmzqjz3hw8t', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => '1378030599924858', 'title' => ''], + 'isBlocked' => [ + 'description' => 'Indicates whether the API key is disabled.', + 'enumValueTitles' => ['active.', 'disabled.'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::GetApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => 'Retrieve a specified API key', + 'summary' => 'Retrieves information about a specified authentication API key.', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApiKey'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'maas:GetApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"200\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"9B9650D6-68B0-55CC-845D-E8C1E5BED38B\\",\\n \\"success\\": true,\\n \\"apiKey\\": {\\n \\"apiKeyId\\": 3303332,\\n \\"apiKeyValue\\": \\"sk-f83898fqwer340049bae6209cbb0bc29\\",\\n \\"gmtCreate\\": 1774338222000,\\n \\"workspaceId\\": \\"llm-jj04jmmzqjz3hw8t\\",\\n \\"description\\": \\"test\\",\\n \\"creator\\": \\"1378030599924858\\",\\n \\"isBlocked\\": 0\\n }\\n}","type":"json"}]', + ], + 'ListApiKeys' => [ + 'path' => '/maas/apikeys', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'VHayKbYhhm4=', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID for exact match filtering.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'llm-ep8ba0dr6seiddri', 'title' => ''], + ], + [ + 'name' => 'apiKeyId', + 'in' => 'query', + 'schema' => ['description' => 'The API Key ID for exact match filtering.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3685841', 'title' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for fuzzy match filtering by description.', 'type' => 'string', 'maxLength' => 200, 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B9650D6-68B0-55CC-845D-E8C1E5BED38B'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'apiKeys' => [ + 'description' => 'API Key。', + 'type' => 'array', + 'items' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3536766', 'title' => ''], + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-u6857quj723rf51z', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => '1378030599924858', 'title' => ''], + 'isBlocked' => [ + 'description' => 'Indicates whether the API Key is disabled.', + 'enumValueTitles' => ['Active.', 'Disabled.'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'nextToken' => ['description' => 'The pagination token. This parameter is empty if no more pages are available.', 'type' => 'string', 'example' => 'otqqmWigyzM=', 'title' => ''], + 'maxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'System.Error.Invoke', 'errorMessage' => 'Internal error.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Request.Illegal.Sign', 'errorMessage' => 'Sign is illegal.', 'description' => ''], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::ListApiKeys'], + 'returnType' => 'synchronous', + ], + 'title' => 'Retrieve API key list', + 'summary' => 'Retrieves a list of API Key authentication credentials.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApiKeys'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListApiKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"9B9650D6-68B0-55CC-845D-E8C1E5BED38B\\",\\n \\"success\\": true,\\n \\"apiKeys\\": [\\n {\\n \\"apiKeyId\\": 3536766,\\n \\"apiKeyValue\\": \\"sk-f83898fqwer340049bae6209cbb0bc29\\",\\n \\"gmtCreate\\": 1774338222000,\\n \\"workspaceId\\": \\"llm-u6857quj723rf51z\\",\\n \\"description\\": \\"test\\",\\n \\"creator\\": \\"1378030599924858\\",\\n \\"isBlocked\\": 0\\n }\\n ],\\n \\"nextToken\\": \\"otqqmWigyzM=\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 8\\n}","type":"json"}]', + ], + 'ListWorkspaces' => [ + 'path' => '/maas/workspaces', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token used to retrieve more results. You do not need to provide this parameter for the first query. For subsequent queries, use the token obtained from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'dzJlM0bH61zeruX+BrAt+WzHpvW5fVLYatbbFSGu3XI=', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'workspaceName', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for fuzzy match by workspace name.', 'type' => 'string', 'maxLength' => 30, 'required' => false, 'example' => 'test_ws', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The response status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'workspaces' => [ + 'description' => 'The list of workspaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'The workspace.', + 'type' => 'object', + 'properties' => [ + 'workspaceName' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'llm-34o9ts1dai60z5sf', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'regionName' => ['description' => 'The region name.', 'type' => 'string', 'example' => '华北2(北京)', 'title' => ''], + 'apiHost' => ['description' => 'API Host。', 'type' => 'string', 'example' => 'llm-34o9ts1dai60z5sf.cn-beijing.maas.aliyuncs.com', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000', 'title' => ''], + 'serviceSite' => ['description' => 'The service deployment scope. For more information, see [documentation](https://www.alibabacloud.com/help/zh/model-studio/regions/).', 'type' => 'string', 'example' => 'global', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'maxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => 'otqqmWigyzM=', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '31', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '43ED6679-672D-5EB6-B3AC-E0EF90129DFF'], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: Succeeded.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::ListWorkspaces'], + 'returnType' => 'synchronous', + ], + 'title' => 'Retrieve workspace list', + 'summary' => 'Retrieves the list of workspaces.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"200\\",\\n \\"workspaces\\": [\\n {\\n \\"workspaceName\\": \\"default\\",\\n \\"workspaceId\\": \\"llm-34o9ts1dai60z5sf\\",\\n \\"region\\": \\"cn-beijing\\",\\n \\"regionName\\": \\"华北2(北京)\\",\\n \\"apiHost\\": \\"llm-34o9ts1dai60z5sf.cn-beijing.maas.aliyuncs.com\\",\\n \\"gmtCreate\\": 1774338222000,\\n \\"serviceSite\\": \\"global\\"\\n }\\n ],\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"otqqmWigyzM=\\",\\n \\"totalCount\\": 31,\\n \\"httpStatusCode\\": 200,\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"43ED6679-672D-5EB6-B3AC-E0EF90129DFF\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'UpdateApiKey' => [ + 'summary' => 'Edits the information of an authentication credential API key.', + 'path' => '/maas/apikeys/{apiKeyId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'apiKeyId', + 'in' => 'path', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'maxLength' => 200, 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '53EAEBC0-4DEC-5AF4-AA21-3923D5A819C3'], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::UpdateApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => 'Edit API key', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApiKey'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'maas:UpdateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"53EAEBC0-4DEC-5AF4-AA21-3923D5A819C3\\",\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"httpStatusCode\\": 200,\\n \\"success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'maas.ap-southeast-1.aliyuncs.com', 'endpoint' => 'maas.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'maas.cn-beijing.aliyuncs.com', 'endpoint' => 'maas.cn-beijing.aliyuncs.com', 'vpc' => 'maas-vpc.cn-beijing.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action.', 'http_code' => 400, 'description' => 'You are not authorized to perform this action.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApiKey'], + ['description' => 'Request parameters changed', 'api' => 'DeleteApiKey'], + ['description' => 'Request parameters changed', 'api' => 'GetApiKey'], + ['description' => 'Request parameters changed', 'api' => 'UpdateApiKey'], + ], + 'createdAt' => '2026-03-26T14:20:29.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApiKey'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApiKey'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApiKey'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApiKey'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApiKeys'], + ], + ], + 'ram' => [ + 'productCode' => 'MaaS', + 'productName' => 'Alibaba Cloud Model Studio', + 'ramCodes' => ['maas'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'UpdateApiKey', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'maas:UpdateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkspaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApiKey', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'maas:GetApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApiKeys', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListApiKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApiKey', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'maas:DeleteApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApiKey', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'maas:CreateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [], + ], +]; |
