查詢服務開通狀態和服務角色資訊。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ros:GetServiceProvisions |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
地區 ID。 您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| TemplateBody |
string |
否 |
模板主體的結構。長度為 1~524,288 個位元組。如果長度較長,則建議通過 HTTP POST+Body Param 的方式,將參數放在請求體中進行傳遞,避免因 URL 過長而導致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 TemplateScratchId 其中一個參數。 |
ROSTemplateFormatVersion: '2015-09-01'\r\nResources:\r\n Vpc:\r\n Type: ALIYUN::ECS::VPC\r\n Properties:\r\n CidrBlock: 192.168.0.0/24\r\n VpcName: TestVpc |
| TemplateURL |
string |
否 |
包含模板主體的檔案的位置。URL 必須指向位於 HTTP Web 服務器(HTTP 或 HTTPS)或阿里雲 OSS 儲存空間中的模板(1~524,288 個位元組)。OSS 儲存空間的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地區,預設與介面參數 RegionId 相同。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一個參數。 |
oss://ros-template/demo |
| TemplateId |
string |
否 |
模板 ID。支援共用模板和私人模板。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一個參數。 |
5ecd1e10-b0e9-4389-a565-e4c15efc**** |
| TemplateVersion |
string |
否 |
模板版本。如果不指定,預設取最新版本。 TemplateVersion 僅在指定 TemplateId 時生效。 |
v1 |
| Parameters |
array<object> |
否 |
參數。 |
|
|
object |
否 |
|||
| ParameterKey |
string |
是 |
參數的名稱。如果未指定參數的名稱和值,則 ROS 將使用模板中指定的預設值。 說明
Parameters 為選擇性參數。若指定了 Parameters,則 ParameterKey 為必選參數。 |
Amount |
| ParameterValue |
string |
是 |
參數的值。 說明
Parameters 為選擇性參數。若指定了 Parameters,則 ParameterValue 為必選參數。 |
12 |
| Services |
array<object> |
否 |
雲端服務列表。 |
|
|
object |
否 |
|||
| ServiceName |
string |
是 |
雲端服務名稱。取值:
|
EHPC |
關於公用請求參數的詳情,請參見公用參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
A9938C04-26AD-5EFA-B394-EA7866842DFF |
| ServiceProvisions |
array<object> |
雲端服務詳情。 |
|
|
array<object> |
|||
| ServiceName |
string |
雲端服務名稱。 |
EHPC |
| Status |
string |
雲端服務開通狀態。取值:
|
Enabled |
| StatusReason |
string |
雲端服務未開通或開通狀態未知的原因。 說明
當 Status 取值為 Disabled 或 Unknown 時,返回該參數。 |
No permission. |
| AutoEnableService |
boolean |
是否在模板中定義了自動開通服務。取值:
|
false |
| EnableURL |
string |
雲端服務開通連結。 說明
當 Status 取值為 Disabled 時,返回該參數。 |
https://common-buy-intl.alibabacloud.com/?commodityCode=nas |
| RoleProvision |
object |
雲端服務角色資訊。若為空白表示沒有服務角色。 |
|
| AuthorizationURL |
string |
角色授權連結。 說明
當 Created 取值為 false 時,返回該參數。 |
https://ehpc.console.alibabacloud.com/ |
| Roles |
array<object> |
雲端服務角色列表。 |
|
|
array<object> |
|||
| RoleName |
string |
角色名稱。 |
AliyunServiceRoleForEHPC |
| Created |
boolean |
角色是否已建立。取值:
|
true |
| Function |
string |
角色用途。 預設值:Default,表示該角色為服務預設角色。 |
Default |
| ApiForCreation |
object |
建立角色用到的 API 資訊。 |
|
| ApiProductId |
string |
API 所屬產品識別碼。 |
rds |
| ApiName |
string |
API 名稱。 |
CreateServiceLinkedRole |
| ApiType |
string |
API 類型。 取值:
|
Open |
| Parameters |
object |
API 參數資訊。${變數名}表示動態參數,目前支援:${RegionId} 地區。 |
{ "ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs", "RegionId": "${RegionId}" } |
| DependentServiceNames |
array |
待查詢服務依賴的服務列表。 |
|
|
string |
待查詢服務依賴的服務名稱。 |
NAS |
|
| CommodityProvisions |
array<object> |
商品詳情。部分服務(如 ACS)會涉及多個商品的開通。 |
|
|
object |
|||
| CommodityCode |
string |
商品碼。 |
acs_postpaid_public_cn |
| Status |
string |
雲端服務開通狀態。取值:
|
Disabled |
| EnableURL |
string |
商品開通連結。 |
https://common-buy-intl.alibabacloud.com/?commodityCode=acs_postpaid_public_cn |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A9938C04-26AD-5EFA-B394-EA7866842DFF",
"ServiceProvisions": [
{
"ServiceName": "EHPC",
"Status": "Enabled",
"StatusReason": "No permission.",
"AutoEnableService": false,
"EnableURL": "https://common-buy-intl.alibabacloud.com/?commodityCode=nas",
"RoleProvision": {
"AuthorizationURL": "https://ehpc.console.alibabacloud.com/",
"Roles": [
{
"RoleName": "AliyunServiceRoleForEHPC",
"Created": true,
"Function": "Default",
"ApiForCreation": {
"ApiProductId": "rds",
"ApiName": "CreateServiceLinkedRole",
"ApiType": "Open",
"Parameters": {
"ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs",
"RegionId": "${RegionId}"
}
}
}
]
},
"DependentServiceNames": [
"NAS"
],
"CommodityProvisions": [
{
"CommodityCode": "acs_postpaid_public_cn",
"Status": "Disabled",
"EnableURL": "https://common-buy-intl.alibabacloud.com/?commodityCode=acs_postpaid_public_cn"
}
]
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。