查詢服務(wù)開通狀態(tài)和服務(wù)角色信息。
接口說明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個(gè)操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
ros:GetServiceProvisions | list |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 您可以調(diào)用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateBody | string | 否 | 模板主體的結(jié)構(gòu)。長度為 1~524,288 個(gè)字節(jié)。如果長度較長,則建議通過 HTTP POST+Body Param 的方式,將參數(shù)放在請求體中進(jìn)行傳遞,避免因 URL 過長而導(dǎo)致請求失敗。 說明
您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 TemplateScratchId 其中一個(gè)參數(shù)。
| 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 服務(wù)器(HTTP 或 HTTPS)或阿里云 OSS 存儲空間中的模板(1~524,288 個(gè)字節(jié))。OSS 存儲空間的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域,默認(rèn)與接口參數(shù) RegionId 相同。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一個(gè)參數(shù)。 | oss://ros-template/demo |
TemplateId | string | 否 | 模板 ID。支持共享模板和私有模板。 您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 或 Services 其中一個(gè)參數(shù)。 | 5ecd1e10-b0e9-4389-a565-e4c15efc**** |
TemplateVersion | string | 否 | 模板版本。如果不指定,默認(rèn)取最新版本。 TemplateVersion 僅在指定 TemplateId 時(shí)生效。 | v1 |
Parameters | array<object> | 否 | 參數(shù)。 | |
object | 否 | |||
ParameterKey | string | 是 | 參數(shù)的名稱。如果未指定參數(shù)的名稱和值,則 ROS 將使用模板中指定的默認(rèn)值。 說明
Parameters 為可選參數(shù)。若指定了 Parameters,則 ParameterKey 為必選參數(shù)。
| Amount |
ParameterValue | string | 是 | 參數(shù)的值。 說明
Parameters 為可選參數(shù)。若指定了 Parameters,則 ParameterValue 為必選參數(shù)。
| 12 |
Services | array<object> | 否 | 云服務(wù)列表。 | |
object | 否 | |||
ServiceName | string | 是 | 云服務(wù)名稱。取值:
| EHPC |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "A9938C04-26AD-5EFA-B394-EA7866842DFF",
"ServiceProvisions": [
{
"ServiceName": "EHPC",
"Status": "Enabled",
"StatusReason": "No permission.",
"AutoEnableService": false,
"EnableURL": "https://common-buy.aliyun.com/?commodityCode=nas",
"RoleProvision": {
"AuthorizationURL": "https://ehpc.console.aliyun.com/",
"Roles": [
{
"RoleName": "AliyunServiceRoleForEHPC",
"Created": true,
"Function": "Default",
"ApiForCreation": {
"ApiProductId": "rds",
"ApiName": "CreateServiceLinkedRole",
"ApiType": "Open",
"Parameters": {
"ServiceLinkedRole": "AliyunServiceRoleForRdsPgsqlOnEcs",
"RegionId": "${RegionId}"
}
}
}
]
},
"DependentServiceNames": [
"NAS"
]
}
]
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-01-12 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |
2022-10-28 | OpenAPI 描述信息更新、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2021-11-12 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |