diff options
Diffstat (limited to 'data/zh_cn/maas/2026-03-18')
| -rw-r--r-- | data/zh_cn/maas/2026-03-18/api-docs.php | 670 |
1 files changed, 670 insertions, 0 deletions
diff --git a/data/zh_cn/maas/2026-03-18/api-docs.php b/data/zh_cn/maas/2026-03-18/api-docs.php new file mode 100644 index 0000000..0d4611c --- /dev/null +++ b/data/zh_cn/maas/2026-03-18/api-docs.php @@ -0,0 +1,670 @@ +<?php return [ + 'version' => '1.0', + 'info' => ['style' => 'ROA', 'product' => 'MaaS', 'version' => '2026-03-18'], + 'directories' => [ + [ + 'children' => ['ListWorkspaces'], + 'type' => 'directory', + 'title' => '业务空间', + 'id' => 434276, + ], + [ + 'children' => ['CreateApiKey', 'UpdateApiKey', 'DeleteApiKey', 'GetApiKey', 'ListApiKeys'], + 'type' => 'directory', + 'title' => 'API Key', + 'id' => 434282, + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateApiKey' => [ + 'summary' => '使用阿里云百炼的大模型或应用前，请先创建 API Key 作为鉴权凭证。', + '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' => '业务空间 ID。'."\n" + .'> '."\n" + .'> - 若不填写时，创建的API Key会自动归属于默认业务空间。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'llm-y3kv9qctnlytgmga', 'maxLength' => 128], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 200], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6BD217D2-9F5B-5CCF-96E3-AF8E5FC8496A'], + 'code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'apiKey' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29'], + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3291361'], + 'workspaceId' => ['description' => '业务空间 ID。', 'type' => 'string', 'example' => 'llm-p3krn6ctp17d34e9'], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'], + 'creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '1378030599924858'], + 'gmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000'], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '无权限进行操作。'], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::CreateApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => '创建 API Key', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => '请求参数发生变更'], + ], + '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' => '全部资源', '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' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'], + 'httpStatusCode' => ['description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '43ED6679-672D-5EB6-B3AC-E0EF90129DFF'], + 'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::DeleteApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => '删除 API Key', + 'summary' => '删除鉴权凭证 API Key。', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => '请求参数发生变更'], + ], + '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' => '全部资源', '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' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3685841'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B9650D6-68B0-55CC-845D-E8C1E5BED38B'], + 'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'apiKey' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3303332'], + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29'], + 'gmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000'], + 'workspaceId' => ['description' => '业务空间 ID。', 'type' => 'string', 'example' => 'llm-jj04jmmzqjz3hw8t'], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'], + 'creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '1378030599924858'], + 'isBlocked' => [ + 'description' => '是否禁用。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['生效中', '已禁用'], + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::GetApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => '获取指定的 API Key', + 'summary' => '获取指定的鉴权凭证 API Key 信息。', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => '请求参数发生变更'], + ], + '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' => '全部资源', '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' => '分页Token', 'type' => 'string', 'required' => false, 'example' => 'VHayKbYhhm4='], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => '按业务空间 ID 进行精确检索。', 'type' => 'string', 'required' => false, 'example' => 'llm-ep8ba0dr6seiddri', 'maxLength' => 64], + ], + [ + 'name' => 'apiKeyId', + 'in' => 'query', + 'schema' => ['description' => '按 API Key ID 进行精确检索。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3685841'], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => '按描述进行关键字模糊检索。', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 200], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'success'], + 'httpStatusCode' => ['description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9B9650D6-68B0-55CC-845D-E8C1E5BED38B'], + 'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'apiKeys' => [ + 'description' => 'API Key。', + 'type' => 'array', + 'items' => [ + 'description' => 'API Key。', + 'type' => 'object', + 'properties' => [ + 'apiKeyId' => ['description' => 'API Key ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3536766'], + 'apiKeyValue' => ['description' => 'API Key Value。', 'type' => 'string', 'example' => 'sk-f83898fqwer340049bae6209cbb0bc29'], + 'gmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000'], + 'workspaceId' => ['description' => '业务空间 ID。', 'type' => 'string', 'example' => 'llm-u6857quj723rf51z'], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'], + 'creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '1378030599924858'], + 'isBlocked' => [ + 'description' => '是否禁用。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => ['生效中', '已禁用'], + 'example' => '0', + ], + ], + ], + ], + 'nextToken' => ['description' => '分页Token，没有下一页则为空', 'type' => 'string', 'example' => 'otqqmWigyzM='], + 'maxResults' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + ], + ], + ], + ], + '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' => '获取 API Key 列表', + 'summary' => '获取鉴权凭证 API Key 信息列表。', + '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' => '全部资源', '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' => '用来返回更多结果。第一次查询不需要提供这个参数，后续查询所需使用的Token，从返回结果中获取。', 'type' => 'string', 'required' => false, 'example' => 'dzJlM0bH61zeruX+BrAt+WzHpvW5fVLYatbbFSGu3XI='], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'workspaceName', + 'in' => 'query', + 'schema' => ['description' => '按业务空间名称进行关键字模糊检索。', 'type' => 'string', 'required' => false, 'example' => 'test_ws', 'maxLength' => 30], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => '响应状态码。', 'type' => 'string', 'example' => '200'], + 'workspaces' => [ + 'description' => '业务空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '业务空间。', + 'type' => 'object', + 'properties' => [ + 'workspaceName' => ['description' => '业务空间名称。', 'type' => 'string', 'example' => 'default'], + 'workspaceId' => ['description' => '业务空间 ID。', 'type' => 'string', 'example' => 'llm-34o9ts1dai60z5sf'], + 'region' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-beijing'], + 'regionName' => ['description' => '地域名称。', 'type' => 'string', 'example' => '华北2（北京）'], + 'apiHost' => ['description' => 'API Host。', 'type' => 'string', 'example' => 'llm-34o9ts1dai60z5sf.cn-beijing.maas.aliyuncs.com'], + 'gmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1774338222000'], + 'serviceSite' => ['description' => '服务部署范围，详情请 [查看文档](https://www.alibabacloud.com/help/zh/model-studio/regions/)。', 'type' => 'string', 'example' => 'global'], + ], + ], + ], + 'maxResults' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'nextToken' => ['description' => '下一次请求的分页 token。', 'type' => 'string', 'example' => 'otqqmWigyzM='], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '31'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '43ED6679-672D-5EB6-B3AC-E0EF90129DFF'], + 'success' => ['description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::ListWorkspaces'], + 'returnType' => 'synchronous', + ], + 'title' => '获取业务空间列表', + 'summary' => '获取业务空间列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', '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' => '编辑鉴权凭证 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' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 200], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '53EAEBC0-4DEC-5AF4-AA21-3923D5A819C3'], + 'code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'], + 'message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'success'], + 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'success' => ['description' => '请求是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + ."\n" + .'- false：失败', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['ModelStudio::2026-02-10::UpdateApiKey'], + 'returnType' => 'synchronous', + ], + 'title' => '编辑 API Key', + 'changeSet' => [ + ['createdAt' => '2026-03-26T14:20:23.000Z', 'description' => '请求参数发生变更'], + ], + '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' => '全部资源', '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'maas.ap-southeast-1.aliyuncs.com', 'endpoint' => 'maas.ap-southeast-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '无权限进行操作。'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateApiKey'], + ['description' => '请求参数发生变更', 'api' => 'DeleteApiKey'], + ['description' => '请求参数发生变更', 'api' => 'GetApiKey'], + ['description' => '请求参数发生变更', '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' => '大模型服务平台百炼', + 'ramCodes' => ['maas'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'UpdateApiKey', + 'description' => '编辑 API Key', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'maas:UpdateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkspaces', + 'description' => '获取业务空间列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApiKey', + 'description' => '获取指定的 API Key', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'maas:GetApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApiKeys', + 'description' => '获取 API Key 列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'maas:ListApiKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApiKey', + 'description' => '删除 API Key', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'maas:DeleteApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApiKey', + 'description' => '创建 API Key', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'maas:CreateApiKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'MaaS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [], + ], +]; |