修改API MCP服務。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
openapiexplorer:UpdateApiMcpServer |
update |
*ApiMcpServer
|
無 | 無 |
請求文法
PATCH /apimcpserver HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| clientToken |
string |
否 |
保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元,建議使用 UUID。到期時間為 3 天。 |
123e4567-e89b-12d3-a456-426655440000 |
| id |
string |
是 |
API MCP 服務的 ID。 |
v6ZZ7ftCzEILW*** |
| body |
object |
否 |
請求 body。 |
|
| description |
string |
否 |
API MCP 伺服器描述資訊。 |
這是一個API MCP伺服器。 |
| apis |
array<object> |
否 |
修改的 API 列表。 |
|
|
object |
否 |
API 資訊。 |
||
| product |
string |
否 |
產品 CODE。
|
Ecs |
| apiVersion |
string |
否 |
透出到 MCP SERVER 的 API 所屬的 POP version。 |
2014-05-26 |
| selectors |
array |
否 |
API 名稱匹配規則列表。 |
|
|
string |
否 |
API 名稱匹配規則。 |
*Bucket |
|
| additionalApiDescriptions |
array<object> |
否 |
補充的 API 描述資訊列表。 |
|
|
array<object> |
否 |
補充 API 的描述資訊。 |
||
| product |
string |
否 |
產品 CODE。
|
Ecs |
| apiVersion |
string |
否 |
透出到 MCP SERVER 的 API 所屬的 POP version。 |
2014-05-26 |
| apiName |
string |
否 |
API 名稱。 |
DescribeRegions |
| apiOverrideJson |
string |
否 |
API 中繼資料 JSON 格式,參考格式 https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json,支援覆蓋其中的 summary、parameters。 |
{ "summary": "本介面支援根據不同請求條件查詢執行個體列表,並關聯查詢執行個體的詳細資料。" } |
| executeCliCommand |
boolean |
否 |
是否返回 CLI 的執行命令,這個模式下,不真實執行 API 呼叫,返回對應的 CLI 命令,適用於長耗時的任務,需要搭配使用阿里雲 CLI 執行。 |
true |
| enableOutputSchema |
boolean |
否 |
是否返回出參的 schema,返回出參 schema 時會增加整個 API MCP SERVER 的體積。預設值為 null,表示不返回出參的 schema。 |
true |
| constParameters |
array<object> |
否 |
常量入參列表,在 API 參數解析時,不再輸出這部分參數。 |
|
|
object |
否 |
常量入參。 |
||
| key |
string |
否 |
參數名稱。僅支援一級參數名稱,對於 ROA 風格的 API,支援設定到 body.xx,不允許設定超出頂級參數的值。 |
InstanceId |
| value |
any |
否 |
參數的值。 |
1234 |
| prompts |
array<object> |
否 |
prompt 配置列表。 |
|
|
array<object> |
否 |
prompt 配置。 |
||
| name |
string |
否 |
prompt 名稱。 |
test |
| description |
string |
否 |
描述資訊。 |
prompt description |
| content |
string |
否 |
prompt 的內容資訊,其變數通過 {{xxx}} 格式指定。xxx 為變數,需要從 arguments 參數中定義。 |
prompt本文,{{name}} |
| arguments |
array<object> |
否 |
prompt 支援的參數列表。 |
|
|
object |
否 |
prompt 支援的參數。 |
||
| name |
string |
否 |
參數名稱。 |
test |
| description |
string |
否 |
參數的描述資訊。 |
argument description |
| required |
boolean |
否 |
該參數是否必填。 |
true |
| language |
string |
否 |
API MCP 服務的文檔語言。支援選擇中文或英文 API 文檔,不同的語言提示詞對 AI 的回複效果可能產生差異。 |
ZH_CN |
| systemTools |
array |
否 |
系統工具列表。 |
|
|
string |
否 |
系統工具名稱 |
FetchRamActionDetails |
|
| oauthClientId |
string |
否 |
選擇自訂 OAuth 配置時的自訂 OAuth Client ID。
|
403*************370 |
| instructions |
string |
否 |
MCP 指令,用於提示大模型如何使用該 MCP,需要用戶端支援 MCP 標準協議的 Instructions 欄位。 |
test |
| enableAssumeRole |
boolean |
否 |
是否開啟多帳號訪問。 |
true |
| assumeRoleName |
string |
否 |
開啟多帳號訪問進行跨帳號操作時,扮演的目標帳號 RAM 角色名稱。 |
test |
| assumeRoleExtraPolicy |
string |
否 |
開啟多帳號訪問時,角色扮演額外的策略,該策略存在時,角色扮演的許可權以當前值為準,覆蓋角色本身的許可權定義。 |
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe*", "vpc:Describe*", "vpc:List*" ], "Resource": "*" } ] } |
| publicAccess |
string |
否 |
是否開啟公網。 |
on |
| enableCustomVpcWhitelist |
boolean |
否 |
是否開啟自訂 VPC 白名單,不開啟則跟隨賬戶層級的配置。 |
true |
| terraformTools |
array<object> |
否 |
Terraform Tool 列表。 |
|
|
object |
否 |
Terraform Tool。 |
||
| code |
string |
否 |
Terraform Tool 代碼。HCL 語言概述 |
variable "name" { default = "terraform-example" } provider "alicloud" { region = "cn-beijing" } resource "alicloud_vpc" "default" { ipv6_isp = "BGP" description = "test" cidr_block = "10.0.0.0/8" vpc_name = var.name enable_ipv6 = true } |
| name |
string |
否 |
Terraform Tool 名稱。 |
test |
| description |
string |
否 |
Terraform Tool 描述資訊。 |
Terraform Tool description |
| async |
boolean |
否 |
是否為非同步執行,即發起一個任務執行之後會立即處理下一個任務,而不等待每個資源操作完成。 |
true |
| destroyPolicy |
string |
否 |
刪除策略,任務執行完成後,系統根據任務執行狀態對臨時資源採取以下清理策略。
|
ON_FAILURE |
| vpcWhitelists |
array |
否 |
關閉公網訪問後,限定來源的 VPC 白名單,不設定或為空白表示不限制來源。 |
|
|
string |
否 |
每一個限定的 VPC 白名單,值為來源 VPC ID。 |
vpc-j6cgd2if5lg**0xs6m5se |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
請求結果。 |
||
| requestId |
string |
請求 ID |
9BFC4AC1-6BE4-5405-BDEC-CA288D404812 |
樣本
正常返回樣本
JSON格式
{
"requestId": "\t\n9BFC4AC1-6BE4-5405-BDEC-CA288D404812\n"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Missing.Id | Id is mandatory for this action. | 缺少必填參數Id。 |
| 400 | Missing.Apis.PopCode | Apis.PopCode is mandatory for this action. | Apis參數中缺少必填參數popCode。 |
| 400 | Missing.Apis.PopVersion | Apis.PopVersion is mandatory for this action. | 缺少必填參數Apis.PopVersion。 |
| 400 | InvalidParam.Apis.PopVersion | Unsupported product version: %s of product code: %s. | 產品%s不支援%s版本。 |
| 400 | InvalidParam.Apis.PopCode | Unsupported product code: %s. | 指定的產品名稱不存在。 |
| 400 | Missing.Apis.Selectors | Apis.Selectors is mandatory for this action. | Apis.Selectors是必填參數 |
| 400 | InvalidParam.Language | Unsupported language: %s. | 指定多語言無效。 |
| 400 | InvalidParam.AdditionalApiDescription.PopVersion | Unsupported product version: %s of product code: %s. | 產品%s不支援%s版本。 |
| 400 | InvalidParam.AdditionalApiDescription.PopCode | Unsupported product code: %s. | 指定的產品名稱不存在 |
| 400 | InvalidParam.SystemTools | System tool %s is not supported. | 指定的系統工具無效。 |
| 400 | Missing.TerraformTools.Description | TerraformTools.Description is mandatory for this action. | 缺少必填參數TerraformTools.Description |
| 400 | Missing.TerraformTools.Code | TerraformTools.Code is mandatory for this action. | 缺少必填參數TerraformTools.Code。 |
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous request but with different parameters. Client tokens should not be reused across non-identical requests. Each unique request must have a distinct client token. | 請求使用了與之前請求相同的用戶端令牌,但參數不同。請勿在參數不同的請求中重複使用同一令牌,每個獨立請求必須使用唯一的令牌。 |
| 400 | InvalidParam.TerraformTools.Name | TerraformTools.Name: %s must be 3 to 64 characters long and can only contain lowercase letters, numbers, underscores, and hyphens. | Terraform工具名稱長度必須為 3 到 63 個字元,並且只能包含小寫字母、數字、底線和連字號。 |
| 400 | Missing.TerraformTools.Name | TerraformTools.Name is mandatory for this action. | Terraform工具名稱是必填參數。 |
| 400 | InvalidParam.TerraformTools.Code | The Terraform tool code is not valid: %s. Please check the syntax and try again. | 指定的TerraformTools.Code參數無效。 |
| 400 | InvalidParam.ClientToken | The specified client token is not valid. | 該等冪參數有誤,請檢查。 |
| 403 | OperationNotAllowed.SystemServer | System type servers are not allowed to be updated or deleted. | 系統層級的服務不允許更新或刪除操作。 |
| 404 | NotFound.ApiMcpServer | Specified MCP server not found. | 指定id的MCP服務不存在。 |
| 409 | Exists.TerraformTools.Name | The Terraform tool name already exists. | 指定的Terraform 工具名稱已經存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。