新增多雲資產配置資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-sas:AddCloudVendorAccountAK |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Vendor |
string |
是 |
雲資產廠商。取值:
|
AWS |
| AkType |
string |
是 |
AK 類型。取值:
|
primary |
| SecretId |
string |
是 |
AK 參數 Id。取值: 1.AkType 取值 primary:
2.AkType 取值 sub:
說明
AkType 取值為 primary 則該值為他雲的主帳號 SecretID。AkType 取值為 sub 則該值為他雲子帳號 Access Key ID。Azure 不做區分,該值為認證資訊的 appId。Google雲是通過服務帳號接入的,AkType 預設取值 sub, 該值取自 JSON 格式服務密鑰檔案的 private_key_id 屬性值。 |
45GLRV4SOT0YFB**** |
| SecretKey |
string |
是 |
AK 參數 Secret。取值: 1.AkType 取值 primary:
2.AkType 取值 sub:
說明
AkType 取值為 primary 則該值為他雲的主帳號 Secret Access Key。AkType 取值為 sub 則該值為他雲子帳號 Secret Access Key。Azure 不做區分,該值為認證資訊的 password。Google雲是通過服務帳號接入的,AkType 預設取值 sub, 該值取自 JSON 格式服務密鑰檔案的 private_key 屬性值。 |
AE6SLd**** |
| Regions |
array |
否 |
AK 資訊驗證所使用的 Region 列表,僅對 Vendor 為 AWS 有效。 說明
調用 ListCloudVendorRegions 介面可以擷取該參數。 |
|
|
string |
否 |
AK 資訊驗證所使用的 Region。 |
ap-south-1 |
|
| SubscriptionIds |
array |
否 |
訂閱 ID 列表。 說明
該參數已無效。 |
|
|
string |
否 |
訂閱 ID。 說明
該參數已無效。 |
9b41e7ae-fcbf-4983-aa32-6fb2e***** |
|
| TenantId |
string |
否 |
租戶 ID,僅對 Vendor 為 Azure 有效。 |
95304a97-339b-4de5-9a7d-cdbffaf**** |
| Domain |
string |
否 |
接入帳號域。取值:
說明
該參數僅對 Vendor 為 HUAWEICLOUD、Azure、AWS、VOLCENGINE 有效,且為必傳。 |
global |
| AuthModules |
array |
否 |
AK 關聯模組列表。 |
|
|
string |
否 |
AK 關聯模組 Code。取值:
|
HOST |
|
| Lang |
string |
否 |
請求和接收訊息的語言類型。預設值為 zh。取值:
|
zh |
| VendorAuthAlias |
string |
否 |
AK 帳號名稱。 說明
用於標識三方主機資產的所屬帳號資訊。 |
test |
| ExtendInfo |
string |
否 |
擴充資訊。 說明
用於記錄不同廠商擴充資訊。 Google雲是通過服務帳號接入的,ExtendInfo 儲存的是 json 格式服務密鑰檔案,排除了 private_key_id 和 zprivate_key 欄位。檔案中包含欄位:type,project_id,client_email,client_id,auth_uri,token_uri,auth_provider_x509_cert_url,client_x509_cert_url,universe_domain。 |
{\"product\":\"webFirewall\",\"remark\":\"remark\"} |
| CtdrCloudUserId |
string |
否 |
帳號 ID。 說明
接入的雲廠商的帳號 ID,當許可權說明包含威脅分析與響應時必填。 |
azure_demo_1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
本次請求的 ID。 |
A60DA4EC-7CD8-577D-AD73-*** |
| Data |
object |
當前添加 AK 資訊。 |
|
| Status |
integer |
AK 狀態。取值:
|
0 |
| AuthId |
integer |
AK 唯一 ID。 |
2158 |
| AkType |
string |
AK 類型。取值:
|
sub |
| SecretId |
string |
AK 參數 ID。 |
AE6SLd**** |
| ServiceStatus |
integer |
AK 使用狀態。取值:
|
0 |
| Vendor |
string |
雲資產廠商。取值:
|
Tencent |
| Message |
string |
AK 異常資訊。 |
The IAM user is forbidden in the currently selected region |
| AuthModules |
array<object> |
AK 關聯模組列表。 |
|
|
object |
|||
| ModuleDisp |
string |
模組顯示名稱。 |
Host Assets |
| ModuleStatement |
string |
模組關聯許可權說明。 |
Read permission of the cloud server or virtual machine |
| Module |
string |
模組 Code。取值:
|
HOST |
| ModuleAssetType |
string |
模組關聯雲資產說明。 |
Cloud server or virtual machine |
| ModuleServiceStatus |
integer |
模組狀態。取值:
|
0 |
| Message |
string |
模組異常資訊。 |
ak_domain_error |
| VendorAuthAlias |
string |
AK 帳號名稱。 說明
用於標識三方主機資產的所屬帳號資訊。 |
test |
| CtdrCloudUserId |
string |
帳號 ID。 說明
接入的雲廠商的帳號 ID。 |
azure_demo_1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A60DA4EC-7CD8-577D-AD73-***",
"Data": {
"Status": 0,
"AuthId": 2158,
"AkType": "sub",
"SecretId": "AE6SLd****",
"ServiceStatus": 0,
"Vendor": "Tencent",
"Message": "The IAM user is forbidden in the currently selected region",
"AuthModules": [
{
"ModuleDisp": "Host Assets",
"ModuleStatement": "Read permission of the cloud server or virtual machine",
"Module": "HOST",
"ModuleAssetType": "Cloud server or virtual machine",
"ModuleServiceStatus": 0,
"Message": "ak_domain_error"
}
],
"VendorAuthAlias": "test",
"CtdrCloudUserId": "azure_demo_1"
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | CreateAkError | Failed to create an AK. | 建立AK錯誤。 |
| 500 | ServerError | ServerError | 服務故障,請稍後重試! |
| 403 | NoPermission | caller has no permission | 當前操作未被授權,請聯絡主帳號在RAM控制台進行授權後再執行操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。