API標準及多語言預置SDK
本產品(Ram/2015-05-01)的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使用者 | 調用CreateUser介面建立RAM使用者。 |
| GetUser | 查詢RAM使用者的詳細資料 | 調用GetUser介面查詢RAM使用者的詳細資料。 |
| UpdateUser | 更新RAM使用者的基本資料 | 調用UpdateUser介面更新RAM使用者的基本資料。 |
| DeleteUser | 刪除一個RAM使用者 | 調用DeleteUser介面刪除一個RAM使用者。 |
| ListUsers | 查詢所有RAM使用者 | 查詢所有RAM使用者的詳細資料。 |
| 登入資訊 | 登入資訊 | |
| CreateLoginProfile | 為一個RAM使用者啟用Web控制台登入 | 調用CreateLoginProfile介面為一個RAM使用者啟用Web控制台登入。 |
| GetLoginProfile | 檢視一個 RAM 使用者的登入設定。 | 呼叫 GetLoginProfile 介面檢視一個 RAM 使用者的登入設定。 |
| UpdateLoginProfile | 修改使用者的登入配置 | 調用UpdateLoginProfile介面修改使用者的登入配置。 |
| DeleteLoginProfile | 關閉RAM使用者登入Web控制台功能 | 關閉指定RAM使用者登入Web控制台的功能。 |
| ChangePassword | 修改 RAM 使用者密碼。 | RAM 使用者呼叫 ChangePassword 修改自己的主控台登入密碼。 |
| 存取金鑰 | 存取金鑰 | |
| CreateAccessKey | 為 RAM 使用者建立存取金鑰 | 呼叫 CreateAccessKey 介面為 RAM 使用者建立存取金鑰 |
| UpdateAccessKey | 更新RAM使用者存取金鑰的狀態 | 調用UpdateAccessKey介面更新RAM使用者存取金鑰的狀態。 |
| DeleteAccessKey | 刪除RAM使用者的存取金鑰 | 調用DeleteAccessKey介面刪除RAM使用者的存取金鑰。 |
| ListAccessKeys | 列出指定使用者的存取金鑰。 | 呼叫 ListAccessKeys 介面列出指定使用者的存取金鑰。 |
| GetAccessKeyLastUsed | 查詢指定存取金鑰的最後使用時間 | 調用GetAccessKeyLastUsed查詢指定存取金鑰的最後使用時間 |
| 多重要素驗證 | 多重要素驗證 | |
| CreateVirtualMFADevice | 建立多因素認證裝置 | 調用CreateVirtualMFADevice介面建立多因素認證裝置。 |
| GetUserMFAInfo | 擷取多因素認證裝置資訊 | 擷取指定RAM使用者的多因素認證裝置資訊。 |
| DeleteVirtualMFADevice | 刪除多因素認證裝置 | 調用DeleteVirtualMFADevice介面刪除多因素認證裝置。 |
| ListVirtualMFADevices | 列出多因素認證裝置 | 調用ListVirtualMFADevices介面列出多因素認證裝置。 |
| BindMFADevice | 綁定多因素認證裝置 | 調用BindMFADevice介面綁定多因素認證裝置。 |
| UnbindMFADevice | 解除綁定多因素認證裝置 | 調用UnbindMFADevice介面解除綁定多因素認證裝置。 |
使用者群組管理
|
API |
標題 |
API概述 |
| CreateGroup | 建立使用者組 | 調用CreateGroup介面建立使用者組。 |
| GetGroup | 查詢使用者群組資訊。 | 呼叫 GetGroup 介面查詢使用者群組資訊。 |
| UpdateGroup | 修改使用者組資訊 | 調用UpdateGroup介面修改使用者組資訊。 |
| DeleteGroup | 刪除指定的使用者組 | 調用DeleteGroup介面刪除指定的使用者組。 |
| ListGroups | 查詢使用者群組列表。 | 呼叫 ListGroups 介面查詢使用者群組列表。 |
| ListGroupsForUser | ListGroupsForUser | 呼叫 ListGroupsForUser 介面查詢指定 RAM 使用者所加入的使用者群組資訊。 |
| ListUsersForGroup | 列出指定使用者群組所包含的 RAM 使用者。 | 呼叫 ListUsersForGroup 介面列出指定使用者群組所包含的 RAM 使用者。 |
| AddUserToGroup | 將RAM使用者添加到指定的使用者組 | 調用AddUserToGroup介面將RAM使用者添加到指定的使用者組。 |
| RemoveUserFromGroup | 將RAM使用者從使用者組中移除 | 調用RemoveUserFromGroup介面將RAM使用者從使用者組中移除。 |
角色管理
|
API |
標題 |
API概述 |
| CreateRole | 建立角色。 | 呼叫 CreateRole 介面建立 RAM 角色。 |
| DeleteRole | 刪除角色 | 調用DeleteRole介面刪除普通RAM角色。 |
| UpdateRole | 更新角色資訊。 | 呼叫 UpdateRole 介面更新 RAM 角色資訊。 |
| GetRole | 取得角色資訊。 | 呼叫 GetRole 介面取得角色資訊。 |
| ListRoles | 取得角色清單。 | 列出角色。 |
權限管理
|
API |
標題 |
API概述 |
| 權限原則管理 | 權限原則管理 | |
| CreatePolicy | 建立一個權限原則 | 調用CreatePolicy介面建立一個自訂權限原則。 |
| GetPolicy | 取得指定的權限策略資訊。 | 呼叫 GetPolicy 介面取得指定的權限策略資訊。 |
| UpdatePolicyDescription | 更新自訂策略的描述資訊 | 調用UpdatePolicyDescription更新自訂策略的描述資訊。 |
| DeletePolicy | 刪除指定的權限原則 | 調用DeletePolicy介面刪除指定的權限原則。 |
| ListPolicies | 列出權限策略。 | 呼叫 ListPolicies 介面列出權限策略。 |
| CreatePolicyVersion | 為權限原則建立新的版本 | 調用CreatePolicyVersion介面為權限原則建立新的版本。 |
| GetPolicyVersion | 取得某個權限策略的版本。 | 呼叫 GetPolicyVersion 介面取得某個權限策略的版本。 |
| DeletePolicyVersion | 刪除指定的權限原則的某個版本 | 調用DeletePolicyVersion介面刪除指定的權限原則的某個版本。 |
| ListPolicyVersions | 列出權限策略版本。 | 呼叫 ListPolicyVersions 介面列出權限策略版本。 |
| SetDefaultPolicyVersion | 設定權限原則預設版本 | 調用SetDefaultPolicyVersion介面設定權限原則預設版本。 |
| 授權管理 | 授權管理 | |
| AttachPolicyToUser | 為指定使用者新增權限。 | 呼叫 AttachPolicyToUser 介面為指定使用者新增權限。 |
| DetachPolicyFromUser | 為使用者撤銷指定的權限。 | 呼叫 DetachPolicyFromUser 介面為使用者撤銷指定的權限。 |
| AttachPolicyToGroup | 為指定使用者群組新增權限。 | 呼叫 AttachPolicyToGroup 介面為指定使用者群組新增權限。 |
| DetachPolicyFromGroup | 為使用者群組撤銷指定的權限。 | 呼叫 DetachPolicyFromGroup 介面為使用者群組撤銷指定的權限。 |
| AttachPolicyToRole | 為指定角色新增權限。 | 呼叫 AttachPolicyToRole 介面為指定角色新增權限。 |
| DetachPolicyFromRole | 為角色撤銷指定的權限。 | 呼叫 DetachPolicyFromRole 介面為角色撤銷指定的權限。 |
| ListPoliciesForUser | 查詢RAM使用者的授權列表 | 調用ListPoliciesForUser介面查詢RAM使用者的授權列表。 |
| ListPoliciesForGroup | 列出使用者群組的權限策略。 | 呼叫 ListPoliciesForGroup 介面列出使用者群組的權限策略。 |
| ListPoliciesForRole | 列出角色的權限策略。 | 呼叫 ListPoliciesForRole 介面列出角色的權限策略。 |
| ListEntitiesForPolicy | 列出引用權限策略的實體。 | 呼叫 ListEntitiesForPolicy 介面列出引用權限策略的實體。 |
安全性設定
|
API |
標題 |
API概述 |
| SetAccountAlias | 設定雲帳號別名 | 調用SetAccountAlias介面設定雲帳號別名。 |
| GetAccountAlias | 查看雲帳號別名 | 調用GetAccountAlias介面查看雲帳號別名。 |
| ClearAccountAlias | 清除雲帳號別名 | 調用ClearAccountAlias介面清除雲帳號別名。 |
| SetPasswordPolicy | 設定RAM使用者密碼強度等策略資訊 | 調用SetPasswordPolicy介面設定RAM使用者密碼強度等策略資訊。 |
| GetPasswordPolicy | 擷取RAM使用者密碼強度等策略資訊 | 調用GetPasswordPolicy介面擷取RAM使用者密碼強度等策略資訊。 |
| SetSecurityPreference | 設定全域安全喜好設定 | 調用SetSecurityPreference介面設定全域安全喜好設定。 |
| GetSecurityPreference | 擷取全域安全喜好設定詳情 | 調用GetSecurityPreference介面擷取全域安全喜好設定詳情。 |
權限分析與診斷
|
API |
標題 |
API概述 |
| DecodeDiagnosticMessage | 解碼無許可權診斷資訊 | 從因無RAM許可權導致的請求被拒絕訪問的響應體中解碼無許可權診斷資訊。 |
標籤管理
|
API |
標題 |
API概述 |
| TagResources | 為雲資源建立並綁定標籤 | 調用TagResources為雲資源(RAM角色、權限原則)建立並綁定標籤。 |
| UntagResources | 為雲資源解除綁定標籤 | 調用UntagResources為雲資源(RAM角色、權限原則)解除綁定標籤。 |
| ListTagResources | 查詢雲資源的標籤列表 | 查詢雲資源(RAM角色、權限原則)綁定的標籤列表。 |
其他
|
API |
標題 |
API概述 |
| GetServiceLinkedRoleTemplate | 取得服務連結角色範本。 | 呼叫 GetServiceLinkedRoleTemplate 取得服務連結角色範本。 |