API標準及多語言預置SDK
本產品(Ims/2019-08-15)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
使用者管理
|
API |
標題 |
API概述 |
| 使用者 | 使用者 | |
| CreateUser | 建立RAM使用者 | 建立RAM使用者。 |
| GetUser | 查詢RAM使用者的詳細資料 | 查詢指定的RAM使用者的詳細資料。 |
| UpdateUser | 修改RAM使用者資訊 | 調用UpdateUser修改RAM使用者資訊。 |
| DeleteUser | 刪除RAM使用者 | 刪除指定的RAM使用者。 |
| ListUsers | 查詢所有RAM使用者的詳細資料 | 查詢所有RAM使用者的詳細資料。 |
| ListUserBasicInfos | 查詢所有RAM使用者的基本資料 | 調用ListUserBasicInfos查詢所有RAM使用者的基本資料。 |
| GetAccountSummary | 查詢主帳號概覽資訊 | 查詢阿里雲帳號(主帳號)的概覽資訊。 |
| 登入資訊 | 登入資訊 | |
| CreateLoginProfile | 開啟指定RAM使用者的控制台登入 | 為RAM使用者建立登入配置。 |
| GetLoginProfile | 查詢指定RAM使用者的登入資訊 | 查詢指定RAM使用者的登入資訊。 |
| UpdateLoginProfile | 修改RAM使用者的控制台登入資訊 | 修改指定RAM使用者的控制台登入資訊。 |
| DeleteLoginProfile | 關閉指定RAM使用者的控制台登入 | 刪除RAM使用者的控制台登入配置。 |
| ChangePassword | RAM使用者修改自己的登入密碼 | RAM使用者為自己修改控制台登入密碼。 |
| 存取金鑰 | 存取金鑰 | |
| CreateAccessKey | 建立主帳號或RAM使用者存取金鑰 | 建立阿里雲帳號(主帳號)或RAM使用者的存取金鑰。 |
| DeleteAccessKey | 刪除使用者的存取金鑰 | 刪除阿里雲帳號(主帳號)或RAM使用者的存取金鑰。 |
| UpdateAccessKey | 修改存取金鑰狀態 | 修改阿里雲帳號(主帳號)或RAM使用者的存取金鑰狀態。 |
| GetAccessKeyLastUsed | 查詢指定存取金鑰的最後使用時間 | 查詢某個指定存取金鑰的最後使用時間。 |
| ListAccessKeys | 查詢主帳號或RAM使用者存取金鑰列表 | 查詢阿里雲帳號(主帳號)或RAM使用者的存取金鑰列表。 |
| 多因素認證 | 多因素認證 | |
| GetVerificationInfo | 擷取使用者手機郵箱的安全認證資訊 | 查詢RAM使用者的安全手機或安全郵箱狀態。 |
| CreateVirtualMFADevice | 建立多因素認證裝置 | 建立一個虛擬多因素認證裝置。 |
| ListVirtualMFADevices | 查詢多因素認證裝置列表 | 查詢多因素認證裝置列表。 |
| DeleteVirtualMFADevice | 刪除多因素認證裝置 | 刪除指定的多因素認證裝置。 |
| DisableVirtualMFA | 解除綁定並刪除多因素認證裝置 | 解除綁定並刪除一個指定RAM使用者的多因素認證裝置。 |
| BindMFADevice | 為RAM使用者綁定多因素認證裝置 | 為RAM使用者綁定指定的多因素認證裝置。 |
| UnbindMFADevice | 為RAM使用者解除綁定多因素認證裝置 | 為RAM使用者解除綁定定多因素認證裝置。 |
| GetAccountMFAInfo | 查詢主帳號多因素認證裝置資訊 | 查詢阿里雲帳號(主帳號)的多因素認證裝置資訊。 |
| GetUserMFAInfo | 查詢RAM使用者多因素認證裝置資訊 | 查詢指定RAM使用者的多因素認證裝置資訊。 |
| SetVerificationInfo | 為RAM使用者綁定安全手機或安全郵箱 | 為RAM使用者綁定安全手機或安全郵箱。 |
| UnbindVerification | 為RAM使用者解除綁定安全手機或安全郵箱 | 為RAM使用者解除綁定安全手機或安全郵箱。 |
| 標籤 | 標籤 | |
| TagResources | 資源打上標籤 | 調用TagResources介面給資源打上標籤。 |
| UntagResources | 解除綁定資源的標籤 | 調用UntagResources介面解除綁定資源的標籤。 |
| ListTagResources | 查詢資源與標籤的關係 | 調用ListTagResources查詢資源與標籤的關係。 |
| 通行密鑰 | 通行密鑰 | |
| UpdatePasskey | 更新通行密鑰 | 更新通行密鑰。 |
| ListPasskeys | 查看使用者綁定的通行密鑰 | 查詢使用者綁定的通行密鑰資訊。 |
| DeletePasskey | 刪除通行密鑰 | 刪除使用者的通行密鑰。 |
| 資源回收筒 | 資源回收筒 | |
| ListUsersInRecycleBin | 查詢資源回收筒中的所有RAM使用者 | 查詢資源回收筒中的所有RAM使用者的基本資料。 |
| GetUserInRecycleBin | 查詢資源回收筒中的RAM使用者 | 查詢資源回收筒中的指定RAM使用者資訊。 |
| DeleteUserInRecycleBin | 刪除資源回收筒中的RAM使用者 | 刪除資源回收筒中的指定RAM使用者。 |
| RestoreUserFromRecycleBin | 從資源回收筒中恢複RAM使用者 | 從資源回收筒中恢複指定RAM使用者。 |
| ListAccessKeysInRecycleBin | 查詢資源回收筒中的存取金鑰列表 | 查詢資源回收筒中的指定RAM使用者的存取金鑰列表。 |
| GetAccessKeyInfoInRecycleBin | 查詢資源回收筒中的存取金鑰 | 查詢資源回收筒中的歸屬於RAM使用者的指定存取金鑰資訊。 |
| DeleteAccessKeyInRecycleBin | 刪除資源回收筒中的存取金鑰 | 刪除資源回收筒中歸屬於指定RAM使用者的指定存取金鑰。 |
| RestoreAccessKeyFromRecycleBin | 從資源回收筒中恢複存取金鑰 | 從資源回收筒中恢複歸屬於指定RAM使用者的指定存取金鑰。 |
使用者群組管理
|
API |
標題 |
API概述 |
| CreateGroup | 建立使用者組 | 建立一個使用者組。 |
| GetGroup | 查詢指定使用者組資訊 | 查詢指定的使用者組資訊。 |
| UpdateGroup | 修改指定使用者組的資訊 | 修改指定使用者組的基礎資訊。 |
| DeleteGroup | 刪除指定的使用者組 | 刪除一個指定的使用者組。 |
| ListGroups | 查詢使用者組列表 | 列出使用者組的資訊列表。 |
| AddUserToGroup | 將RAM使用者添加到指定的使用者組 | 將指定的RAM使用者添加到指定的使用者組。 |
| RemoveUserFromGroup | 將RAM使用者從使用者組中移除 | 將指定RAM使用者從指定使用者組中移除。 |
| ListUsersForGroup | 查詢使用者組內的RAM使用者列表 | 查詢指定使用者組內的RAM使用者列表。 |
| ListGroupsForUser | 查詢RAM使用者加入的使用者組列表 | 查詢指定的RAM使用者加入的組的列表。 |
單點登入(SSO)管理
|
API |
標題 |
API概述 |
| SetUserSsoSettings | 設定使用者SSO身份供應商資訊 | 設定使用者SSO的身份供應商資訊。 |
| GetUserSsoSettings | 查詢使用者SSO身份供應商資訊 | 查詢使用者SSO身份供應商配置資訊。 |
| CreateSAMLProvider | 建立角色SSO身份供應商 | 建立一個角色SSO的身份供應商配置。 |
| DeleteSAMLProvider | 刪除指定的角色SSO身份供應商 | 刪除一個角色SSO的身份供應商配置。 |
| UpdateSAMLProvider | 修改角色SSO身份供應商資訊 | 修改指定的角色SSO身份供應商資訊。 |
| GetSAMLProvider | 查詢角色SSO身份供應商資訊 | 查詢指定的角色SSO身份供應商資訊。 |
| ListSAMLProviders | 查詢角色SSO身份供應商列表 | 查詢所有角色SSO身份供應商資訊。 |
| CreateOIDCProvider | 建立OIDC身份供應商 | 調用CreateOIDCProvider建立OIDC身份供應商,配置阿里雲與外部身份供應商(IdP)的信任關係。 |
| GetOIDCProvider | 查詢OIDC身份供應商資訊 | 調用GetOIDCProvider查詢OIDC身份供應商資訊。 |
| UpdateOIDCProvider | 修改OIDC身份供應商 | 調用UpdateOIDCProvider修改OIDC身份供應商的描述和用戶端ID。 |
| ListOIDCProviders | 查詢OIDC身份供應商列表 | 調用ListOIDCProviders查詢OIDC身份供應商列表。 |
| DeleteOIDCProvider | 刪除OIDC身份供應商 | 調用DeleteOIDCProvider刪除OIDC身份供應商。 |
| AddClientIdToOIDCProvider | 為OIDC身分提供商添加指定用戶端ID | 呼叫AddClientIdToOIDCProvider為OIDC身分提供商添加指定用戶端ID。 |
| RemoveClientIdFromOIDCProvider | 移除OIDC身份供應商中的指定用戶端ID | 調用RemoveClientIdFromOIDCProvider移除OIDC身份供應商中的指定用戶端ID。 |
| AddFingerprintToOIDCProvider | 為OIDC身份供應商添加驗證指紋 | 調用AddFingerprintToOIDCProvider為OIDC身份供應商添加驗證指紋。 |
| RemoveFingerprintFromOIDCProvider | 移除OIDC身份供應商中指定的驗證指紋 | 調用RemoveFingerprintFromOIDCProvider移除OIDC身份供應商中指定的驗證指紋。 |
開放授權(OAuth)管理
|
API |
標題 |
API概述 |
| CreateApplication | 建立應用 | 建立一個應用。 |
| GetApplication | 查詢應用的配置資訊 | 查詢指定應用的配置資訊。 |
| UpdateApplication | 修改應用的配置資訊 | 修改指定應用的配置資訊。 |
| DeleteApplication | 刪除一個應用 | 刪除指定的應用。 |
| ListApplications | 查詢應用列表 | 列出建立的應用列表。 |
| ListPredefinedScopes | 查詢系統預設的Scope列表 | 列出系統預定義的應用許可權範圍列表。 |
| CreateAppSecret | 為指定的應用建立應用密鑰 | 為指定的應用建立一個應用密鑰。 |
| GetAppSecret | 查詢指定應用密鑰資訊 | 查詢指定應用的密鑰資訊。 |
| ListAppSecretIds | 查詢指定應用的應用密鑰ID列表 | 列出指定應用的應用密鑰資訊列表。 |
| DeleteAppSecret | 刪除指定應用的應用密鑰 | 刪除指定的應用密鑰。 |
| ProvisionApplication | 安裝應用 | 安裝應用。 |
| DeprovisionApplication | 卸載已安裝的應用 | 卸載已安裝的外部應用,或內部應用中的ServerApp類型應用。 |
| ListApplicationProvisionInfos | 查詢所有已安裝應用的安裝資訊 | 查詢所有已安裝應用的安裝資訊。 |
| GetApplicationProvisionInfo | 查詢應用安裝資訊 | 查詢指定的已安裝應用的安裝資訊。 |
| ProvisionExternalApplication | 安裝外部應用 | 安裝外部應用。 |
| DeprovisionExternalApplication | 卸載已安裝的外部應用 | 卸載已安裝的外部應用。 |
| ListExternalApplications | 查詢所有已安裝的外部應用 | 查詢所有已安裝的外部應用的資訊。 |
| GetExternalApplication | 查詢外部應用資訊 | 查詢已安裝的外部應用的資訊。 |
安全設定
|
API |
標題 |
API概述 |
| SetPasswordPolicy | 設定RAM使用者密碼強度策略 | 設定RAM使用者的密碼強度策略。 |
| GetPasswordPolicy | 查詢RAM使用者密碼強度策略資訊 | 查詢RAM使用者的密碼強度策略資訊。 |
| SetSecurityPreference | 設定RAM使用者的全域安全喜好設定 | 設定RAM使用者的全域安全喜好設定資訊。 |
| GetSecurityPreference | 查詢RAM使用者全域安全喜好設定 | 調用GetSecurityPreference查詢RAM使用者的全域安全喜好設定。 |
| SetDefaultDomain | 設定預設網域名稱 | 為阿里雲帳號(主帳號)設定預設網域名稱。 |
| GetDefaultDomain | 查詢預設網域名稱 | 查詢阿里雲帳號(主帳號)下的預設網域名稱。 |
| GetCredentialReport | 查詢使用者憑證報告內容 | 查詢阿里雲帳號(主帳號)下的使用者憑證報告。 |
| GetAccountSecurityPracticeReport | 查詢阿里雲帳號的安全報告 | 擷取阿里雲帳號(主帳號)下的使用者憑證報告。 |
| GenerateCredentialReport | 產生使用者憑證報告 | 產生阿里雲帳號(主帳號)下的使用者憑證報告。 |
身分權限治理
|
API |
標題 |
API概述 |