創建一個應用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ram:CreateApplication | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DisplayName | string | 是 | 應用的顯示名稱。 最大長度為 24 個字符。 | myapp |
AppType | string | 是 | 應用類型。取值:
| WebApp |
RedirectUris | string | 否 | 回調地址。 輸入多個時,以英文分號(;)分隔。 | https://www.example.com |
SecretRequired | boolean | 否 | 是否需要應用密鑰。取值:
說明
| true |
AccessTokenValidity | integer | 否 | 訪問令牌有效期。 取值范圍:900~10800。單位:秒。 默認值:3600。 | 3600 |
RefreshTokenValidity | integer | 否 | 刷新令牌有效期。 取值范圍:7200~31536000。單位:秒。 默認值:
| 2592000 |
PredefinedScopes | string | 否 | 應用權限范圍。 關于應用權限范圍的取值和描述,請參見 OAuth 范圍。您也可以調用 ListPredefinedScopes 獲取不同應用類型支持的應用權限范圍。 輸入多個應用權限范圍時,以英文分號(;)分隔。 | aliuid;profile |
RequiredScopes | string | 否 | 必選的應用權限范圍。 您可以將 輸入多個應用權限范圍時,以英文分號(;)分隔。 說明
如果您設置的 RequiredScopes 項不在PredefinedScopes 的范圍內,則該項必選范圍不生效。
| aliuid |
IsMultiTenant | boolean | 否 | 是否允許被其他賬號安裝。取值:
| false |
AppName | string | 是 | 應用名稱。 最大長度為 64 個字符,允許輸入英文字母、數字、英文句點(.)、下劃線(_)或中劃線(-)。 | myapp |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "6616F09B-2768-4C11-8866-A8EE4C4A583E",
"Application": {
"DisplayName": "myapp",
"AccessTokenValidity": 3600,
"SecretRequired": true,
"AccountId": "177242285274****",
"CreateDate": "2020-10-23T08:06:57Z",
"AppName": "myapp",
"RedirectUris": {
"RedirectUri": [
"https://www.example.com"
]
},
"UpdateDate": "2020-10-23T08:06:57Z",
"DelegatedScope": {
"PredefinedScopes": {
"PredefinedScope": [
{
"Description": "用于獲取用戶的OpenID(默認權限范圍,不可移除)",
"Required": true,
"Name": "openid"
}
]
}
},
"AppId": "472457090344041****",
"RefreshTokenValidity": 7776000,
"IsMultiTenant": true,
"AppType": "WebApp"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-14 | OpenAPI 描述信息更新 | 查看變更詳情 |
2023-11-23 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |