查询服务开通状态和服务角色信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ros:GetServiceProvisions | List |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。 您可以调用DescribeRegions查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateBody | string | 否 | 模板主体的结构。长度为1~524,288个字节。如果长度较大,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免因URL过长而导致请求失败。 您必须且仅能指定TemplateBody、TemplateURL、TemplateId或Services其中一个参数。 | {"ROSTemplateFormatVersion": "2015-09-01","Resources": {"ApiGateway": {"Type": "ALIYUN::ApiGateway::Group","Properties": { "GroupName": "ros_example" }},"FC": {"Type": "ALIYUN::FC::Service","Properties": {"ServiceName": "ros_example"}}}} |
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 | object [] | 否 | 参数。 | |
ParameterKey | string | 是 | 参数的名称。如果未指定参数的名称和值,则ROS将使用模板中指定的默认值。 说明
Parameters为可选参数。若指定了Parameters,则ParameterKey为必选参数。
| Amount |
ParameterValue | string | 是 | 参数的值。 说明
Parameters为可选参数。若指定了Parameters,则ParameterValue为必选参数。
| 12 |
Services | object [] | 否 | 云服务列表。 | |
ServiceName | string | 是 | 云服务名称。取值:
| EHPC |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
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"
]
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2022-10-28 | OpenAPI 描述信息更新,OpenAPI 返回结构发生变更 | 看变更集 | ||||
| ||||||
2021-11-12 | OpenAPI 返回结构发生变更 | 看变更集 | ||||
|